Xeonr Developer Docs
UplApiUploads

Set upload metadata entry

POST
/uplim.api.v1.BucketUploadsService/SetUploadMetadata

Upserts a metadata entry on an upload. Key must resolve to a known registration (common:* or the caller's integration slug).

Authorization

OAuth2 upl:uploads:manage
AuthorizationBearer <token>

OAuth 2.0 authorization

In: header

Scope: upl:uploads:manage

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

bucketRef?|

Reference to a bucket by ID or hostname

uploadRef?|

Reference to an upload by ID or path

entry?

A single key/value entry on an upload. key is the fully-namespaced public identifier — either common:<local> for built-in keys or <integration.slug>:<local> for integration-registered keys.

The title, icon_name, and hidden_from_users fields are populated by the server on read responses (ListUploadMetadata, ListPublicUploadMetadata) from the key's registration so renderers don't need a second lookup. They are ignored on writes.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.BucketUploadsService/SetUploadMetadata" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "entry": {
    "key": "string",
    "valueType": "METADATA_VALUE_TYPE_UNSPECIFIED",
    "value": {
      "arrayValue": {
        "values": [
          {}
        ]
      }
    },
    "title": "string",
    "iconName": "string",
    "hiddenFromUsers": true
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}