Get Batch scheduler capacity

GET/v1/batch-jobs/capacity

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
None.
Query parameters
None.

Body schema

This endpoint does not require a request body.

None.

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Runtime admission and scoped queue summaryapplication/json
FieldTypeRequiredDescription
capacityobjectYes
capacity.availablebooleanYes
capacity.reasonstringNo
capacity.poolobjectYes
capacity.pool.containersintegerYes
capacity.pool.idleContainersintegerYesAllocated runtime containers that can accept work without a cold start.
capacity.pool.maxContainersintegerYes
capacity.pool.pendingContainerStartsintegerYes
capacity.pool.activeExecutionsintegerYes
capacity.pool.maxActiveExecutionsintegerYes
capacity.maintenancebooleanYes
capacity.diskPressurebooleanYes
capacity.poolIdstringYesStable logical capacity pool shared by API hosts and Batch workers.
capacity.reportingHostsintegerYes
capacity.reservedExecutionSlotsintegerYes
capacity.reservedContainerSlotsintegerYes
capacity.observedAtstringYes
queueobjectYes
Get Batch scheduler capacity
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow