Cancel benchmark

POST

/api/v1/benchmarks/{id}/cancel

const url = 'https://dashboard.justcrawl.io/api/v1/benchmarks/example/cancel';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://dashboard.justcrawl.io/api/v1/benchmarks/example/cancel \
  --header 'Authorization: Bearer <token>'

Cancels a pending or running benchmark by transitioning it to failed with the reason “Cancelled by user.” Cancellation is cooperative — the in-flight runner exits at its next checkpoint, so already-dispatched probes may still bill before the row flips. completed and already-failed benchmarks return 400 (nothing to cancel). Org-scoped — cross-tenant probes return 404 indistinguishably from missing IDs.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

Responses

200

Benchmark cancelled; runner exits at next checkpoint.

application/json

object

status

string

Allowed values: cancelled

Example

{
  "status": "cancelled"
}

400

Validation failed — request body or query is missing/invalid

application/json

object

error

string

Example

{
  "error": "Missing or invalid \"url\" field"
}

401

Missing or invalid authentication token

application/json

object

error

string

Example

{
  "error": "Missing or invalid authentication token"
}

403

Insufficient permissions for this operation

application/json

object

error

string

Example

{
  "error": "No organization. Complete onboarding first."
}

404

Resource not found

application/json

object

error

string

Example

{
  "error": "Workflow not found"
}

500

Unexpected server error. Logs and PostHog $exception capture

application/json

object

error

string

Example

{
  "error": "Something went wrong"
}