Skip to main content
POST
Cancel a debug attempt
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

POST /api/v2/workflows/cancelDebugAttempt Stops a queued attempt at once and asks a running one to stop; any other state is unchanged (changed: false).

Authentication

Personal key, External App credential or platform API key. Requires permission workflows:use, and the credential’s scopes must also reach workflows:read (a 403 naming it otherwise). Both are decided at the workflow’s home org unit. A debug attempt is personal, as in the Console: you debug drafts you created and read attempts you started. With a Personal key that is its owner; an External App or a platform key is its own creator (externalApp:<id>, apiKey:<id>). When draft debugging (workflow_debug_execution) is off for you (a Personal key’s owner) or for the deployment (an app or platform key), the route answers 409 conflict.

Headers

string
Optional. A same-key retry within 24 hours returns the recorded answer without writing again, only while you still own the attempt it names and may debug its workflow at its home; otherwise 409 idempotency_result_unavailable. The same key with a different body is 422. See Idempotency.

Body

string
required
The debug attempt’s id.

Responses

200 with data.attemptId, data.status and data.changed.

Errors

Example

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

attemptId
string
required

The attempt's id.

Minimum string length: 1

Response

The attempt's state

data
object
required
meta
object
required