Delete Masking Report

DELETE

https://api.captain.dev/v2/jobs/:job_id/pii

Permanently delete a job’s PII masking report before its automatic 90-day expiry. Later GET calls return 410 with deleted_at; the report is never regenerated. Refused while the job is still running. Requires a key with the index permission.

Path parameters

job_idstringRequired

ID of the job whose masking report to act on, as returned by the indexing endpoint that started it.

Response

Successful Response

job_idstring

deletedboolean

deleted_atstring

When the report was destroyed (RFC3339).

objects_deletedinteger

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

410

Gone Error

503

Service Unavailable Error

1	import requests
2	import json
3
4	BASE_URL = "https://api.captain.dev"
5	API_KEY = "your_api_key"
6	JOB_ID = "job_01HZP5G8N3"
7
8	headers = {
9	"Authorization": f"Bearer {API_KEY}",
10	}
11
12	response = requests.delete(
13	f"{BASE_URL}/v2/jobs/{JOB_ID}/pii",
14	headers=headers,
15	timeout=30.0
16	)
17
18	if response.status_code == 200:
19	data = response.json()
20	print(f"Deleted {data['objects_deleted']} object(s) at {data['deleted_at']}")
21	else:
22	print(f"Error: {response.status_code} {response.json().get('code')}")

1	{
2	"job_id": "job_01HZP5G8N3",
3	"deleted": true,
4	"deleted_at": "2025-01-21T14:02:11Z",
5	"objects_deleted": 1
6	}