List jobs
GET {{baseUrl}}/services/:serviceId/jobs?cursor=<string>&limit=20&status=succeeded,failed&createdBefore=<dateTime>&createdAfter=<dateTime>&startedBefore=<dateTime>&startedAfter=<dateTime>&finishedBefore=<dateTime>&finishedAfter=<dateTime>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
cursor | string | Cursor to begin retrieving entries for this query | |
limit | number | Max number of items that can be returned | |
status | string | Filter for the status of the job (pending , running , succeeded , or failed ) | |
createdBefore | string | Filter for jobs created before a certain time (specified as an ISO 8601 timestamp) | |
createdAfter | string | Filter for jobs created after a certain time (specified as an ISO 8601 timestamp) | |
startedBefore | string | Filter for jobs started before a certain time (specified as an ISO 8601 timestamp) | |
startedAfter | string | Filter for jobs started after a certain time (specified as an ISO 8601 timestamp) | |
finishedBefore | string | Filter for jobs finished before a certain time (specified as an ISO 8601 timestamp) | |
finishedAfter | string | Filter for jobs finished after a certain time (specified as an ISO 8601 timestamp) |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"job":{"id":"\u003cstring\u003e","serviceId":"\u003cstring\u003e","startCommand":"\u003cstring\u003e","planId":"\u003cstring\u003e","status":"\u003cstring\u003e","createdAt":"\u003cstring\u003e","startedAt":"\u003cstring\u003e","finishedAt":"\u003cstring\u003e"},"cursor":"\u003cstring\u003e"},{"job":{"id":"\u003cstring\u003e","serviceId":"\u003cstring\u003e","startCommand":"\u003cstring\u003e","planId":"\u003cstring\u003e","status":"\u003cstring\u003e","createdAt":"\u003cstring\u003e","startedAt":"\u003cstring\u003e","finishedAt":"\u003cstring\u003e"},"cursor":"\u003cstring\u003e"}]