Skip to content
CantoraAPI documentation
POST
/v1/organizations/{organizationId}/integration-environment-bindings

Create an Integration Environment Binding

Delegate an Organization-owned Integration Application to one stable logical name in an Environment.

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]+$

Request body

Required.

application/json
object
  • unknown properties allowed false
projectIdrequired
stringThe Project containing the target Environment.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
environmentIdrequired
stringThe Environment receiving this Organization-authorized delegation.
  • maximum length 64
  • pattern ^env_[\s\S]+$
logicalNamerequired
stringThe stable name Agent Versions use to request the binding.
  • maximum length 100
  • minimum length 1
  • pattern ^[a-z][a-z0-9_]*$
integrationIdrequired
stringThe Integration selected by this binding.
  • maximum length 64
  • pattern ^integration_[\s\S]+$
dataIntegrationApplicationIdrequired
stringThe Organization-owned application selected by this binding.
  • maximum length 64
  • pattern ^data_integration_app_[\s\S]+$

Responses

201IntegrationEnvironmentBindingCreated
application/json
IntegrationEnvironmentBindingCreatedEncoded
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
409Conflict
application/json
ConflictEncoded

Reusable schemas

IntegrationEnvironmentBindingCreatedEncoded

object
  • unknown properties allowed false
integrationEnvironmentBindingIdrequired
stringThe stable Integration Environment Binding identifier.
  • maximum length 64
  • pattern ^integration_binding_[\s\S]+$
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdrequired
stringThe Project identifier.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
environmentIdrequired
stringThe Environment identifier.
  • maximum length 64
  • pattern ^env_[\s\S]+$
logicalNamerequired
stringThe stable logical name Agents use for this Environment binding.
  • maximum length 100
  • minimum length 1
  • pattern ^[a-z][a-z0-9_]*$
integrationIdrequired
stringThe stable Organization-scoped Integration identifier.
  • maximum length 64
  • pattern ^integration_[\s\S]+$
dataIntegrationApplicationIdrequired
stringThe Organization-owned data Integration Application identifier.
  • maximum length 64
  • pattern ^data_integration_app_[\s\S]+$
statusrequired
DataIntegrationStatusThe current lifecycle status.
generationrequired
integerThe monotonically increasing Agent Release generation.
  • greater than 0
etagrequired
stringThe strong ETag required for the next conditional mutation.
  • maximum length 12
  • pattern ^"(?:[1-9][0-9]{0,9})"$
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time
updatedAtrequired
stringWhen the resource was last updated, in UTC.
  • format date-time

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.

ConflictEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Conflict"
resourcerequired
stringThe resource type relevant to the error.
reasonrequired
stringA safe explanation of the state conflict.

DataIntegrationStatus

string
  • allowed values "active", "disabled"