Creating an App
POST /v2/apps/
Fields
Name |
Description |
Default |
Valid Values |
Example Values |
name
|
The name of the app.
|
|
|
|
memory
|
The amount of memory each instance should have. In megabytes.
|
|
|
|
instances
|
The number of instances of the app to run. To ensure optimal availability, ensure there are at least 2 instances.
|
|
|
|
disk_quota
|
The maximum amount of disk available to an instance of an app. In megabytes.
|
|
|
|
space_guid
|
The guid of the associated space.
|
|
|
- guid-3e1b0442-f991-419e-b620-976513fad413
|
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
|
|
|
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_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
|
|
|
console
|
Open the console port for the app (at $CONSOLE_PORT).
|
false
|
|
|
debug
|
Open the debug port for the app (at $DEBUG_PORT).
|
false
|
|
|
name
|
The name of the app.
|
|
|
|
memory
|
The amount of memory each instance should have. In megabytes.
|
|
|
|
instances
|
The number of instances of the app to run. To ensure optimal availability, ensure there are at least 2 instances.
|
|
|
|
disk_quota
|
The maximum amount of disk available to an instance of an app. In megabytes.
|
|
|
|
space_guid
|
The guid of the associated space.
|
|
|
- guid-17c3c539-84c5-40ec-85c1-a1c6406724a4
|
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
|
|
|
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_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
|
|
|
console
|
Open the console port for the app (at $CONSOLE_PORT).
|
false
|
|
|
debug
|
Open the debug port for the app (at $DEBUG_PORT).
|
false
|
|
|
Request
Headers
Route
POST /v2/apps
Body
{
"name": "my_super_app",
"space_guid": "e4778067-60d4-4a34-b42e-a04bcd4a7566"
}
cURL
curl "https://api.[your-domain.com]/v2/apps" -d '{
"name": "my_super_app",
"space_guid": "e4778067-60d4-4a34-b42e-a04bcd4a7566"
}' -X POST \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwOCIsImVtYWlsIjoiZW1haWwtMjMzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjl9.l57heboRcUoVjSntg3_oD_uI9gEWSw0jWuJqigTDkVQ" \
-H "Host: example.org" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Cookie: "
Response
Headers
Status
201 Created
Body
{
"metadata": {
"guid": "fcfc9bdc-ac5e-4264-aa2e-ccce8db780c7",
"url": "/v2/apps/fcfc9bdc-ac5e-4264-aa2e-ccce8db780c7",
"created_at": "2014-11-24T19:32:49+00:00",
"updated_at": null
},
"entity": {
"name": "my_super_app",
"production": false,
"space_guid": "e4778067-60d4-4a34-b42e-a04bcd4a7566",
"stack_guid": "b1e53679-1ea7-4679-b9af-1a47365aa615",
"buildpack": null,
"detected_buildpack": null,
"environment_json": {
},
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "142a1c34-956e-4878-9fdb-2711c16d792f",
"command": null,
"console": false,
"debug": null,
"staging_task_id": null,
"package_state": "PENDING",
"health_check_timeout": null,
"staging_failed_reason": null,
"docker_image": null,
"package_updated_at": null,
"detected_start_command": "",
"space_url": "/v2/spaces/e4778067-60d4-4a34-b42e-a04bcd4a7566",
"stack_url": "/v2/stacks/b1e53679-1ea7-4679-b9af-1a47365aa615",
"events_url": "/v2/apps/fcfc9bdc-ac5e-4264-aa2e-ccce8db780c7/events",
"service_bindings_url": "/v2/apps/fcfc9bdc-ac5e-4264-aa2e-ccce8db780c7/service_bindings",
"routes_url": "/v2/apps/fcfc9bdc-ac5e-4264-aa2e-ccce8db780c7/routes"
}
}
Audit Records Created By The Request
Audit Record: audit.app.create
Attribute Name |
Value |
id
|
14
|
guid
|
60662a30-3076-4063-89dd-8eeeb9507145
|
created_at
|
2014-11-24 19:32:49 +0000
|
updated_at
|
|
timestamp
|
2014-11-24 19:32:49 +0000
|
type
|
audit.app.create
|
actor
|
uaa-id-308
|
actor_type
|
user
|
actee
|
fcfc9bdc-ac5e-4264-aa2e-ccce8db780c7
|
actee_type
|
app
|
metadata
|
{
"request": {
"name": "my_super_app",
"space_guid": "e4778067-60d4-4a34-b42e-a04bcd4a7566",
"console": false,
"environment_json": "PRIVATE DATA HIDDEN",
"instances": 1,
"production": false,
"state": "STOPPED"
}
}
|
space_id
|
43
|
organization_guid
|
a7298478-d3af-4444-9a10-262d1644b0b1
|
space_guid
|
e4778067-60d4-4a34-b42e-a04bcd4a7566
|
actor_name
|
email-233@somedomain.com
|
actee_name
|
my_super_app
|