Skip to main content
POST
Pause connector

Authorizations

Authorization
string
header
required

API key, not necessarily a JWT. Server derives Organization, permitted actions and Corpus scope; every resource access is authorized.

Path Parameters

connector_id
string
required
Minimum string length: 1

Body

application/json
idempotency_key
string
required
Minimum string length: 1

Response

Successful response

connector_id
string
required
Minimum string length: 1
corpus_id
string
required
Minimum string length: 1
source_namespace
string
required
Minimum string length: 1
kind
string
required

Connector kind, provided by a pinned connector plugin; listConnectorKinds lists the kinds this deployment accepts. First-party connector plugins provide rss (RSS 2.0, RSS 1.0, Atom and JSON Feed documents; config url, optional honor_ttl; optional credential username+password or token), x_list (an X list) and m365_mail (Microsoft 365 mailboxes). Another kind is refused with 422 unsupported_connector_kind.

Pattern: ^[a-z][a-z0-9_]{0,31}$
config
object
required
schedule
object
required
health_policy
object
required
enabled
boolean
required
created_at
string<date-time>
required
health
object
required

Last committed Connector Health, evaluated at each acquisition run, credential replacement and disable; evaluated_at shows its age. Precedence disabled, access_error, credential_expiring, silent, active. access_error means the source refused access (distinct from silent, which means no new item within the threshold), including a push channel refused access while polling carries the collection. Other failures appear only as last_error.

push_policy
object

Engine-owned protection of declared source API routes, separate from plugin config. Missing fields inherit deployment defaults; configure at instance creation.

work_queue
enum<string>

Workload class for scheduled acquisition; push deliveries stay live.

Available options:
live,
bulk
disabled_at
string<date-time>
paused_at
string<date-time>

Present while scheduled acquisition is paused. Inbound push routes remain available.

credential
object

Metadata of the current Deposited Credential; the secret itself is never returned.

webhook_url
string<uri>

Public address of the instance's webhook route, present when its kind declares the push mode and the deployment sets public_url. The kind's plugin registers it with the source.