Cancel run
Request cancellation of this creator’s queued or assigned run. Send an empty body; no query parameters or idempotency key are required. Repeating the PUT preserves the original intent and returns its current status. Assigned work records intent until termination is confirmed.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Accepted run identity.
Responses
Section titled “Responses”Durable cancellation intent and current confirmation status.
object
Set only after confirmed termination (or cancellation before assignment).
The retained actor may be an connector administrator for queued-only cutover.
Creator cancellation covers pending and running work. Connector context-cutover cancellation is queued-only and retains the actual actor and reason.
Public execution state. Delegated preparation and collection are running.
A request does not confirm termination. Completion can win a cancellation race.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
The request has query parameters or a nonempty body. Code bad_request.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
An active user credential is required. Code unauthenticated.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Bearer
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
The credential does not permit this operation (insufficient_scope).
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Run identity is invalid, absent, or belongs to another creator. Code not_found.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
The run completed before the request or its backend does not support cancellation.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
413: the request body exceeds the configured size limit.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Authentication/cancellation is unavailable, or its commit acknowledgement is uncertain. Code cancellation_uncertain requires retrying the same PUT.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
default
Section titled “default”An HTTP request failed; inspect the stable error code and request ID.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.