Xeonr Developer Docs
UplApiIntegrations

Install the calling integration on a bucket

POST
/uplim.api.v1.IntegrationsService/SelfInstallIntegrationOnBucket

Lets an integration with a user-delegated bearer install itself on a bucket the user administers. Rejects bare API-key / client-credentials callers (no user identity). Rejects buckets where the integration was previously uninstalled (bucket admin must reinstall manually via the bucket settings UI).

Authorization

OAuth2 upl:bucket:manage
AuthorizationBearer <token>

OAuth 2.0 authorization

In: header

Scope: upl:bucket: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?|

integration_id is inferred from the caller's token; no body field needed.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.IntegrationsService/SelfInstallIntegrationOnBucket" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "installation": {
    "integration": {
      "integrationId": "string",
      "oauthClientId": "string",
      "oauthApplicationId": "6e68418e-eaad-4fd1-af9d-e9521eee4cbc",
      "name": "string",
      "apiKeyEnabled": true,
      "scoping": "string",
      "contentTypes": [
        {
          "id": "string",
          "integrationId": "string",
          "criteria": {
            "kinds": [
              "CONTENT_TARGET_KIND_UNSPECIFIED"
            ]
          },
          "renderer": {
            "enabled": true,
            "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
            "entryPath": "string"
          },
          "openWith": {
            "enabled": true,
            "callbackUrl": "http://example.com"
          },
          "priority": 0,
          "createdAt": "2023-01-15T01:30:15.01Z",
          "updatedAt": "2023-01-15T01:30:15.01Z",
          "name": "string",
          "displayLabel": "string",
          "iconName": "string",
          "matcher": "string",
          "matcherPriority": 0,
          "iconUploadId": "string",
          "worker": {
            "enabled": true,
            "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
            "entryPath": "string"
          }
        }
      ],
      "defaultBucketTypeId": "9b1c8916-4239-4e84-b4d2-0740320b30d9",
      "newFiles": [
        {
          "id": "string",
          "integrationId": "string",
          "name": "string",
          "extension": "string",
          "creationType": "NEW_FILE_CREATION_TYPE_UNSPECIFIED",
          "defaultContent": {
            "multiple": {
              "files": {
                "property1": {
                  "stringContent": "string"
                },
                "property2": {
                  "stringContent": "string"
                }
              }
            }
          },
          "contentTypeId": "string",
          "createdAt": "2023-01-15T01:30:15.01Z",
          "updatedAt": "2023-01-15T01:30:15.01Z"
        }
      ],
      "metadataKeys": [
        {
          "id": "string",
          "integrationId": "string",
          "key": "string",
          "title": "string",
          "iconName": "string",
          "valueType": "METADATA_VALUE_TYPE_UNSPECIFIED",
          "hiddenFromUsers": true,
          "createdAt": "2023-01-15T01:30:15.01Z",
          "updatedAt": "2023-01-15T01:30:15.01Z"
        }
      ],
      "folderBehavior": "INTEGRATION_FOLDER_BEHAVIOR_UNSPECIFIED",
      "folderLinkUrl": "http://example.com",
      "mode": "INTEGRATION_MODE_UNSPECIFIED",
      "bucketLauncherEnabled": true,
      "slug": "string",
      "isSystem": true,
      "systemManagedClient": true,
      "discoverable": true,
      "createdAt": "2023-01-15T01:30:15.01Z",
      "updatedAt": "2023-01-15T01:30:15.01Z"
    },
    "status": "string",
    "installedAt": "2023-01-15T01:30:15.01Z",
    "uninstalledAt": "2023-01-15T01:30:15.01Z",
    "installedBySubjectKey": "string"
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}