Get deployment statistics
GET
/api/v1/deployments/stats
const url = 'http://localhost:3000/api/v1/deployments/stats';const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://localhost:3000/api/v1/deployments/stats \ --header 'X-API-Key: <X-API-Key>'Retrieves deployment statistics for the organization.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”x-organization-id
string format: uuid
UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.
Responses
Section titled “Responses”Deployment statistics retrieved successfully
Media typeapplication/json
object
total
required
Total number of deployments
number
byStatus
required
Deployment count per status (PENDING, INSTALLING, INSTALLED, FAILED, …)
object
key
additional properties
number
active
required
Deployments that are PENDING, INSTALLING or INSTALLED
number
failed
required
Deployments in status FAILED
number
Examplegenerated
{ "total": 1, "byStatus": { "additionalProperty": 1 }, "active": 1, "failed": 1}Forbidden — caller lacks required permission