← API referenceWrite & track · API access unavailable
API REFERENCE / WRITE & TRACK
POST /v1/uploads/{operation_id}/cancel
Ask Atom to cancel an upload that has not committed.
Request fields
| Location | Field | Type | Required | Description |
|---|---|---|---|---|
| Header | Authorization | string | Yes | Credential scoped to the authorized resource. |
| Path | operation_id | string | Yes | Existing upload operation. |
| Header | Idempotency-Key | string | Yes | Stable retry identity for cancellation. |
Request example
Example request
POST /v1/uploads/op_456/cancel
Authorization: Bearer <scoped token>
Idempotency-Key: cancel-8427HTTP status codes
| Status | Meaning |
|---|---|
202 Accepted | Success response shown below. |
401 Unauthorized | Missing, expired, or invalid credential. |
403 Forbidden | Credential is valid but lacks the required scope or role. |
404 Not Found | Operation is not visible. |
409 Conflict | Operation is already committed or terminal. |
429 Too Many Requests | Rate limit reached; honor Retry-After when provided. |
503 Service Unavailable | Service temporarily unavailable; retry safely. |
Response fields
| Field | Type | Example |
|---|---|---|
operation_id | string | op_456 |
status | string | cancelled |
Response example
Example response
202 Accepted
Content-Type: application/json
{
"operation_id": "op_456",
"status": "cancelled"
}How it works
Cancellation is retry-safe. It cannot undo a version already committed at the destination. Clients inspect the operation after an ambiguous acknowledgement.