Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

Starting an App

PUT /v3/apps/:guid/start

Request

Route

PUT /v3/apps/guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2/start

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyNSIsImVtYWlsIjoiZW1haWwtMjk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2ODl9.o7Y1U3qR7nsvL4OgT7ISj4ToLMYGkV5oLjqB8qmtC3k
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps/guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2/start" -d '' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyNSIsImVtYWlsIjoiZW1haWwtMjk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2ODl9.o7Y1U3qR7nsvL4OgT7ISj4ToLMYGkV5oLjqB8qmtC3k" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "guid": "guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2",
  "name": "original_name",
  "desired_state": "STARTED",
  "total_desired_instances": 0,
  "created_at": "2016-03-17T21:41:29Z",
  "updated_at": "2016-03-17T21:41:29Z",
  "lifecycle": {
    "type": "buildpack",
    "data": {
      "buildpack": "name-2383",
      "stack": "name-2384"
    }
  },
  "environment_variables": {

  },
  "links": {
    "self": {
      "href": "/v3/apps/guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2"
    },
    "space": {
      "href": "/v2/spaces/06a2a9ee-7930-4237-b9b4-2d32a9c65ab6"
    },
    "processes": {
      "href": "/v3/apps/guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2/processes"
    },
    "route_mappings": {
      "href": "/v3/apps/guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2/route_mappings"
    },
    "packages": {
      "href": "/v3/apps/guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2/packages"
    },
    "droplet": {
      "href": "/v3/droplets/guid-23e8a776-7db1-40a0-8815-a1cfaece0854"
    },
    "droplets": {
      "href": "/v3/apps/guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2/droplets"
    },
    "tasks": {
      "href": "/v3/apps/guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2/tasks"
    },
    "start": {
      "href": "/v3/apps/guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2/start",
      "method": "PUT"
    },
    "stop": {
      "href": "/v3/apps/guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2/stop",
      "method": "PUT"
    },
    "assign_current_droplet": {
      "href": "/v3/apps/guid-9b2f6470-0fe5-4601-b6b1-bcb99a0777a2/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.029159
Content-Length: 1565