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/ac131aae-e33f-4f03-9233-0f1143437242/instance_usage

Parameters

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNCIsImVtYWlsIjoiZW1haWwtNzRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NTM2MjMwMH0.Tu5hsjAh_r5pThHsCWx_w4R9CsaLAJkXsPyCvjJfHLk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/ac131aae-e33f-4f03-9233-0f1143437242/instance_usage" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNCIsImVtYWlsIjoiZW1haWwtNzRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NTM2MjMwMH0.Tu5hsjAh_r5pThHsCWx_w4R9CsaLAJkXsPyCvjJfHLk" \
	-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: 0e227ae3-aafc-4baf-97e3-07c35f82df73
Content-Length: 20
X-Content-Type-Options: nosniff