Skip to main content
POST
Cancel a validation run
Cancels a running validation run by its validationRunId (from Get a procedure version’s latest validation run), as the Procedure Builder card’s cancel does. This is a bookkeeping cancel: the run is marked canceled, so its sandbox lease is reclaimed and it stops counting as live; the running action is not interrupted. A run that already finished answers 200 with canceled: false and reason already_<status>.

Who may cancel

You need procedures:write at the home of the run’s procedure version. A missing run and one out of reach are the same 404 resource_missing. The cancel is audited (procedure_validation_canceled) with you as the actor.

Idempotency

With an Idempotency-Key, a same-key repeat within 24 hours returns the recorded result only while you still hold procedures:write there; otherwise 409 idempotency_result_unavailable.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

validationRunId
string
required

The validation run to cancel.

Minimum string length: 1

Response

Success

data
object
required

canceled: false with reason (already_<status>) when the run had already finished. A bookkeeping cancel: the run is marked canceled so its sandbox is reclaimed; the running action is not interrupted.

meta
object
required