Cancel a running job

Required scope: write

POST /api/v1/jobs/{job_id}/cancel

cURL

curl --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/jobs/{job_id}/cancel' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "cancelled": false,
  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "Two-person tent, green — replacement for damaged pole set."
}

Required scope: write

Path parameters

job_id · string · required

Job identifier

Response

CancelJobResponse

cancelled · boolean · required

Whether cancellation was successful

job_id · string · required

Job identifier

message · string · required

Message

Status codes

Code	Meaning
200	Job cancelled
401	Unauthorized — missing or invalid credentials
403	Forbidden — the key/token lacks the required scope
404	Job not found
429	Rate limited — see Retry-After / X-RateLimit-Reset

cURL

curl --request POST \
  --url 'https://api.nsr.stateset.com/api/v1/jobs/{job_id}/cancel' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "cancelled": false,
  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "Two-person tent, green — replacement for damaged pole set."
}