sync

Delete S3 Sync

Remove a sync: syncing stops and the connector is marked inactive. Its per-object sync state is cleared. Documents already indexed by the sync remain in the collection.

delete/v2/syncs/{sync_id}

Path parameters

sync_idstring required

The sync id.

Headers

authorizationstring nullable

Bearer {api_key}. Your Captain API key.

Response

Successful Response

sync_idstring
status'inactive'
deactivated_atstring

Changes

No recorded changes to this endpoint across all 1 revision of this API.