Skip to content
CantoraAPI documentation
GET
/v1/organizations/{organizationId}/projects/{projectId}/environments/{environmentId}/surface-registrations/{surfaceRegistrationId}/tenants/{tenantId}/connections/{connectionId}

Read safe Connection metadata

Return Connection scope, provider identity, status, and credential generation without returning its bot credential.

Authentication

Send an API key as a Bearer token in the Authorization header.

Parameters

NameLocationRequiredDescription
organizationIdpathYes
The Organization to address.
string
All of
  • maximum length 64
A Cantora Organization identifier, prefixed with `org_`.
  • pattern ^org_[\s\S]+$
projectIdpathYes
The Project to address.
string
All of
  • maximum length 64
A Cantora Project identifier, prefixed with `proj_`.
  • pattern ^proj_[\s\S]+$
environmentIdpathYes
The Environment to address.
string
All of
  • maximum length 64
A Cantora Environment identifier, prefixed with `env_`.
  • pattern ^env_[\s\S]+$
surfaceRegistrationIdpathYes
The Environment Surface registration to address.
string
All of
  • maximum length 64
A Cantora Surface registration identifier, prefixed with `surface_`.
  • pattern ^surface_[\s\S]+$
tenantIdpathYes
The Tenant to address.
string
All of
  • maximum length 64
A Cantora Tenant identifier, prefixed with `tenant_`.
  • pattern ^tenant_[\s\S]+$
connectionIdpathYes
The installed provider Connection to address.
string
All of
  • maximum length 64
A Cantora Connection identifier, prefixed with `connection_`.
  • pattern ^connection_[\s\S]+$

Responses

200Connection
application/json
ConnectionJsonEncoding
400The request path, headers, query, or JSON body did not satisfy the published schema
401Unauthorized
application/json
UnauthorizedJsonEncoding
403Forbidden
application/json
ForbiddenJsonEncoding
404NotFound
application/json
NotFoundJsonEncoding

Reusable schemas

ConnectionJsonEncoding

object
  • unknown properties allowed false
connectionIdrequired
stringThe installed provider Connection identifier.
All of
  • maximum length 64
A Cantora Connection identifier, prefixed with `connection_`.
  • pattern ^connection_[\s\S]+$
organizationIdrequired
stringThe Organization identifier.
All of
  • maximum length 64
A Cantora Organization identifier, prefixed with `org_`.
  • pattern ^org_[\s\S]+$
projectIdrequired
stringThe Project identifier.
All of
  • maximum length 64
A Cantora Project identifier, prefixed with `proj_`.
  • pattern ^proj_[\s\S]+$
environmentIdrequired
stringThe Environment identifier.
All of
  • maximum length 64
A Cantora Environment identifier, prefixed with `env_`.
  • pattern ^env_[\s\S]+$
tenantIdrequired
stringThe Tenant identifier.
All of
  • maximum length 64
A Cantora Tenant identifier, prefixed with `tenant_`.
  • pattern ^tenant_[\s\S]+$
surfaceRegistrationIdrequired
stringThe Environment Surface registration identifier.
All of
  • maximum length 64
A Cantora Surface registration identifier, prefixed with `surface_`.
  • pattern ^surface_[\s\S]+$
providerrequired
stringThe model or Surface provider key.
  • allowed values "slack"
providerIssuerrequired
stringThe provider account or workspace boundary.
All of
  • minimum length 1
  • maximum length 512
  • pattern ^[!-~]+$
credentialGenerationrequired
integerThe current credential generation, incremented on rotation.
All of
  • greater than 0
statusrequired
stringThe current lifecycle status.
  • allowed values "active", "disabled", "reauthorizationRequired"
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time

UnauthorizedJsonEncoding

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Unauthorized"
reasonrequired
stringA safe explanation of why the credential was rejected.

ForbiddenJsonEncoding

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Forbidden"
permissionrequired
stringThe permission required by the refused operation.

NotFoundJsonEncoding

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "NotFound"
resourcerequired
stringThe resource type relevant to the error.
idrequired
stringThe identifier supplied for the resource that was not found.