GET
/
api
/
orchestration
/
v2
/
instances
List instances of a workflow
curl --request GET \
  --url http://localhost:55001/api/orchestration/v2/instances \
  --header 'Authorization: Bearer <token>'
{
  "cursor": {
    "pageSize": 15,
    "hasMore": false,
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "next": "",
    "data": [
      {
        "workflowID": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "status": [
          {
            "stage": 123,
            "instanceID": "<string>",
            "startedAt": "2023-11-07T05:31:56Z",
            "terminatedAt": "2023-11-07T05:31:56Z",
            "error": "<string>"
          }
        ],
        "terminated": true,
        "terminatedAt": "2023-11-07T05:31:56Z",
        "error": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
cursor
string

Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.

Example:

"aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="

​
pageSize
integer

The maximum number of results to return per page.

Required range: 1 <= x <= 1000
​
workflowID
string

A workflow id

​
running
boolean

Filter running instances

Response

200
application/json

List of workflow instances

The response is of type object.