Get Job Status
Get Job Status
GET
/api/portal/v1/jobs/getJobStatus
Description
Return a lightweight summary of the current job activity on the instance. Useful for quickly checking whether the system is busy without fetching the full job list.
Authentication
This endpoint requires a Bearer token in the Authorization header.
- Authorization:
Bearer <token>. A valid Portal API session token or API token.
Response Schema
activeJobs: The number of jobs in thependingorrunningstate.isEditable:trueif the caller is permitted to create maintenance jobs through Create Job, otherwisefalse.
Error Responses
- 401 Unauthorized: The
Authorizationheader is missing or the token is not valid.
Example Request
GET https://<your-host>:9909/api/portal/v1/jobs/getJobStatus
Authorization: Bearer <token>
Example Response
Status Code: 200 OK
Response Body:
{
"activeJobs": 2,
"isEditable": true
}