Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

Get an App

GET /v3/apps/:guid

Request

Route

GET /v3/apps/guid-5afddafc-5d5e-44f9-bce3-9ee0cfcdb39b

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxOCIsImVtYWlsIjoiZW1haWwtMjIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MTR9.Luiz6ql1IWPMOjt9DFzdPEJ7byo0A8CtYU_vfk5-_WE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps/guid-5afddafc-5d5e-44f9-bce3-9ee0cfcdb39b" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxOCIsImVtYWlsIjoiZW1haWwtMjIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MTR9.Luiz6ql1IWPMOjt9DFzdPEJ7byo0A8CtYU_vfk5-_WE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "guid": "guid-5afddafc-5d5e-44f9-bce3-9ee0cfcdb39b",
  "name": "my_app",
  "desired_state": "STOPPED",
  "environment_variables": {
    "darkness": "ugly"
  },
  "_links": {
    "self": {
      "href": "/v3/apps/guid-5afddafc-5d5e-44f9-bce3-9ee0cfcdb39b"
    },
    "processes": {
      "href": "/v3/apps/guid-5afddafc-5d5e-44f9-bce3-9ee0cfcdb39b/processes"
    },
    "packages": {
      "href": "/v3/apps/guid-5afddafc-5d5e-44f9-bce3-9ee0cfcdb39b/packages"
    },
    "space": {
      "href": "/v2/spaces/b30b39d1-acf4-4509-b2c2-cca9f53f927e"
    },
    "desired_droplet": {
      "href": "/v3/droplets/a-droplet-guid"
    },
    "start": {
      "href": "/v3/apps/guid-5afddafc-5d5e-44f9-bce3-9ee0cfcdb39b/start",
      "method": "PUT"
    },
    "stop": {
      "href": "/v3/apps/guid-5afddafc-5d5e-44f9-bce3-9ee0cfcdb39b/stop",
      "method": "PUT"
    }
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e3e40e18-6884-4506-a3aa-57b9887f1cad
Content-Length: 870
X-Content-Type-Options: nosniff