Home
Version 3
Apps (Experimental) API

Apps (Experimental) API

Create an App

POST /v3/apps

Creates an app in v3 of the Cloud Controller API. Apps must have a valid space guid for creation, which is namespaced under {"relationships": {"space": "your-space-guid"} }. See the example below for more information.

Request

Route

POST /v3/apps

Body

Name Description Default Valid Values Example Values
name Name of the App
relationships[space][guid] Guid for a particular space
environment_variables Environment variables to be used for the App when running
lifecycle Lifecycle to be used when creating the app. Note: If no lifecycle is provided, lifecycle type defaults to buildpack. Data is a required field in lifecycle
{"name":"my_app","environment_variables":{"open":"source"},"lifecycle":{"type":"buildpack","data":{"stack":null,"buildpack":"name-2342"}},"relationships":{"space":{"guid":"114ac626-a44f-444d-8329-c7240f1a7c84"}}}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MiIsImVtYWlsIjoiZW1haWwtMjY2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyODJ9.y9UjdG3d2OaH2a3U9eyTsl1J2px4k3eghp3uda-a-5A
Content-Type: application/json
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v3/apps" -d '{"name":"my_app","environment_variables":{"open":"source"},"lifecycle":{"type":"buildpack","data":{"stack":null,"buildpack":"name-2342"}},"relationships":{"space":{"guid":"114ac626-a44f-444d-8329-c7240f1a7c84"}}}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2MiIsImVtYWlsIjoiZW1haWwtMjY2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5yZWFkIiwiY2xvdWRfY29udHJvbGxlci53cml0ZSJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyODJ9.y9UjdG3d2OaH2a3U9eyTsl1J2px4k3eghp3uda-a-5A" \
	-H "Content-Type: application/json" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "guid": "7e37cc65-1005-47f0-a5d7-d056dff206de",
  "name": "my_app",
  "desired_state": "STOPPED",
  "total_desired_instances": 0,
  "created_at": "2016-01-19T19:41:22Z",
  "updated_at": null,
  "lifecycle": {
    "type": "buildpack",
    "data": {
      "buildpack": "name-2342",
      "stack": "default-stack-name"
    }
  },
  "environment_variables": {
    "open": "source"
  },
  "links": {
    "self": {
      "href": "/v3/apps/7e37cc65-1005-47f0-a5d7-d056dff206de"
    },
    "space": {
      "href": "/v2/spaces/114ac626-a44f-444d-8329-c7240f1a7c84"
    },
    "processes": {
      "href": "/v3/apps/7e37cc65-1005-47f0-a5d7-d056dff206de/processes"
    },
    "routes": {
      "href": "/v3/apps/7e37cc65-1005-47f0-a5d7-d056dff206de/routes"
    },
    "packages": {
      "href": "/v3/apps/7e37cc65-1005-47f0-a5d7-d056dff206de/packages"
    },
    "droplets": {
      "href": "/v3/apps/7e37cc65-1005-47f0-a5d7-d056dff206de/droplets"
    },
    "start": {
      "href": "/v3/apps/7e37cc65-1005-47f0-a5d7-d056dff206de/start",
      "method": "PUT"
    },
    "stop": {
      "href": "/v3/apps/7e37cc65-1005-47f0-a5d7-d056dff206de/stop",
      "method": "PUT"
    },
    "assign_current_droplet": {
      "href": "/v3/apps/7e37cc65-1005-47f0-a5d7-d056dff206de/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.034986
Content-Length: 1318