v2

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-1754198241.7 KB
ConnectorResources

List resources attached to a connector

Lists resource descriptors attached to a connector instance for source and destination use. The attached resource adds connector-local access details such as external resource name, endpoint id, and access protocol; the descriptor remains the reusable logical data shape.

get/connectors/{connectorInstanceId}/resources

Path parameters

connectorInstanceIdstring uuid required

Stable platform identifier for a configured connector instance.

Example:3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5

Stable identifier of the configured connector instance. This is not the Party id; the connector instance has its own id and points at its backing Party.

Query parameters

role'SOURCE' | 'DESTINATION'

How a connector participates in data movement. Use SOURCE for reads and DESTINATION for writes. Connectors that support both roles declare both values in supportedRoles.

Example:SOURCE

Filters connectors or attached resources by data-flow role.

resourceKind'OBJECT' | 'TABULAR' | 'DOCUMENT' | 'CLAIM_SET' | 'GRAPH' | 'EVENT_STREAM' | 'FILE' | 'SECRET' | 'CONFIGURATION' | 'CREDENTIAL' | 'PRESENTATION' | 'CUSTOM'

Logical kind of resource being accessed, independent of transport and serialization. For example, a CSV file with rows is ResourceKind TABULAR and RepresentationKind CSV.

Example:TABULAR

Filters by logical resource kind. This does not imply a transport or serialization format.

pageinteger

Zero-based page index.

sizeinteger

Page size.

Response

Paged resources attached to the connector.

Example response

{
  "data": [
    {
      "connectorResourceId": "b4cf21b1-0292-4803-8d32-9ebf9f5359a2",
      "connectorInstanceId": "3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5",
      "resourceDescriptorId": "41436f49-040c-4f5f-9c7f-657f43762e2b",
      "role": "SOURCE",
      "externalResourceName": "/employees/{employee_id}",
      "accessProtocol": "HTTPS"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "page": 0,
    "size": 20,
    "total": 1,
    "totalPages": 1,
    "hasMore": false
  }
}