COcontext
webdbs

Trigger a sync now

Changed on

Queues a sync now. Returns the current run when a sync is already active.

post/webdbs/collections/{collection_id}/sync

Request

  • Base URL
    https://api.context.dev/v1
  • URL
    https://api.context.dev/v1/webdbs/collections/{collection_id}/sync
  • Auth
    HTTP bearer

Path parameters

collection_idstring required

Collection ID.

Example:col_123

Query parameters

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.

[
  "production",
  "team-alpha"
]

Response

Sync queued

collection_idstring required

Collection ID.

run_idstring required

Queued run ID.

queuedboolean required

Whether the run was queued.

Example response

{
  "collection_id": "col_123",
  "run_id": "run_123",
  "queued": true
}

Changes

  • 182f532c2552Revision changes
    • warning

      added the new WEBSITE_BLOCKED enum value to the response property for the response status

    • warning

      added the new WEBSITE_BLOCKED enum value to the response property for the response status

  • 3c6a01ba967fRevision changes
    • warning

      added the new COLD_DOMAIN_TIMEOUT_TOO_LOW enum value to the response property for the response status

    • warning

      added the new COLD_DOMAIN_TIMEOUT_TOO_LOW enum value to the response property for the response status