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-c44d4e7a-6664-4fc9-abad-3c436558afda
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, 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
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-1973b28d-9d43-4c6f-bd3d-b6f2e55f1608
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, 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
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.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MCIsImVtYWlsIjoiZW1haWwtMjQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNzZ9.7yvWcizllv46ERXbnCzrvHUuTNfaPtqnYsqF6pSLv5s
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

POST /v2/apps

Body

{
  "name": "my_super_app",
  "space_guid": "bca404a3-b84e-439b-a8f6-32f872edde7b"
}

cURL

curl "https://api.[your-domain.com]/v2/apps" -d '{
  "name": "my_super_app",
  "space_guid": "bca404a3-b84e-439b-a8f6-32f872edde7b"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MCIsImVtYWlsIjoiZW1haWwtMjQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNzZ9.7yvWcizllv46ERXbnCzrvHUuTNfaPtqnYsqF6pSLv5s" \
	-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/5a54d450-18b1-4c6d-a806-f764b79f0cb3
X-VCAP-Request-ID: 2b4954c4-4867-4bbe-8beb-30bcfeddade0
Content-Length: 1314
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "5a54d450-18b1-4c6d-a806-f764b79f0cb3",
    "url": "/v2/apps/5a54d450-18b1-4c6d-a806-f764b79f0cb3",
    "created_at": "2015-02-10T01:42:56Z",
    "updated_at": null
  },
  "entity": {
    "name": "my_super_app",
    "production": false,
    "space_guid": "bca404a3-b84e-439b-a8f6-32f872edde7b",
    "stack_guid": "8a78e753-c401-45cb-809b-04a9ce32a899",
    "buildpack": null,
    "detected_buildpack": null,
    "environment_json": {

    },
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "ccf7783e-03d1-407a-898e-c262dab29d07",
    "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/bca404a3-b84e-439b-a8f6-32f872edde7b",
    "stack_url": "/v2/stacks/8a78e753-c401-45cb-809b-04a9ce32a899",
    "events_url": "/v2/apps/5a54d450-18b1-4c6d-a806-f764b79f0cb3/events",
    "service_bindings_url": "/v2/apps/5a54d450-18b1-4c6d-a806-f764b79f0cb3/service_bindings",
    "routes_url": "/v2/apps/5a54d450-18b1-4c6d-a806-f764b79f0cb3/routes"
  }
}

Audit Records Created By The Request

Audit Record: audit.app.create

Attribute Name Value
id 175
guid 68dcf5ee-1f9a-46b7-9884-a0294b6bb943
created_at 2015-02-10 01:42:56 UTC
updated_at
timestamp 2015-02-10 01:42:56 UTC
type audit.app.create
actor uaa-id-340
actor_type user
actee 5a54d450-18b1-4c6d-a806-f764b79f0cb3
actee_type app
metadata
{
  "request": {
    "name": "my_super_app",
    "space_guid": "bca404a3-b84e-439b-a8f6-32f872edde7b",
    "console": false,
    "environment_json": "PRIVATE DATA HIDDEN",
    "health_check_type": "port",
    "instances": 1,
    "production": false,
    "state": "STOPPED"
  }
}
space_id 258
organization_guid db4f9316-5859-4840-9c8a-4ebb0c36a4c4
space_guid bca404a3-b84e-439b-a8f6-32f872edde7b
actor_name email-243@somedomain.com
actee_name my_super_app