Home
Version 3
Apps API

Apps API

Get the instance information for a STARTED App

GET /v2/apps/:guid/instances

Get status for each instance of an App using the app guid. Note: Provided example response is for apps running on Diego. For apps running on DEAs, instance information will appear as follows: { "0": { "state": "RUNNING", "since": 1403140717.984577, "debug_ip": null, "debug_port": null, "console_ip": null, "console_port": null } }.

Request

Route

GET /v2/apps/0a241481-0d98-4d74-b73a-1d8a01071bba/instances

Parameters

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MyIsImVtYWlsIjoiZW1haWwtMTQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0Mzh9.-jbw5FmA589ldLzVyroToniPrpVhxkXmr6EPiNy0Nts
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/apps/0a241481-0d98-4d74-b73a-1d8a01071bba/instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MyIsImVtYWlsIjoiZW1haWwtMTQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0Mzh9.-jbw5FmA589ldLzVyroToniPrpVhxkXmr6EPiNy0Nts" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "0": {
    "state": "RUNNING",
    "since": 1403140717.984577,
    "uptime": 2405
  },
  "1": {
    "state": "STARTING",
    "since": 3625363939.984577,
    "uptime": 1394
  },
  "2": {
    "state": "CRASHED",
    "since": 2514251828.984577,
    "uptime": 283
  },
  "3": {
    "state": "DOWN",
    "uptime": 9172
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 228
X-Content-Type-Options: nosniff