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/faf6dd0f-9d5c-4c64-82e8-9cd8440408a2/instance_usage

Parameters

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY3IiwiZW1haWwiOiJlbWFpbC0zOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQxNjYyNTk2fQ.8vU20UR18GavoM-pl0INcI-38JoR0R0KroGXpUfO3KE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/faf6dd0f-9d5c-4c64-82e8-9cd8440408a2/instance_usage" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY3IiwiZW1haWwiOiJlbWFpbC0zOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQxNjYyNTk2fQ.8vU20UR18GavoM-pl0INcI-38JoR0R0KroGXpUfO3KE" \
	-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: c2a81346-fb5d-43c6-87f7-30ea877d1ed7
Content-Length: 20
X-Content-Type-Options: nosniff