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/6280ee87-0aac-476c-9bd8-349ec3fe4434/instance_usage

Parameters

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2IiwiZW1haWwiOiJlbWFpbC0yMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYxMzc0NjIzfQ.qxzEGZmLyNdNa8vVjnHmJHWt6hrQbvbK7pkovPHnIYY
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/6280ee87-0aac-476c-9bd8-349ec3fe4434/instance_usage" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2IiwiZW1haWwiOiJlbWFpbC0yMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYxMzc0NjIzfQ.qxzEGZmLyNdNa8vVjnHmJHWt6hrQbvbK7pkovPHnIYY" \
	-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: 2359c1ad-dfba-442e-8a11-38c7e0898191
Content-Length: 20
X-Content-Type-Options: nosniff