List Runs
GET {{baseUrl}}/api/v1/runs?limit=25&startingFrom=<integer>&orderBy=id&orderByDirection=desc&runType=deploy&runStatus=failed&environmentID=<string>&detail=false
Get a collection of information about runs.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | number | The maximum number of runs to return. | |
startingFrom | string | The starting run ID, runStartTime, or runEndTime (exclusive) for paging the query results. | |
orderBy | string | The field used to order results. | |
orderByDirection | string | The sort order for query results. | |
runType | string | A run type to filter the query results. | |
runStatus | string | A status value to filter the query results. | |
environmentID | string | An environment ID to filter the query results. | |
detail | boolean | Include the full detail of the run. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"limit":"\u003cinteger\u003e","orderBy":"id","orderByDirection":"desc","data":[{"id":"\u003cinteger\u003e","runType":"refresh","runStatus":"completed","reRunID":"\u003cstring\u003e","runStartTime":"\u003cdateTime\u003e","runEndTime":"\u003cdateTime\u003e","environmentID":"\u003cstring\u003e","runFailureReason":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","runType":"deploy","runStatus":"waitingToRun","reRunID":"\u003cstring\u003e","runStartTime":"\u003cdateTime\u003e","runEndTime":"\u003cdateTime\u003e","environmentID":"\u003cstring\u003e","runFailureReason":"\u003cstring\u003e"}]}