Sign in
Datasets

Dispatch Connector Ingest Endpoint

Dispatch an overlay-owned ingest and return its opaque job id.

post/services/connectors/{connector_name}/ingest/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

connector_namestring required

Request body

credential_idstring nullable
configobject
resource_idstring required

API-safe opaque handle returned by connector discovery.

Response

Successful Response

job_idstring required

API-safe opaque handle for the dispatched ingest job.

status'queued'

Changes

No recorded changes to this operation across all 50 revisions of this API.