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-66f00402-f886-4a38-b1a8-ad1a3797207e
stack_guid	The guid of the associated stack.	Uses the default system stack.		guid-88feb2b8-fc74-4a82-9b24-f9930e80f1f8
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:0x000000079a2a48>
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-69159af2-b29b-42e1-b333-bf23996c9b16
stack_guid	The guid of the associated stack.	Uses the default system stack.		guid-55526c5b-d3bd-458d-b564-f8728eabf92b
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:0x000000079a2a48>
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": "docker_app",
  "space_guid": "09dd4848-092f-4c26-8f1e-3e14198f5b50",
  "docker_image": "cloudfoundry/hello",
  "diego": true
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxOCIsImVtYWlsIjoiZW1haWwtMjM1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTZ9.y_nuW3zuE9aXCxNEqRGS_C5nqSCLVCOgJslXMsj9J-4
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": "09dd4848-092f-4c26-8f1e-3e14198f5b50",
  "docker_image": "cloudfoundry/hello",
  "diego": true
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxOCIsImVtYWlsIjoiZW1haWwtMjM1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTZ9.y_nuW3zuE9aXCxNEqRGS_C5nqSCLVCOgJslXMsj9J-4" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "ee2eeb8f-1178-4ce4-91d3-a89141a60581",
    "url": "/v2/apps/ee2eeb8f-1178-4ce4-91d3-a89141a60581",
    "created_at": "2015-06-04T00:05:16Z",
    "updated_at": null
  },
  "entity": {
    "name": "docker_app",
    "production": false,
    "space_guid": "09dd4848-092f-4c26-8f1e-3e14198f5b50",
    "stack_guid": "f0c3c54f-515a-46c5-9b75-848dcf8eb4f2",
    "buildpack": null,
    "detected_buildpack": null,
    "environment_json": {

    },
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "18401db9-5cb8-4519-af2e-155e00ea5096",
    "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,
    "diego": true,
    "docker_image": "cloudfoundry/hello:latest",
    "package_updated_at": "2015-06-04T00:05:16Z",
    "detected_start_command": "",
    "enable_ssh": true,
    "docker_credentials_json": {
      "redacted_message": "[PRIVATE DATA HIDDEN]"
    },
    "space_url": "/v2/spaces/09dd4848-092f-4c26-8f1e-3e14198f5b50",
    "stack_url": "/v2/stacks/f0c3c54f-515a-46c5-9b75-848dcf8eb4f2",
    "events_url": "/v2/apps/ee2eeb8f-1178-4ce4-91d3-a89141a60581/events",
    "service_bindings_url": "/v2/apps/ee2eeb8f-1178-4ce4-91d3-a89141a60581/service_bindings",
    "routes_url": "/v2/apps/ee2eeb8f-1178-4ce4-91d3-a89141a60581/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/apps/ee2eeb8f-1178-4ce4-91d3-a89141a60581
X-VCAP-Request-ID: 4210c6a8-db3f-4cf3-9d5d-5f0b07f051a0
Content-Length: 1486
X-Content-Type-Options: nosniff

Audit Records Created By The Request

Audit Record: audit.app.create

Attribute Name	Value
id	2
guid	3d5b113d-0800-40c6-9292-17d8b2e2820a
created_at	2015-06-04 00:05:16 UTC
updated_at
timestamp	2015-06-04 00:05:16 UTC
type	audit.app.create
actor	uaa-id-318
actor_type	user
actee	ee2eeb8f-1178-4ce4-91d3-a89141a60581
actee_type	app
metadata	{ "request": { "name": "docker_app", "space_guid": "09dd4848-092f-4c26-8f1e-3e14198f5b50", "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	8
organization_guid	89efd465-8327-4c28-bbf8-844e645f8b17
space_guid	09dd4848-092f-4c26-8f1e-3e14198f5b50
actor_name	email-235@somedomain.com
actee_name	docker_app