Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

Get an App

GET /v3/apps/:guid

Request

Route

GET /v3/apps/guid-47899a3e-414c-4508-8099-00e798ccbbc7

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2NCIsImVtYWlsIjoiZW1haWwtMjEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5OTR9.j12hujzpcOcjzMJ3rH3_ZVO-gaUgvMdRal02yWJ1Nq0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps/guid-47899a3e-414c-4508-8099-00e798ccbbc7" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2NCIsImVtYWlsIjoiZW1haWwtMjEwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5OTR9.j12hujzpcOcjzMJ3rH3_ZVO-gaUgvMdRal02yWJ1Nq0" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "guid": "guid-47899a3e-414c-4508-8099-00e798ccbbc7",
  "name": "my_app",
  "desired_state": "STOPPED",
  "total_desired_instances": 3,
  "created_at": "2015-05-21T01:03:14Z",
  "updated_at": null,
  "environment_variables": {
    "darkness": "ugly"
  },
  "_links": {
    "self": {
      "href": "/v3/apps/guid-47899a3e-414c-4508-8099-00e798ccbbc7"
    },
    "processes": {
      "href": "/v3/apps/guid-47899a3e-414c-4508-8099-00e798ccbbc7/processes"
    },
    "packages": {
      "href": "/v3/apps/guid-47899a3e-414c-4508-8099-00e798ccbbc7/packages"
    },
    "space": {
      "href": "/v2/spaces/df42515e-3826-416a-8c13-d57760b47650"
    },
    "desired_droplet": {
      "href": "/v3/droplets/a-droplet-guid"
    },
    "start": {
      "href": "/v3/apps/guid-47899a3e-414c-4508-8099-00e798ccbbc7/start",
      "method": "PUT"
    },
    "stop": {
      "href": "/v3/apps/guid-47899a3e-414c-4508-8099-00e798ccbbc7/stop",
      "method": "PUT"
    },
    "assign_current_droplet": {
      "href": "/v3/apps/guid-47899a3e-414c-4508-8099-00e798ccbbc7/current_droplet",
      "method": "PUT"
    }
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 953777ce-6f4b-4271-ab8a-ec0faf8e767f
Content-Length: 1109
X-Content-Type-Options: nosniff