Dynamiq
Knowledge Bases

Pause a knowledge base source

Pauses automatic synchronization for a source. Its status becomes paused and scheduled syncs are suspended until resumed.

POST
/v1/knowledgebase-sources/{source_id}/pause

Authorization

personalAccessToken
AuthorizationBearer <token>

Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.

In: header

Path Parameters

source_id*string

Knowledge base source UUID.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/knowledgebase-sources/497f6eca-6276-4993-bfeb-53cbbbba6f08/pause"
{
  "message": "ok"
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}