Home
Version 3
Organizations API

Organizations API

Retrieving organization instance usage

GET /v2/organizations/:guid/instance_usage

This endpoint returns a count of started app instances under an organization. Note that crashing apps are included in this count.

Request

Route

GET /v2/organizations/f33c557a-6161-4e88-995e-242f8db887d1/instance_usage

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MSIsImVtYWlsIjoiZW1haWwtMTA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NDJ9.9wNjNP_B9Yf3ji_njKF663GhzoDuJZciIePzntyOrEc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/f33c557a-6161-4e88-995e-242f8db887d1/instance_usage" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MSIsImVtYWlsIjoiZW1haWwtMTA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQyNjA2NDJ9.9wNjNP_B9Yf3ji_njKF663GhzoDuJZciIePzntyOrEc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "instance_usage": 3
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 585d60e2-c17d-4a46-9880-3c8a085b91e5
Content-Length: 20
X-Content-Type-Options: nosniff