Reconcile Sync | Captain Docs

Run an on-demand reconciliation: list the bucket, diff it against Captain’s indexed state, then index added/modified objects and apply the deletion policy to removed ones. Returns the deltas. This is the same operation the scheduled cadence runs automatically.

Path parameters

sync_idstringRequired

The sync id.

Response

Successful Response

sync_idstringOptional

job_idstring or nullOptional

Index job spawned for the deltas, if any.

addedintegerOptional

modifiedintegerOptional

removedintegerOptional

unchangedintegerOptional

deleted_documentsintegerOptional

Documents soft-deleted this pass under mirror/archive.

1	import requests
2
3	BASE_URL = "https://api.runcaptain.com"
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.post(
12	f"{BASE_URL}/v2/syncs/{sync_id}/reconcile",
13	headers=headers
14	)
15
16	print(response.json())

1	{
2	"sync_id": "sync_7e0abee6e110457db2c8",
3	"job_id": "65fca451551c43d097e3f206c93d921e-1786121649",
4	"added": 0,
5	"modified": 1,
6	"removed": 0,
7	"unchanged": 0,
8	"deleted_documents": 0
9	}

Path parameters

Headers

Response