retrieval

Sync retrieval source

Queue a manual sync for a retrieval source, regardless of its sync interval.

The sync is recorded as a run with trigger manual. If a sync of this source is already running, no extra run starts.

Required permission: retrieval.manage.

post/v1/projects/{project_id}/retrieval/sources/{source_id}/sync

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/retrieval/sources/{source_id}/sync
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

source_idstring uuid required

Retrieval source ID from GET /retrieval/sources.

Query parameters

environment_idstring uuid required

Environment ID from GET /environments.

Response

Successful Response

queuedboolean required

True when a sync was queued.

Changes

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