Home
Version 3
Apps API

Apps API

Creating an App

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-5bae9144-1bc2-479b-a55d-9a2917d6a37b
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-ec45cada-473b-4c62-8c1c-131207473359
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.eyJ1c2VyX2lkIjoidWFhLWlkLTI4NiIsImVtYWlsIjoiZW1haWwtMjI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODJ9.td10qxcbzTkaS-4tTiJCBI627Fn-jNIWqkgKjqE9hiM
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

POST /v2/apps

Body

{
  "name": "my_super_app",
  "space_guid": "a25834d7-5d9a-4a28-90d8-68606084d832"
}

cURL

curl "https://api.[your-domain.com]/v2/apps" -d '{
  "name": "my_super_app",
  "space_guid": "a25834d7-5d9a-4a28-90d8-68606084d832"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4NiIsImVtYWlsIjoiZW1haWwtMjI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4ODJ9.td10qxcbzTkaS-4tTiJCBI627Fn-jNIWqkgKjqE9hiM" \
	-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/b9edc532-1975-43ab-9e2d-72da504996dc
X-VCAP-Request-ID: 4cf0b675-1142-414c-8f0b-b790c1321daa
Content-Length: 1314
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "b9edc532-1975-43ab-9e2d-72da504996dc",
    "url": "/v2/apps/b9edc532-1975-43ab-9e2d-72da504996dc",
    "created_at": "2015-01-27T19:14:42Z",
    "updated_at": null
  },
  "entity": {
    "name": "my_super_app",
    "production": false,
    "space_guid": "a25834d7-5d9a-4a28-90d8-68606084d832",
    "stack_guid": "2b754088-ca37-4e54-8e8b-05ed60ca552d",
    "buildpack": null,
    "detected_buildpack": null,
    "environment_json": {

    },
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "0323758b-6591-4d02-9ec1-aba7638d0167",
    "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": null,
    "package_updated_at": null,
    "detected_start_command": "",
    "space_url": "/v2/spaces/a25834d7-5d9a-4a28-90d8-68606084d832",
    "stack_url": "/v2/stacks/2b754088-ca37-4e54-8e8b-05ed60ca552d",
    "events_url": "/v2/apps/b9edc532-1975-43ab-9e2d-72da504996dc/events",
    "service_bindings_url": "/v2/apps/b9edc532-1975-43ab-9e2d-72da504996dc/service_bindings",
    "routes_url": "/v2/apps/b9edc532-1975-43ab-9e2d-72da504996dc/routes"
  }
}

Audit Records Created By The Request

Audit Record: audit.app.create

Attribute Name Value
id 15
guid d1fe97d9-3019-40e5-b990-1af6986c2bd8
created_at 2015-01-27 19:14:42 UTC
updated_at
timestamp 2015-01-27 19:14:42 UTC
type audit.app.create
actor uaa-id-286
actor_type user
actee b9edc532-1975-43ab-9e2d-72da504996dc
actee_type app
metadata
{
  "request": {
    "name": "my_super_app",
    "space_guid": "a25834d7-5d9a-4a28-90d8-68606084d832",
    "console": false,
    "environment_json": "PRIVATE DATA HIDDEN",
    "health_check_type": "port",
    "instances": 1,
    "production": false,
    "state": "STOPPED"
  }
}
space_id 64
organization_guid e2ccd209-6249-440e-85ac-200cbd36263e
space_guid a25834d7-5d9a-4a28-90d8-68606084d832
actor_name email-226@somedomain.com
actee_name my_super_app