Connector API

Lists visible Connectors with standard pagination.

Returns Connector configuration, delegated scope, and observed connection state.

Requires connectors:read. Results include local installation identity, linked hosted organization, allowed regions and classes, connection state, last observation, and revision.

The connection response identifies the hosted grant and observed state:

{
  "data": {
    "id": "con_hosted",
    "revision": 3,
    "hosted_organization_id": "horg_capacity",
    "allowed_region_ids": ["hreg_euwest"],
    "state": "connected",
    "observed_at": "2026-03-22T12:00:00Z"
  }
}

Reads never return Connector bearer material. A current local connection does not imply every hosted region has available capacity.

Creates an authorization request for hosted administrator review.

Requires connectors:write and returns an authorization URL, request ID, and expiry. A hosted administrator must complete the exchange and approve its requested scope.

An incomplete request grants no hosted authority. The local caller cannot manufacture a grant by posting arbitrary hosted organization IDs. Expired requests must be replaced through a new authorization flow.

Refreshes inventory permitted by the Connector grant.

Returns 202 with an inventory operation. It fetches permitted region, image, size, and storage-class metadata. It does not create a new private network path between local and hosted resources.

A disconnected or revoked grant leaves the operation failed or reconciling with its hosted reference. Existing hosted resources can remain running and billed.

Rotates delegated authorization under the hosted grant.

Requires the current ETag and hosted approval where required by the grant. The operation reports requested and active authorization revisions without revealing the credential.

A local scope edit can narrow region access within the hosted grant. Expanding beyond that grant returns 403 hosted_scope_required and requires a new approval.

Deletes a Connector after its managed dependencies are resolved.

Requires If-Match. Managed hosted resources and unresolved operations return 409 connector_in_use with their references. Decommission or explicitly transfer that management boundary before removal.

Connector deletion is not hosted resource deletion. Verify retained addresses, volumes, and backups through the hosted inventory before concluding that usage has ended. See Connector delegation and operation recovery.