Apps API

Creating a Docker App (experimental)

POST /v2/apps/

Request

Route

POST /v2/apps

Body

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-2d3e76b1-599d-42c5-949f-d113f71fde61
stack_guid	The guid of the associated stack.	Uses the default system stack.		guid-c62a2c2b-d013-46ca-a616-883dc3898af6
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, maximum length: 4096 (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
diego	Use diego to stage and to run when available	false	true false
docker_image	Name of the Docker image containing the app			cloudfoundry/helloworld registry.example.com:5000/user/repository/tag
docker_credentials_json	Docker credentials for pulling docker image.	{}		#<RspecApiDocumentation::Views::HtmlExample:0x0000000b0bb1b0>
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
staging_failed_reason	Reason for application staging failures
staging_failed_description	Detailed description for the staging_failed_reason
ports	Ports on which application may listen. Supported for applications pushed to Diego only.
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-acd36c3a-6bd9-4c66-93a4-eff9d8862c28
stack_guid	The guid of the associated stack.	Uses the default system stack.		guid-95053793-e324-4d2c-bd0c-4c52893b203e
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, maximum length: 4096 (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
diego	Use diego to stage and to run when available	false	true false
docker_image	Name of the Docker image containing the app			cloudfoundry/helloworld registry.example.com:5000/user/repository/tag
docker_credentials_json	Docker credentials for pulling docker image.	{}		#<RspecApiDocumentation::Views::HtmlExample:0x0000000b0bb1b0>
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
staging_failed_reason	Reason for application staging failures
staging_failed_description	Detailed description for the staging_failed_reason
ports	Ports on which application may listen. Supported for applications pushed to Diego only.

{
  "name": "docker_app",
  "space_guid": "9dc18b27-a70a-4406-ab8c-797468a0790a",
  "docker_image": "cloudfoundry/hello",
  "diego": true
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyIiwiZW1haWwiOiJlbWFpbC0zMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ3MTE2ODI4fQ.DtGI-ZcM5vE-qkbn8VI8pVY_9XAz3h_EUdF4pWc8Z5c
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/apps" -d '{
  "name": "docker_app",
  "space_guid": "9dc18b27-a70a-4406-ab8c-797468a0790a",
  "docker_image": "cloudfoundry/hello",
  "diego": true
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyIiwiZW1haWwiOiJlbWFpbC0zMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ3MTE2ODI4fQ.DtGI-ZcM5vE-qkbn8VI8pVY_9XAz3h_EUdF4pWc8Z5c" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "f0c16b23-dcce-4434-9e2f-45d1925919dd",
    "url": "/v2/apps/f0c16b23-dcce-4434-9e2f-45d1925919dd",
    "created_at": "2015-11-03T00:53:48Z",
    "updated_at": null
  },
  "entity": {
    "name": "docker_app",
    "production": false,
    "space_guid": "9dc18b27-a70a-4406-ab8c-797468a0790a",
    "stack_guid": "de37da0a-b083-48eb-8062-e7fcaa34459b",
    "buildpack": null,
    "detected_buildpack": null,
    "environment_json": {

    },
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "b4d80513-81d8-4e2d-a6cc-bfcfdeec75a4",
    "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,
    "staging_failed_description": null,
    "diego": true,
    "docker_image": "cloudfoundry/hello:latest",
    "package_updated_at": "2015-11-03T00:53:48Z",
    "detected_start_command": "",
    "enable_ssh": true,
    "docker_credentials_json": {
      "redacted_message": "[PRIVATE DATA HIDDEN]"
    },
    "ports": null,
    "space_url": "/v2/spaces/9dc18b27-a70a-4406-ab8c-797468a0790a",
    "stack_url": "/v2/stacks/de37da0a-b083-48eb-8062-e7fcaa34459b",
    "events_url": "/v2/apps/f0c16b23-dcce-4434-9e2f-45d1925919dd/events",
    "service_bindings_url": "/v2/apps/f0c16b23-dcce-4434-9e2f-45d1925919dd/service_bindings",
    "routes_url": "/v2/apps/f0c16b23-dcce-4434-9e2f-45d1925919dd/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/apps/f0c16b23-dcce-4434-9e2f-45d1925919dd
X-VCAP-Request-ID: 291ee494-1db2-49d3-8cb4-28bf09a9512d
Content-Length: 1545
X-Content-Type-Options: nosniff

Audit Records Created By The Request

Audit Record: audit.app.create

Attribute Name	Value
id	10
guid	478e3231-4f26-4b08-99f6-857cc1d62277
created_at	2015-11-03 00:53:48 UTC
updated_at
timestamp	2015-11-03 00:53:48 UTC
type	audit.app.create
actor	uaa-id-32
actor_type	user
actee	f0c16b23-dcce-4434-9e2f-45d1925919dd
actee_type	app
metadata	{ "request": { "name": "docker_app", "space_guid": "9dc18b27-a70a-4406-ab8c-797468a0790a", "docker_image": "cloudfoundry/hello", "diego": true, "console": false, "docker_credentials_json": "PRIVATE DATA HIDDEN", "environment_json": "PRIVATE DATA HIDDEN", "health_check_type": "port", "instances": 1, "production": false, "state": "STOPPED" } }
space_id
organization_guid	f82aebe0-0f13-4f8e-9305-3a5e311270c1
space_guid	9dc18b27-a70a-4406-ab8c-797468a0790a
actor_name	email-31@somedomain.com
actee_name	docker_app