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-960f983c-5db0-4def-a102-26a4657c8b6f
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-6e565032-dc15-4022-b767-f4782445cc7f
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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MiIsImVtYWlsIjoiZW1haWwtOTRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxOTk4OTk2N30.BwuAoxjBIlBPFb1oeZBlE1lYONgwjfG5eNazpvkzz8E
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

POST /v2/apps

Body

{
  "name": "my_super_app",
  "space_guid": "a9d717ad-5907-4a32-bb24-b638aa345d78"
}

cURL

curl "https://api.[your-domain.com]/v2/apps" -d '{
  "name": "my_super_app",
  "space_guid": "a9d717ad-5907-4a32-bb24-b638aa345d78"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MiIsImVtYWlsIjoiZW1haWwtOTRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxOTk4OTk2N30.BwuAoxjBIlBPFb1oeZBlE1lYONgwjfG5eNazpvkzz8E" \
	-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/fcad0b2f-6673-4a49-b43d-4204567aee37
X-VCAP-Request-ID: 1bb05650-8998-4800-9d4e-d229b42bb3ee
Content-Length: 1319
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "fcad0b2f-6673-4a49-b43d-4204567aee37",
    "url": "/v2/apps/fcad0b2f-6673-4a49-b43d-4204567aee37",
    "created_at": "2014-12-24T01:39:27+00:00",
    "updated_at": null
  },
  "entity": {
    "name": "my_super_app",
    "production": false,
    "space_guid": "a9d717ad-5907-4a32-bb24-b638aa345d78",
    "stack_guid": "e71bebe2-0011-40e4-b63e-10e2f86a1e9f",
    "buildpack": null,
    "detected_buildpack": null,
    "environment_json": {

    },
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STOPPED",
    "version": "1edc012e-592e-46e3-8b4c-900d97112530",
    "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/a9d717ad-5907-4a32-bb24-b638aa345d78",
    "stack_url": "/v2/stacks/e71bebe2-0011-40e4-b63e-10e2f86a1e9f",
    "events_url": "/v2/apps/fcad0b2f-6673-4a49-b43d-4204567aee37/events",
    "service_bindings_url": "/v2/apps/fcad0b2f-6673-4a49-b43d-4204567aee37/service_bindings",
    "routes_url": "/v2/apps/fcad0b2f-6673-4a49-b43d-4204567aee37/routes"
  }
}

Audit Records Created By The Request

Audit Record: audit.app.create

Attribute Name Value
id 147
guid de6f14f5-4a7d-47c1-a913-95111c084468
created_at 2014-12-24 01:39:27 +0000
updated_at
timestamp 2014-12-24 01:39:27 +0000
type audit.app.create
actor uaa-id-142
actor_type user
actee fcad0b2f-6673-4a49-b43d-4204567aee37
actee_type app
metadata
{
  "request": {
    "name": "my_super_app",
    "space_guid": "a9d717ad-5907-4a32-bb24-b638aa345d78",
    "console": false,
    "environment_json": "PRIVATE DATA HIDDEN",
    "health_check_type": "port",
    "instances": 1,
    "production": false,
    "state": "STOPPED"
  }
}
space_id 163
organization_guid e83b2157-c2d0-49a2-a0b0-001c512d22cf
space_guid a9d717ad-5907-4a32-bb24-b638aa345d78
actor_name email-94@somedomain.com
actee_name my_super_app