Home
Version 3
Apps API

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-83ed02d8-5e4d-4deb-86aa-ebb8fd87e631
stack_guid The guid of the associated stack. Uses the default system stack.
  • guid-e4c8eaea-4ebf-4e51-a827-1b417a41610f
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:0x00000003ce4958>
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
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-c3746430-2cfb-4f8d-97d2-2e12bc9d174c
stack_guid The guid of the associated stack. Uses the default system stack.
  • guid-170c8979-c1d5-423d-ad1c-25338fd427db
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:0x00000003ce4958>
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
{
  "name": "docker_app",
  "space_guid": "119bb3c4-08ac-4e32-ac7d-34a3a1cb3db5",
  "docker_image": "cloudfoundry/hello",
  "diego": true
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTUxIiwiZW1haWwiOiJlbWFpbC01MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM5NDI2MTk0fQ.KFO-86ZaaY2jUM2Oz2DJX3XAt5RcLHa5nkUoylsGIhU
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": "119bb3c4-08ac-4e32-ac7d-34a3a1cb3db5",
  "docker_image": "cloudfoundry/hello",
  "diego": true
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTUxIiwiZW1haWwiOiJlbWFpbC01MUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM5NDI2MTk0fQ.KFO-86ZaaY2jUM2Oz2DJX3XAt5RcLHa5nkUoylsGIhU" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "1a8c9cf4-599c-4eb6-9cfe-95c4d71e7896",
    "url": "/v2/apps/1a8c9cf4-599c-4eb6-9cfe-95c4d71e7896",
    "created_at": "2015-08-06T00:36:34Z",
    "updated_at": null
  },
  "entity": {
    "name": "docker_app",
    "production": false,
    "space_guid": "119bb3c4-08ac-4e32-ac7d-34a3a1cb3db5",
    "stack_guid": "97ea9cc1-4a9e-456d-b098-c4e7d95f7c4d",
    "buildpack": null,
    "detected_buildpack": null,
    "environment_json": {

    },
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "df2bfe7c-1d3c-4b96-90d2-91074d18409c",
    "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-08-06T00:36:34Z",
    "detected_start_command": "",
    "enable_ssh": true,
    "docker_credentials_json": {
      "redacted_message": "[PRIVATE DATA HIDDEN]"
    },
    "space_url": "/v2/spaces/119bb3c4-08ac-4e32-ac7d-34a3a1cb3db5",
    "stack_url": "/v2/stacks/97ea9cc1-4a9e-456d-b098-c4e7d95f7c4d",
    "events_url": "/v2/apps/1a8c9cf4-599c-4eb6-9cfe-95c4d71e7896/events",
    "service_bindings_url": "/v2/apps/1a8c9cf4-599c-4eb6-9cfe-95c4d71e7896/service_bindings",
    "routes_url": "/v2/apps/1a8c9cf4-599c-4eb6-9cfe-95c4d71e7896/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/apps/1a8c9cf4-599c-4eb6-9cfe-95c4d71e7896
X-VCAP-Request-ID: 27e4b443-f1a3-471f-9403-437768bd3742
Content-Length: 1526
X-Content-Type-Options: nosniff

Audit Records Created By The Request

Audit Record: audit.app.create

Attribute Name Value
id 4
guid 5002cbab-9df0-41e2-8935-a2bc036d3062
created_at 2015-08-06 00:36:34 UTC
updated_at
timestamp 2015-08-06 00:36:34 UTC
type audit.app.create
actor uaa-id-51
actor_type user
actee 1a8c9cf4-599c-4eb6-9cfe-95c4d71e7896
actee_type app
metadata
{
  "request": {
    "name": "docker_app",
    "space_guid": "119bb3c4-08ac-4e32-ac7d-34a3a1cb3db5",
    "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 18379617-924f-4a9b-b476-ce158e585b1c
space_guid 119bb3c4-08ac-4e32-ac7d-34a3a1cb3db5
actor_name email-51@somedomain.com
actee_name docker_app