Cancel an in-progress script run

Table Of Contents

Cancel an in-progress script run#

Description#

Cancels a script run that is still in progress. The run must be in acknowledged, queued, or started status. Returns 409 Conflict if the run has already reached a terminal state.

POST /scripts/{scriptId}/runs/{runId}/cancellation

Required OAuth Scopes

file:write

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	true	Version of the API (2026-09-01.scripting.preview)
scriptId	path	string	true	The unique identifier of the script
runId	path	string	true	The unique identifier of the run

Code Samples#

curl

curl -X POST https://api.app.wdesk.com/scripts/{scriptId}/runs/{runId}/cancellation \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2026-09-01.scripting.preview'

httpie

http POST https://api.app.wdesk.com/scripts/{scriptId}/runs/{runId}/cancellation \
    X-Version:2026-09-01.scripting.preview \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=POST "https://api.app.wdesk.com/scripts/{scriptId}/runs/{runId}/cancellation" \
    --output-document - \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2026-09-01.scripting.preview'

python

import requests

headers = {
  'X-Version': '2026-09-01.scripting.preview',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.app.wdesk.com/scripts/{scriptId}/runs/{runId}/cancellation', headers = headers)

Returns#

204 - No Content#

401 - Unauthorized#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Forbidden#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not Found#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

409 - Conflict#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

429 - Too Many Requests#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Internal Server Error#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

503 - Service Unavailable#

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses#

Unauthorized

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

Forbidden

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

Not Found

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

Conflict

{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}

Too Many Requests

{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}

Internal Server Error

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}

Service Unavailable

{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}