curl
curl -sS "https://gateway.orbit/api/v1/instances/12/queue?state=active&limit=25" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81'{
"data": {
"available": true,
"state": "pending",
"process_id": 123,
"status": "running",
"jobs_per_minute": 123,
"recent_jobs": 123,
"recently_failed_jobs": 123,
"processes": 123,
"totals": {
"pending": 123,
"completed": 123,
"failed": 123
},
"queues": [
{
"name": "<string>",
"length": 123,
"wait_seconds": 123,
"processes": 123
}
],
"dashboard_url": "<string>",
"jobs": [
{
"id": "<string>",
"name": "<string>",
"queue": "<string>",
"status": "<string>",
"pushed_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"exception": "<string>",
"url": "<string>"
}
]
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Instances
Read the Instance queue
GET
/
api
/
v1
/
instances
/
{instance}
/
queue
curl
curl -sS "https://gateway.orbit/api/v1/instances/12/queue?state=active&limit=25" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81'{
"data": {
"available": true,
"state": "pending",
"process_id": 123,
"status": "running",
"jobs_per_minute": 123,
"recent_jobs": 123,
"recently_failed_jobs": 123,
"processes": 123,
"totals": {
"pending": 123,
"completed": 123,
"failed": 123
},
"queues": [
{
"name": "<string>",
"length": 123,
"wait_seconds": 123,
"processes": 123
}
],
"dashboard_url": "<string>",
"jobs": [
{
"id": "<string>",
"name": "<string>",
"queue": "<string>",
"status": "<string>",
"pushed_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"exception": "<string>",
"url": "<string>"
}
]
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Path Parameters
Numeric Instance ID.
Required range:
x >= 1Query Parameters
Available options:
pending, completed, failed Required range:
1 <= x <= 50