Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

Starting an App

PUT /v3/apps/:guid/start

Request

Route

PUT /v3/apps/guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9/start

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyNiIsImVtYWlsIjoiZW1haWwtMTg3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0NDN9.92MRPYSEZsaK984WhNm88isBkLV9RXLnO6CMvLnxA8w
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps/guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9/start" -d '' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyNiIsImVtYWlsIjoiZW1haWwtMTg3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0NDN9.92MRPYSEZsaK984WhNm88isBkLV9RXLnO6CMvLnxA8w" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "guid": "guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9",
  "name": "original_name",
  "desired_state": "STARTED",
  "total_desired_instances": 0,
  "created_at": "2016-03-14T22:30:43Z",
  "updated_at": "2016-03-14T22:30:43Z",
  "lifecycle": {
    "type": "buildpack",
    "data": {
      "buildpack": "name-2018",
      "stack": "name-2019"
    }
  },
  "environment_variables": {

  },
  "links": {
    "self": {
      "href": "/v3/apps/guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9"
    },
    "space": {
      "href": "/v2/spaces/6412d02f-d6a4-4613-9047-1135adf20ab8"
    },
    "processes": {
      "href": "/v3/apps/guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9/processes"
    },
    "route_mappings": {
      "href": "/v3/apps/guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9/route_mappings"
    },
    "packages": {
      "href": "/v3/apps/guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9/packages"
    },
    "droplet": {
      "href": "/v3/droplets/guid-0a27827c-b822-4a78-a4ce-2ef223cd55aa"
    },
    "droplets": {
      "href": "/v3/apps/guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9/droplets"
    },
    "tasks": {
      "href": "/v3/apps/guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9/tasks"
    },
    "start": {
      "href": "/v3/apps/guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9/start",
      "method": "PUT"
    },
    "stop": {
      "href": "/v3/apps/guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9/stop",
      "method": "PUT"
    },
    "assign_current_droplet": {
      "href": "/v3/apps/guid-341bdcc1-6cd2-433d-9ec7-4d6d405da9c9/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.031679
Content-Length: 1565