Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

Get an App

GET /v3/apps/:guid

Request

Route

GET /v3/apps/guid-009154e0-4036-47d8-8db2-97039227cf46

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0OCIsImVtYWlsIjoiZW1haWwtMzE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDgwMzg5NzV9.lAZB_ZiMcnH3FP_zKj6tLyrkG5rs0nlMHx74T9VDX-k
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps/guid-009154e0-4036-47d8-8db2-97039227cf46" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0OCIsImVtYWlsIjoiZW1haWwtMzE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDgwMzg5NzV9.lAZB_ZiMcnH3FP_zKj6tLyrkG5rs0nlMHx74T9VDX-k" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "guid": "guid-009154e0-4036-47d8-8db2-97039227cf46",
  "name": "my_app",
  "desired_state": "STOPPED",
  "total_desired_instances": 3,
  "created_at": "2015-11-13T17:02:55Z",
  "updated_at": null,
  "lifecycle": {
    "type": "buildpack",
    "data": {
      "buildpack": "name-2484",
      "stack": "name-2485"
    }
  },
  "environment_variables": {
    "unicorn": "horn"
  },
  "links": {
    "self": {
      "href": "/v3/apps/guid-009154e0-4036-47d8-8db2-97039227cf46"
    },
    "space": {
      "href": "/v2/spaces/8e5146ed-b267-4435-beb9-1fa41883e597"
    },
    "processes": {
      "href": "/v3/apps/guid-009154e0-4036-47d8-8db2-97039227cf46/processes"
    },
    "routes": {
      "href": "/v3/apps/guid-009154e0-4036-47d8-8db2-97039227cf46/routes"
    },
    "packages": {
      "href": "/v3/apps/guid-009154e0-4036-47d8-8db2-97039227cf46/packages"
    },
    "droplet": {
      "href": "/v3/droplets/a-droplet-guid"
    },
    "droplets": {
      "href": "/v3/apps/guid-009154e0-4036-47d8-8db2-97039227cf46/droplets"
    },
    "start": {
      "href": "/v3/apps/guid-009154e0-4036-47d8-8db2-97039227cf46/start",
      "method": "PUT"
    },
    "stop": {
      "href": "/v3/apps/guid-009154e0-4036-47d8-8db2-97039227cf46/stop",
      "method": "PUT"
    },
    "assign_current_droplet": {
      "href": "/v3/apps/guid-009154e0-4036-47d8-8db2-97039227cf46/current_droplet",
      "method": "PUT"
    }
  }
}

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
X-Runtime: 0.018128
Content-Length: 1423