Retrieve a Particular App
GET /v2/apps/:guid
Request
Route
GET /v2/apps/0c551ea3-d9e6-4cfd-ae87-8199428d00d0
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-2d3e76b1-599d-42c5-949f-d113f71fde61
|
|
stack_guid
|
The guid of the associated stack.
|
Uses the default system stack.
|
|
- guid-c62a2c2b-d013-46ca-a616-883dc3898af6
|
|
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, 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
|
|
|
|
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
|
|
|
|
docker_image
|
Name of the Docker image containing the app
|
|
|
- cloudfoundry/helloworld
- registry.example.com:5000/user/repository/tag
|
|
docker_credentials_json
|
Docker credentials for pulling docker image.
|
{}
|
|
- #<RspecApiDocumentation::Views::HtmlExample:0x0000000ac6b3a8>
|
|
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
|
|
|
|
|
staging_failed_description
|
Detailed description for the staging_failed_reason
|
|
|
|
|
ports
|
Ports on which application may listen. Supported for applications pushed to Diego only.
|
|
|
|
Headers
cURL
curl "https://api.[your-domain.com]/v2/apps/0c551ea3-d9e6-4cfd-ae87-8199428d00d0" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5IiwiZW1haWwiOiJlbWFpbC0yOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQ3MTE2ODI3fQ.schaATU7AX-nw6n-tPXNyScmUQI2mg22WvpPKe4RdMk" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{
"metadata": {
"guid": "0c551ea3-d9e6-4cfd-ae87-8199428d00d0",
"url": "/v2/apps/0c551ea3-d9e6-4cfd-ae87-8199428d00d0",
"created_at": "2015-11-03T00:53:47Z",
"updated_at": "2015-11-03T00:53:47Z"
},
"entity": {
"name": "name-275",
"production": false,
"space_guid": "24b905e6-5a03-4851-9fe0-231bab2c20cd",
"stack_guid": "47d15dbc-219e-4c53-bd82-e6236ac476ce",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "d01c5464-3b11-4489-bd88-05b14a7be438",
"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": false,
"docker_image": null,
"package_updated_at": "2015-11-03T00:53:47Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"ports": null,
"space_url": "/v2/spaces/24b905e6-5a03-4851-9fe0-231bab2c20cd",
"stack_url": "/v2/stacks/47d15dbc-219e-4c53-bd82-e6236ac476ce",
"events_url": "/v2/apps/0c551ea3-d9e6-4cfd-ae87-8199428d00d0/events",
"service_bindings_url": "/v2/apps/0c551ea3-d9e6-4cfd-ae87-8199428d00d0/service_bindings",
"routes_url": "/v2/apps/0c551ea3-d9e6-4cfd-ae87-8199428d00d0/routes"
}
}
Headers