/api/v1/runs/{runUuid}/items/{runItemUuid}/cancel
Requires the GV.APIContributor application role, or a higher role (Owner > Contributor > Reader).
Operation ID · cancel_run_item
Request example
Authentication and access
- Required role: GV.APIContributor
- Data classification: metadata
- Side effects: configurationWrite, executionCancel
- Microsoft Entra delegated user token
- Microsoft Entra application token
Parameters
runUuid
path Required Opaque Run UUID.string (uuid)
Opaque Run UUID.
runItemUuid
path Required Opaque Run Item UUID.string (uuid)
Opaque Run Item UUID.
Responses
This guide summarizes response status codes and headers. Retrieve the deployed, authenticated OpenAPI document for the exact response body schemas and examples. The API also provides an authenticated Swagger UI; opening it in a browser does not automatically attach a bearer token. Error responses useapplication/problem+json. The response’s stable code and type map to the error-code reference.
200
Cancellation is complete. The resource was already terminal or was terminalized synchronously.Headers
- Location: The affected Run or Run Item.
string
202
Run Item cancellation accepted.Headers
- Location: The affected Run or Run Item.
string - Retry-After: Wait five seconds before polling again.
integerAllowed values5
401
A valid Microsoft Entra bearer token is required.403
The authenticated principal does not have the required role.404
The resource does not exist in this tenant.409
The operation conflicts with current resource or Azure state.422
The request is syntactically valid but semantically invalid.429
The bounded application request rate was exceeded.Headers
- Retry-After: Seconds to wait before retrying.
integerminimum: 1
503
A required dependency is temporarily unavailable.Headers
- Retry-After: Seconds to wait before retrying.
integerminimum: 1