Skip to content
CantoraAPI documentation
PUT
/v1/organizations/{organizationId}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/knowledge-bases/{knowledgeBaseId}/connection

Replace a Knowledge Base's host-only Connection

Conditionally attach an active host-only Connection from the same Tenant, or detach the current Connection with null.

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]+$
tenantIdpathYes
The Tenant to address.
stringA Cantora Tenant identifier, prefixed with `tenant_`.
  • maximum length 64
  • pattern ^tenant_[\s\S]+$
knowledgeBaseIdpathYes
—
stringA Cantora knowledge base identifier, prefixed with `knowledge_base_`.
  • maximum length 64
  • pattern ^knowledge_base_[\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
dataIntegrationConnectionIdrequired
The same-Tenant host-only Connection to attach, or null to detach the current Connection.
Any of
stringA Cantora Integration Connection identifier, prefixed with `data_integration_connection_`.
  • maximum length 64
  • pattern ^data_integration_connection_[\s\S]+$
null

Responses

200KnowledgeBaseSummary
application/json
KnowledgeBaseSummaryEncoded
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

KnowledgeBaseSummaryEncoded

object
  • unknown properties allowed false
knowledgeBaseIdrequired
stringThe Knowledge Base identifier.
  • maximum length 64
  • pattern ^knowledge_base_[\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]+$
tenantIdrequired
stringThe Tenant identifier.
  • maximum length 64
  • pattern ^tenant_[\s\S]+$
keyrequired
stringThe stable, human-authored Agent Definition key.
displayNamerequired
stringThe human-readable resource name.
sourceTyperequired
stringThe provider-neutral source adapter type.
dataIntegrationConnectionIdrequired
The scoped data Integration Connection identifier.
Any of
stringA Cantora Integration Connection identifier, prefixed with `data_integration_connection_`.
  • maximum length 64
  • pattern ^data_integration_connection_[\s\S]+$
null
configurationGenerationrequired
integerThe monotonically increasing Knowledge Base configuration generation.
  • greater than 0
configurationEtagrequired
stringThe strong ETag for this Knowledge Base's mutable source configuration.
  • maximum length 12
  • pattern ^"(?:[1-9][0-9]{0,9})"$
activeSnapshotrequired
The active immutable Knowledge Snapshot, or null before the first successful synchronization.
Any of
ActiveKnowledgeSnapshotEncoded
null
createdAtrequired
stringWhen the resource was created, 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})"$

ActiveKnowledgeSnapshotEncoded

object
  • unknown properties allowed false
knowledgeSnapshotIdrequired
stringThe immutable Knowledge Snapshot identifier.
  • maximum length 64
  • pattern ^knowledge_snapshot_[\s\S]+$
generationrequired
integerThe monotonically increasing Agent Release generation.
  • greater than 0
embeddingProviderrequired
stringThe embedding provider used to build this Snapshot.
embeddingModelrequired
stringThe embedding model used to build this Snapshot.
embeddingDimensionsrequired
integerThe number of dimensions in every embedding vector in this Snapshot.
  • greater than 0
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time