Sign in
Workflows

Get Workflow Instance Details

Changed on

Returns the status details of a workflow instance.

get/workflows/{workflow_name}/instances/{instance_id}

Request

  • Base URL: /cdn-cgi/local/explorer/api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /cdn-cgi/local/explorer/api/workflows/{workflow_name}/instances/{instance_id}
  • Auth: none declared

Path parameters

workflow_namestring required

The name of the workflow.

Example:my-workflow
instance_idstring required

The unique identifier of a workflow instance.

Example:my-instance-id

Response

Get Workflow Instance Details response.

successtrue required

Whether the API call was successful.

Example response

{
  "errors": [],
  "messages": [],
  "success": true
}

Changes