Skip to main content
GET
Get a draft node's debug options
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

GET /api/v2/workflows/getDebugOptions Returns a produce or procedure node of the workflow’s draft and the workflow’s newest completed or failed production runs to take its inputs from (at most 20; sourceScanExhausted says the scan found no more). Pass one of them to prepareDebugAttempt.

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.

Query parameters

string
required
The workflow id.
string
required
The draft node’s id.

Responses

200 with data.workflowId, data.draftId, data.workflowName, data.targetNode, data.sourceRuns and data.sourceScanExhausted.

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.

Path Parameters

workflowId
string
required

The workflow id. Give it exactly once.

Minimum string length: 1

Query Parameters

nodeId
string
required

The draft node's id. Give it exactly once.

Minimum string length: 1

Response

The node's debug options

data
object
required
meta
object
required