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/3b791d5d-496b-43c6-b656-125f522988e5/instance_usage

Parameters

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNCIsImVtYWlsIjoiZW1haWwtMTIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4Mzd9.T2PGN--WLT5qiIGmsmLpo6ypiGBET9t63dYjV3HANNQ
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/3b791d5d-496b-43c6-b656-125f522988e5/instance_usage" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNCIsImVtYWlsIjoiZW1haWwtMTIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4Mzd9.T2PGN--WLT5qiIGmsmLpo6ypiGBET9t63dYjV3HANNQ" \
	-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: 7178dc06-8966-48bc-8069-308ad5bd6d0a
Content-Length: 20
X-Content-Type-Options: nosniff