Skip to content
CantoraAPI documentation
PUT
/v1/organizations/{organizationId}/integrations/{integrationId}

Update Integration metadata or lifecycle

Conditionally replace the mutable metadata of one stable Integration.

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]+$
integrationIdpathYes
The stable Integration lineage to address.
stringA Cantora Integration identifier, prefixed with `integration_`.
  • maximum length 64
  • pattern ^integration_[\s\S]+$
if-matchheaderYes
The current strong resource ETag, including its double quotes.
string
  • maximum length 12
  • pattern ^"(?:[1-9][0-9]{0,9})"$

Request body

Required.

application/json
object
  • unknown properties allowed false
displayNamerequired
stringThe human-readable Integration name.
statusrequired
DataIntegrationStatusThe replacement Integration lifecycle state.

Responses

200DataIntegration
application/json
DataIntegrationEncoded
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
412DataIntegrationPreconditionFailed
application/json
DataIntegrationPreconditionFailedEncoded

Reusable schemas

DataIntegrationEncoded

object
  • unknown properties allowed false
integrationIdrequired
stringThe stable Organization-scoped Integration identifier.
  • maximum length 64
  • pattern ^integration_[\s\S]+$
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$
keyrequired
stringThe stable key of this Integration within its Organization.
  • maximum length 100
  • minimum length 1
  • pattern ^[a-z][a-z0-9_]*$
displayNamerequired
stringThe human-readable resource name.
statusrequired
DataIntegrationStatusThe current lifecycle status.
generationrequired
integerThe monotonically increasing Integration representation 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.

DataIntegrationPreconditionFailedEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "DataIntegrationPreconditionFailed"
resourcerequired
stringThe resource type relevant to the error.
  • allowed values "integration", "dataIntegrationApplication", "integrationEnvironmentBinding", "dataIntegrationConnection", "knowledgeBase"
currentEtagrequired
stringThe current strong ETag required for the next conditional activation.
  • maximum length 12
  • pattern ^"(?:[1-9][0-9]{0,9})"$

DataIntegrationStatus

string
  • allowed values "active", "disabled"