Skip to main content

Code Buckets

Abort an upload

View as Markdown

Cancel an unfinished upload.

POSTapi.codebuckets.clatterlabs.xyz/v1/uploads/{upload_id}/abortbuckets:write

Cancels an upload that isn't complete and frees the space it reserved.

Authorizations

Authorizationstringrequired

Your API key as a bearer token: Bearer clsk_.... Create keys in the Console with the Code Buckets permissions you need.

X-Clatter-Accountstringrequired

The Account ID that owns the key, like CL-7K2M9QXA. Find it in Console › Settings. A missing value answers 401 missing_account_id; someone else's answers 401 account_mismatch.

Path parameters

upload_idstringrequired

The upload id (cbo_…) from Start an upload.

Response

200 · application/json

objectstring

upload.

idstring

The upload id.

statusstring

aborted.

Errors

Status	Code	When
`401`	`invalid_api_key / missing_account_id / account_mismatch`	The key or Account ID is wrong.
`402`	`quota_exceeded`	This month's free tokens are used up.
`403`	`insufficient_scope`	The key lacks the permission.
`404`	`not_found`	No upload with that id on your account.
`409`	`upload_closed`	Only unfinished uploads can be aborted.

curl -X POST "https://api.codebuckets.clatterlabs.xyz/v1/uploads/UPLOAD_ID/abort" \
  -H "Authorization: Bearer $CLATTER_API_KEY" \
  -H "X-Clatter-Account: $CLATTER_ACCOUNT_ID"
import os
import requests

headers = {
    "Authorization": f"Bearer {os.environ['CLATTER_API_KEY']}",
    "X-Clatter-Account": os.environ["CLATTER_ACCOUNT_ID"],
}

r = requests.post("https://api.codebuckets.clatterlabs.xyz/v1/uploads/UPLOAD_ID/abort", headers=headers)
print(r.json())
const headers = {
  Authorization: `Bearer ${process.env.CLATTER_API_KEY}`,
  "X-Clatter-Account": process.env.CLATTER_ACCOUNT_ID,
};

const res = await fetch("https://api.codebuckets.clatterlabs.xyz/v1/uploads/UPLOAD_ID/abort", {
  method: "POST",
  headers,
});
console.log(await res.json());

{
  "object": "upload",
  "id": "cbo_m2n8b4v6c1x9z3l7k5j0",
  "status": "aborted"
}

Was this page helpful?

curl -X POST "https://api.codebuckets.clatterlabs.xyz/v1/uploads/UPLOAD_ID/abort" \
  -H "Authorization: Bearer $CLATTER_API_KEY" \
  -H "X-Clatter-Account: $CLATTER_ACCOUNT_ID"
import os
import requests

headers = {
    "Authorization": f"Bearer {os.environ['CLATTER_API_KEY']}",
    "X-Clatter-Account": os.environ["CLATTER_ACCOUNT_ID"],
}

r = requests.post("https://api.codebuckets.clatterlabs.xyz/v1/uploads/UPLOAD_ID/abort", headers=headers)
print(r.json())
const headers = {
  Authorization: `Bearer ${process.env.CLATTER_API_KEY}`,
  "X-Clatter-Account": process.env.CLATTER_ACCOUNT_ID,
};

const res = await fetch("https://api.codebuckets.clatterlabs.xyz/v1/uploads/UPLOAD_ID/abort", {
  method: "POST",
  headers,
});
console.log(await res.json());

{
  "object": "upload",
  "id": "cbo_m2n8b4v6c1x9z3l7k5j0",
  "status": "aborted"
}