Skip to content

Cancel Run ​

http
POST /api/v1/sessions/{sid}/runs/{rid}/cancel

Cancel Run

operationId: cancel_run

Authentication ​

HTTPBearer

See browser access. Session mutations require a Bearer key.

Parameters ​

NameInRequiredTypeDescription and constraints
sidpathYesstringformat: "uuid"
ridpathYesstringformat: "uuid"

Responses ​

CodeDescriptionContent
200OKapplication/json: Cancelled
202Successful Responseapplication/json: Cancelled
400Bad Requestapplication/json: ErrorResponse
401Unauthorizedapplication/json: ErrorResponse
403Browser sessions allow reading only (read_only_access).application/json: ErrorResponse
404Not Foundapplication/json: ErrorResponse
409Conflictapplication/json: ErrorResponse
413Content Too Largeapplication/json: ErrorResponse
415Unsupported Media Typeapplication/json: ErrorResponse
422Unprocessable Contentapplication/json: ErrorResponse
503Service Unavailableapplication/json: ErrorResponse

HTTP API