Adapters
Operations of the Connector Gateway API. Paths are relative to your deployment's API host.
GET /api/connector-gateway-api/adapters/providers
List every ConnectorAdapterModule currently registered. The Integrations settings page and the install-wizard provider picker bind to this so the platform never hardcodes a provider list.
Authentication: bearer token (Authorization: Bearer <token>)
| Status | Description | Body |
|---|---|---|
| 200 | application/json ProviderSummaryDtoDataArrayEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/connector-gateway-api/adapters/{provider}/actions/{action}
Invoke a provider-side outbound action (post a comment, create an issue, send a message). Service callers only — workflow activities reach here via the generated Orval client.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
action | path | string | yes | |
provider | path | string | yes |
Request body: application/json InvokeActionRequestDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json InvokeActionResponseDtoDataEnvelope | |
| 400 | The request or the provider refused the parameters. | application/problem+json ConnectorActionProblemDto |
| 401 | The caller token, or the provider, refused the credential. | application/problem+json ConnectorActionProblemDto |
| 403 | The caller, or the provider, is not allowed. | application/problem+json ConnectorActionProblemDto |
| 404 | Unknown provider, connection or action, or the provider resource is absent. | application/problem+json ConnectorActionProblemDto |
| 409 | Conflict. IDEMPOTENCY_KEY_IN_FLIGHT: a request with this idempotency key is still running; retry after deadline. CONNECTION_AMBIGUOUS / CONNECTION_DEFAULT_NOT_ACTIVE: the connection cannot be resolved (see ConnectionResolutionErrorCode). IDEMPOTENCY_OUTCOME_UNKNOWN: the request passed its deadline without recording an outcome, so the provider may or may not have acted. It is never re-dispatched for this key; a new attempt needs a new key. If the original call later gets a definitive provider answer, replays return that outcome from then on. | application/problem+json ConnectorActionProblemDto |
| 422 | The idempotency key was already used for a different request (IDEMPOTENCY_KEY_REUSED). | application/problem+json ConnectorActionProblemDto |
| 429 | The provider rate-limited the action. | application/problem+json ConnectorActionProblemDto |
| 500 | Internal error. | application/problem+json ConnectorActionProblemDto |
| 502 | The provider failed with an internal error. | application/problem+json ConnectorActionProblemDto |
| 503 | The provider is unavailable. | application/problem+json ConnectorActionProblemDto |
GET /api/connector-gateway-api/adapters/{provider}/resources/{type}
List provider-side resources of a given type. Used by the install wizard's resource pickers; the registry mints credentials internally and pages the adapter's ResourceLister.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
provider | path | string | yes | |
type | path | string | yes | |
cursor | query | string | no | Continuation token from the previous page. |
pageSize | query | number | no | |
parentResourceId | query | string | no | Id of the parent resource. Sent together with parentResourceType. |
parentResourceType | query | string | no | Type of the parent resource to list under (e.g. list branches of a repository). Sent together with parentResourceId. |
query | query | string | no | Free-text search string. |
| Status | Description | Body |
|---|---|---|
| 200 | application/json ListResourcesResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | No connection resolves for the provider (CONNECTION_UNRESOLVED), or the provider exposes no such resource type (RESOURCE_TYPE_UNKNOWN). | application/problem+json ListResourcesNotFoundProblemDto |
| 409 | Conflict. CONNECTION_AMBIGUOUS: an owner holds several connections for the provider and named no default. CONNECTION_DEFAULT_NOT_ACTIVE: the default pointer names a connection that is not ACTIVE; re-point the default or re-activate the connection. Other 409s of the route carry their own code. | application/problem+json ConnectionResolutionProblemDto |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |