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

List a Surface registration's delivery conditions

Return a bounded page of operator-visible delivery refusals in stable first-observed order, continuing from an opaque cursor when supplied.

Authentication

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

Parameters

NameLocationRequiredDescription
organizationIdpathYes
The Organization to address.
stringA Cantora Organization identifier, prefixed with `org_`.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdpathYes
The Project to address.
stringA Cantora Project identifier, prefixed with `proj_`.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
environmentIdpathYes
The Environment to address.
stringA Cantora Environment identifier, prefixed with `env_`.
  • maximum length 64
  • pattern ^env_[\s\S]+$
surfaceRegistrationIdpathYes
The Environment Surface registration to address.
stringA Cantora Surface registration identifier, prefixed with `surface_`.
  • maximum length 64
  • pattern ^surface_[\s\S]+$
cursorqueryNo
The opaque continuation token returned by the preceding page.
string
  • maximum length 2048
  • minimum length 1
  • pattern ^[A-Za-z0-9_-]+$
limitqueryNo
The maximum number of resources to return, from 1 through 100.
string
  • pattern ^[+-]?\d*\.?\d+(?:[Ee][+-]?\d+)?$

Responses

200SurfaceRegistrationConditionPage
application/json
SurfaceRegistrationConditionPageEncoded
400The request path, headers, query, or JSON body did not satisfy the published schema
401Unauthorized
application/json
UnauthorizedEncoded
403Forbidden
application/json
ForbiddenEncoded
404NotFound
application/json
NotFoundEncoded

Reusable schemas

SurfaceRegistrationConditionPageEncoded

object
  • unknown properties allowed false
itemsrequired
arrayThe resources in this page, in stable order.
Items
SurfaceRegistrationConditionEncoded
nextCursorrequired
The opaque continuation token for the next page, or null after the final page.
Any of
string
  • maximum length 2048
  • minimum length 1
  • pattern ^[A-Za-z0-9_-]+$
null

UnauthorizedEncoded

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.

ForbiddenEncoded

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

NotFoundEncoded

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.

SurfaceRegistrationConditionEncoded

object
  • unknown properties allowed false
coderequired
stringThe stable machine-readable condition code.
  • allowed values "mixedTenantConversation"
providerIssuerrequired
stringThe provider account or workspace boundary.
  • maximum length 512
  • minimum length 1
  • pattern ^[!-~]+$
providerConversationKeyrequired
stringThe provider's stable conversation address within its issuer.
  • maximum length 512
  • minimum length 1
  • pattern ^[!-~]+$
existingTenantIdrequired
stringThe Tenant that already owns the provider conversation.
  • maximum length 64
  • pattern ^tenant_[\s\S]+$
attemptedTenantIdrequired
stringThe Tenant that attempted to claim the provider conversation.
  • maximum length 64
  • pattern ^tenant_[\s\S]+$
occurrenceCountrequired
integerHow many times the condition has been observed.
  • greater than 0
firstObservedAtrequired
stringWhen the condition was first observed, in UTC.
  • format date-time
lastObservedAtrequired
stringWhen the condition was most recently observed, in UTC.
  • format date-time