API Reference

Cancel all Jobs

Cancel all Pending API Jobs on your account at the start of this request, across all API keys.

POST/v1/api/job/cancel-all

Request example

bash

curl --fail-with-body --silent --show-error --max-time 30 \
  -X POST "$NORDY_BASE_URL/v1/api/job/cancel-all" \
  -H "api-key: $NORDY_API_KEY"

JSON

{"canceled_count": 3}

api-keystringrequired

Send the user API key in the api-key request header.

200 OK

canceled_countintegerresponserequired: Number newly canceled; zero when no eligible Jobs remain.

No request body is required.
The queued API status also includes Jobs preparing to execute, which are excluded.
A timeout or error may leave some Jobs canceled. Check their statuses before retrying; a new request also includes Jobs created since the previous call.

Status	Code	Description
400	MULTIPLE_AUTH_CREDENTIALS	Send the API key without login cookies.
401	AUTHENTICATION_REQUIRED	Missing or invalid API key.
403	USER_SUSPENDED, PRO_SUBSCRIPTION_REQUIRED, INVALID_INPUT	The account is suspended, lacks an active Pro subscription, or cannot access the API.
500	INTERNAL_ERROR	An error occurred while processing the request.