Rollback Job

Rollback a completed or failed indexing job — removes all indexed files and their associated data.

Behavior

Running job: Returns 409 Conflict — cancel the job first using DELETE /v2/jobs/{job_id}
Completed/Failed/Cancelled job: Deletes all files indexed by this job and returns the list of files removed
Not found: Returns 404

Use Cases

Undo a completed indexing job that indexed incorrect data
Clean up partial data from a failed job
Remove test data after development/staging indexing runs

Rollback a completed or failed indexing job — removes all indexed files and their associated data. ## Behavior - **Running job**: Returns `409 Conflict` — cancel the job first using `DELETE /v2/jobs/{job_id}` - **Completed/Failed/Cancelled job**: Deletes all files indexed by this job and returns the list of files removed - **Not found**: Returns `404` ## Use Cases - Undo a completed indexing job that indexed incorrect data - Clean up partial data from a failed job - Remove test data after development/staging indexing runs

Authentication

AuthorizationBearer

Bearer token authentication using API key

Path parameters

job_idstringRequired

The job ID to rollback

Response

Rollback completed successfully

job_idstring

The job ID that was rolled back

statusstring

Rollback status: rolled_back or error

messagestring or null

Human-readable summary of the rollback

files_removedlist of strings or null

List of file names that were removed by the rollback

rolled_back_atstring or null

RFC3339 timestamp of when the rollback completed

1	import requests
2	import json
3
4	BASE_URL = "https://api.runcaptain.com"
5	API_KEY = "your_api_key"
6
7	response = requests.patch(
8	f"{BASE_URL}/v2/jobs/abc123xyz-1234567890/rollback",
9	headers={
10	"Authorization": f"Bearer {API_KEY}",
11	"Content-Type": "application/json"
12	},
13	timeout=120.0
14	)
15
16	data = response.json()
17	print(json.dumps(data, indent=2))

1	{
2	"job_id": "abc123xyz-1234567890",
3	"status": "rolled_back",
4	"message": "Successfully rolled back job. Removed 3 files from collection.",
5	"files_removed": [
6	"report1.pdf",
7	"report2.pdf",
8	"quarterly_summary.xlsx"
9	],
10	"rolled_back_at": "2024-01-15T10:35:00Z"
11	}

Behavior

Use Cases

Authentication

Path parameters

Headers

Response

Errors

Behavior

Use Cases