Apps API

Creating a Docker App (experimental)

POST /v2/apps/

Fields

Name	Description	Default	Valid Values	Example Values
name	The name of the app.			my_super_app
memory	The amount of memory each instance should have. In megabytes.			1024 512
instances	The number of instances of the app to run. To ensure optimal availability, ensure there are at least 2 instances.			2 6 10
disk_quota	The maximum amount of disk available to an instance of an app. In megabytes.			1204 2048
space_guid	The guid of the associated space.			guid-44eb99fb-3800-404a-bcc9-a2c77c0092a6
stack_guid	The guid of the associated stack.	Uses the default system stack.
state	The current desired state of the app. One of STOPPED or STARTED.	STOPPED	STOPPED STARTED
detected_start_command	The command detected by the buildpack during staging.
command	The command to start an app after it is staged (e.g. 'rails s -p $PORT' or 'java com.org.Server $PORT').
buildpack	Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.			https://github.com/virtualstaticvoid/heroku-buildpack-r.git an_example_installed_buildpack
health_check_type	Type of health check to perform.	port	port none
health_check_timeout	Timeout for health checking of an staged app when starting up
docker_image	Name of the Docker image containing the app			cloudfoundry/helloworld registry.example.com:5000/user/repository/tag
environment_json	Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
production	Deprecated.	true	true false
console	Open the console port for the app (at $CONSOLE_PORT).	false	true false
debug	Open the debug port for the app (at $DEBUG_PORT).	false	true false
name	The name of the app.			my_super_app
memory	The amount of memory each instance should have. In megabytes.			1024 512
instances	The number of instances of the app to run. To ensure optimal availability, ensure there are at least 2 instances.			2 6 10
disk_quota	The maximum amount of disk available to an instance of an app. In megabytes.			1204 2048
space_guid	The guid of the associated space.			guid-cdf7ad51-6e26-43e8-919c-c5e62bc43f4b
stack_guid	The guid of the associated stack.	Uses the default system stack.
state	The current desired state of the app. One of STOPPED or STARTED.	STOPPED	STOPPED STARTED
detected_start_command	The command detected by the buildpack during staging.
command	The command to start an app after it is staged (e.g. 'rails s -p $PORT' or 'java com.org.Server $PORT').
buildpack	Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.			https://github.com/virtualstaticvoid/heroku-buildpack-r.git an_example_installed_buildpack
health_check_type	Type of health check to perform.	port	port none
health_check_timeout	Timeout for health checking of an staged app when starting up
docker_image	Name of the Docker image containing the app			cloudfoundry/helloworld registry.example.com:5000/user/repository/tag
environment_json	Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
production	Deprecated.	true	true false
console	Open the console port for the app (at $CONSOLE_PORT).	false	true false
debug	Open the debug port for the app (at $DEBUG_PORT).	false	true false

Request

Headers

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

Route

POST /v2/apps

Body

{
  "name": "docker_app",
  "space_guid": "ffc37cd5-5a10-438d-9575-5253a2dfc004",
  "docker_image": "cloudfoundry/hello",
  "environment_json": {
    "DIEGO_STAGE_BETA": "true",
    "DIEGO_RUN_BETA": "true"
  }
}

cURL

curl "https://api.[your-domain.com]/v2/apps" -d '{
  "name": "docker_app",
  "space_guid": "ffc37cd5-5a10-438d-9575-5253a2dfc004",
  "docker_image": "cloudfoundry/hello",
  "environment_json": {
    "DIEGO_STAGE_BETA": "true",
    "DIEGO_RUN_BETA": "true"
  }
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyMCIsImVtYWlsIjoiZW1haWwtMTYxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDV9.hzK2CYRz2dAppwVgVmRI3s1HCM9CnuoM48UMsEElzPE" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/apps/e89935af-690f-4111-8253-552a161d2791
X-VCAP-Request-ID: 4c1bd34d-27a3-41d9-b89f-b9e9f8397b3a
Content-Length: 1427
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "e89935af-690f-4111-8253-552a161d2791",
    "url": "/v2/apps/e89935af-690f-4111-8253-552a161d2791",
    "created_at": "2015-01-20T01:52:25+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "docker_app",
    "production": false,
    "space_guid": "ffc37cd5-5a10-438d-9575-5253a2dfc004",
    "stack_guid": "3d1fc9a9-e889-48d6-817b-5d96b9149db9",
    "buildpack": null,
    "detected_buildpack": null,
    "environment_json": {
      "DIEGO_STAGE_BETA": "true",
      "DIEGO_RUN_BETA": "true"
    },
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "975ccc83-5678-4f8f-8276-19922db064cb",
    "command": null,
    "console": false,
    "debug": null,
    "staging_task_id": null,
    "package_state": "PENDING",
    "health_check_type": "port",
    "health_check_timeout": null,
    "staging_failed_reason": null,
    "docker_image": "cloudfoundry/hello:latest",
    "package_updated_at": "2015-01-20T01:52:25+00:00",
    "detected_start_command": "",
    "space_url": "/v2/spaces/ffc37cd5-5a10-438d-9575-5253a2dfc004",
    "stack_url": "/v2/stacks/3d1fc9a9-e889-48d6-817b-5d96b9149db9",
    "events_url": "/v2/apps/e89935af-690f-4111-8253-552a161d2791/events",
    "service_bindings_url": "/v2/apps/e89935af-690f-4111-8253-552a161d2791/service_bindings",
    "routes_url": "/v2/apps/e89935af-690f-4111-8253-552a161d2791/routes"
  }
}

Audit Records Created By The Request

Audit Record: audit.app.create

Attribute Name	Value
id	147
guid	bb1cff56-b61e-4c89-b271-ea031d890d89
created_at	2015-01-20 01:52:25 +0000
updated_at
timestamp	2015-01-20 01:52:25 +0000
type	audit.app.create
actor	uaa-id-220
actor_type	user
actee	e89935af-690f-4111-8253-552a161d2791
actee_type	app
metadata	{ "request": { "name": "docker_app", "space_guid": "ffc37cd5-5a10-438d-9575-5253a2dfc004", "docker_image": "cloudfoundry/hello", "environment_json": "PRIVATE DATA HIDDEN", "console": false, "health_check_type": "port", "instances": 1, "production": false, "state": "STOPPED" } }
space_id	161
organization_guid	87e73605-5dd5-4cfe-b1b0-60ddc0f115f3
space_guid	ffc37cd5-5a10-438d-9575-5253a2dfc004
actor_name	email-161@somedomain.com
actee_name	docker_app