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-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.eyJ1c2VyX2lkIjoidWFhLWlkLTIxOSIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDV9.yfy1V7LAWKtmy0IMjXa9cGkGMtJ0EaaHAvjeWlavGAc
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

POST /v2/apps

Body

{
  "name": "my_super_app",
  "space_guid": "2c9ad552-76af-4f05-bf9c-ae98c31e7fdc"
}

cURL

curl "https://api.[your-domain.com]/v2/apps" -d '{
  "name": "my_super_app",
  "space_guid": "2c9ad552-76af-4f05-bf9c-ae98c31e7fdc"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxOSIsImVtYWlsIjoiZW1haWwtMTYwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDV9.yfy1V7LAWKtmy0IMjXa9cGkGMtJ0EaaHAvjeWlavGAc" \
	-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/683f4a2f-95c8-4e72-83c0-f368e24429b6
X-VCAP-Request-ID: 1f2f0dc1-c744-46a5-8802-ead0c6c07c9b
Content-Length: 1319
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "683f4a2f-95c8-4e72-83c0-f368e24429b6",
    "url": "/v2/apps/683f4a2f-95c8-4e72-83c0-f368e24429b6",
    "created_at": "2015-01-20T01:52:24+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "my_super_app",
    "production": false,
    "space_guid": "2c9ad552-76af-4f05-bf9c-ae98c31e7fdc",
    "stack_guid": "3d1fc9a9-e889-48d6-817b-5d96b9149db9",
    "buildpack": null,
    "detected_buildpack": null,
    "environment_json": {

    },
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "03947305-b1a6-4caf-a991-1f2d4829eb05",
    "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/2c9ad552-76af-4f05-bf9c-ae98c31e7fdc",
    "stack_url": "/v2/stacks/3d1fc9a9-e889-48d6-817b-5d96b9149db9",
    "events_url": "/v2/apps/683f4a2f-95c8-4e72-83c0-f368e24429b6/events",
    "service_bindings_url": "/v2/apps/683f4a2f-95c8-4e72-83c0-f368e24429b6/service_bindings",
    "routes_url": "/v2/apps/683f4a2f-95c8-4e72-83c0-f368e24429b6/routes"
  }
}

Audit Records Created By The Request

Audit Record: audit.app.create

Attribute Name Value
id 146
guid 0329d2d4-f24b-4019-8c75-35aa33eb7e5a
created_at 2015-01-20 01:52:24 +0000
updated_at
timestamp 2015-01-20 01:52:25 +0000
type audit.app.create
actor uaa-id-219
actor_type user
actee 683f4a2f-95c8-4e72-83c0-f368e24429b6
actee_type app
metadata
{
  "request": {
    "name": "my_super_app",
    "space_guid": "2c9ad552-76af-4f05-bf9c-ae98c31e7fdc",
    "console": false,
    "environment_json": "PRIVATE DATA HIDDEN",
    "health_check_type": "port",
    "instances": 1,
    "production": false,
    "state": "STOPPED"
  }
}
space_id 157
organization_guid e73b1228-4156-408a-93d5-42ff8fd132bd
space_guid 2c9ad552-76af-4f05-bf9c-ae98c31e7fdc
actor_name email-160@somedomain.com
actee_name my_super_app