Delete Sync

DELETE

https://api.captain.dev/v2/syncs/:sync_id

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.

Path parameters

sync_idstringRequired

The sync id.

Response

Successful Response

sync_idstringOptional

statusenumOptional

deactivated_atstringOptional

1	import requests
2
3	BASE_URL = "https://api.captain.dev"
4	API_KEY = "your_api_key"
5
6	headers = {
7	"Authorization": f"Bearer {API_KEY}",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.delete(
12	f"{BASE_URL}/v2/syncs/sync_7e0abee6e110457db2c8",
13	headers=headers
14	)
15
16	print(response.json())

Path parameters

Headers

Response