Sign in
Workflows

List Workflow Instances

Changed on

Returns the instances of a workflow.

get/workflows/{workflow_name}/instances

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
  • Auth: none declared

Path parameters

workflow_namestring required

The name of the workflow.

Example:my-workflow

Query parameters

pagenumber

Page number (1-indexed).

per_pagenumber

Number of instances per page.

status'queued' | 'running' | 'paused' | 'errored' | 'terminated' | 'complete' | 'waitingForPause' | 'waiting'

Filter instances by status.

date_startstring date-time

Only return instances created at or after this time. Accepts ISO 8601 with no timezone offsets and in UTC.

date_endstring date-time

Only return instances created at or before this time. Accepts ISO 8601 with no timezone offsets and in UTC.

Response

List Workflow Instances response.

successtrue required

Whether the API call was successful.

Example response

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

Changes