Creating an App
POST /v2/apps/
Request
Route
POST /v2/apps
Body
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-c1eca213-8572-46e2-b658-a5dbfa4be9ba
|
stack_guid
|
The guid of the associated stack.
|
Uses the default system stack.
|
|
- guid-d7187878-4f73-462f-93bc-2003a8030ecc
|
state
|
The current desired state of the app. One of STOPPED or STARTED.
|
STOPPED
|
|
|
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. 'none' is deprecated and an alias to 'process'.
|
port
|
|
|
health_check_timeout
|
Timeout for health checking of an staged app when starting up
|
|
|
|
diego
|
Use diego to stage and to run when available
|
false
|
|
|
enable_ssh
|
Enable SSHing into the app. Supported for Diego only.
|
false if SSH is disabled globally or on the space, true if enabled for both
|
|
|
docker_image
|
Name of the Docker image containing the app. The "diego_docker" feature flag must be enabled in order to create Docker image apps.
|
|
|
- cloudfoundry/diego-docker-app
- registry.example.com:5000/user/repository/tag
|
docker_credentials_json
|
Docker credentials for pulling docker image.
|
{}
|
|
- #<RspecApiDocumentation::Views::HtmlExample:0x0000000680e8e0>
|
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
|
|
|
staging_failed_reason
|
Reason for application staging failures
|
|
|
- StagingError
- StagingTimeExpired
|
staging_failed_description
|
Detailed description for the staging_failed_reason
|
|
|
- An app was not successfully detected by any available buildpack
|
ports
|
Ports on which application may listen. Overwrites previously configured ports. Ports must be in range 1024-65535. Supported for Diego only.
|
|
|
|
{
"name": "my_super_app",
"space_guid": "7d832b03-bc13-4cc4-bd20-9a160ba122d9",
"diego": true,
"ports": [
1024,
2000
]
}
Headers
cURL
curl "https://api.[your-domain.com]/v2/apps" -d '{
"name": "my_super_app",
"space_guid": "7d832b03-bc13-4cc4-bd20-9a160ba122d9",
"diego": true,
"ports": [
1024,
2000
]
}' -X POST \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NiIsImVtYWlsIjoiZW1haWwtMjM3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3MjR9.xMaXeXNWSZkeyEiihZN5jfQWSlcGSap1qP1lXmgL1aM" \
-H "Host: example.org" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Cookie: "
Response
Status
201 Created
Body
{
"metadata": {
"guid": "20a98acd-cc5e-467a-8ce0-58ef31269580",
"url": "/v2/apps/20a98acd-cc5e-467a-8ce0-58ef31269580",
"created_at": "2016-05-12T00:45:24Z",
"updated_at": null
},
"entity": {
"name": "my_super_app",
"production": false,
"space_guid": "7d832b03-bc13-4cc4-bd20-9a160ba122d9",
"stack_guid": "e2ef3d79-1b83-4cd5-b36e-a4e1d59c5562",
"buildpack": null,
"detected_buildpack": null,
"environment_json": {
},
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "08d0c16d-2dea-4282-a35d-c5db1f4e1607",
"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,
"staging_failed_description": null,
"diego": true,
"docker_image": null,
"package_updated_at": null,
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"ports": [
1024,
2000
],
"space_url": "/v2/spaces/7d832b03-bc13-4cc4-bd20-9a160ba122d9",
"stack_url": "/v2/stacks/e2ef3d79-1b83-4cd5-b36e-a4e1d59c5562",
"routes_url": "/v2/apps/20a98acd-cc5e-467a-8ce0-58ef31269580/routes",
"events_url": "/v2/apps/20a98acd-cc5e-467a-8ce0-58ef31269580/events",
"service_bindings_url": "/v2/apps/20a98acd-cc5e-467a-8ce0-58ef31269580/service_bindings",
"route_mappings_url": "/v2/apps/20a98acd-cc5e-467a-8ce0-58ef31269580/route_mappings"
}
}
Headers
Audit Records Created By The Request
Audit Record: audit.app.create
Attribute Name |
Value |
id
|
210
|
guid
|
f179d448-bdae-4ece-931d-4e5922071b03
|
created_at
|
2016-05-12 00:45:24 UTC
|
updated_at
|
|
timestamp
|
2016-05-12 00:45:24 UTC
|
type
|
audit.app.create
|
actor
|
uaa-id-346
|
actor_type
|
user
|
actee
|
20a98acd-cc5e-467a-8ce0-58ef31269580
|
actee_type
|
app
|
metadata
|
{
"request": {
"name": "my_super_app",
"space_guid": "7d832b03-bc13-4cc4-bd20-9a160ba122d9",
"diego": true,
"ports": [
1024,
2000
],
"console": false,
"docker_credentials_json": "PRIVATE DATA HIDDEN",
"environment_json": "PRIVATE DATA HIDDEN",
"health_check_type": "port",
"instances": 1,
"production": false,
"state": "STOPPED"
}
}
|
space_id
|
|
organization_guid
|
cdbd7bd7-d5d9-40d7-8aca-ff84628bea10
|
space_guid
|
7d832b03-bc13-4cc4-bd20-9a160ba122d9
|
actor_name
|
email-237@somedomain.com
|
actee_name
|
my_super_app
|