Skip to content
FlightStack Docs
Sign in Start free

Cloud Runners API | FlightStack

Cloud runners are on-demand build VMs FlightStack provisions when your self-hosted agents are saturated (or absent). All endpoints are scoped to an organization and live under /organizations/{orgId}/cloud-runners.

MethodPathPurpose
GET/organizations/{orgId}/cloud-runners/configGet cloud-runner config.
PUT/organizations/{orgId}/cloud-runners/configUpdate config (image, machine type, max concurrency, budget).
POST/organizations/{orgId}/cloud-runners/enableEnable cloud runners for the org.
POST/organizations/{orgId}/cloud-runners/disableDisable cloud runners.
Terminal window
curl https://api.flightstack.voostack.com/organizations/$ORG_ID/cloud-runners/config \
-H "Authorization: Bearer $TOKEN"

Response:

{
"enabled": true,
"machineType": "c2-standard-4",
"image": "macos-14-xcode-16",
"maxConcurrentInstances": 8,
"idleMinutesBeforeShutdown": 5,
"monthlyBudgetCents": 50000,
"burstAllowedOver": "self-hosted"
}
Terminal window
curl -X PUT https://api.flightstack.voostack.com/organizations/$ORG_ID/cloud-runners/config \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"machineType": "c2-standard-8",
"maxConcurrentInstances": 16,
"monthlyBudgetCents": 100000
}'
MethodPathPurpose
GET/organizations/{orgId}/cloud-runners/instancesList active cloud-runner instances.
POST/organizations/{orgId}/cloud-runners/instances/{instanceId}/terminateForce-terminate an instance.

A cloud-runner instance is reported as soon as it boots and starts heartbeating. The agent running inside the instance posts back to /buildagent/{id}/cloud-runner/{instanceId}/ready when it’s accepting jobs.

MethodPathPurpose
GET/organizations/{orgId}/cloud-runners/usageUsage for a date range. Query: startDate=, endDate=.
GET/organizations/{orgId}/cloud-runners/usage/currentUsage for the current billing month.
Terminal window
curl "https://api.flightstack.voostack.com/organizations/$ORG_ID/cloud-runners/usage/current" \
-H "Authorization: Bearer $TOKEN"

Response includes minutes used per machine type, cumulative cost (cents), and a per-day breakdown.