Get App summary
GET /v2/apps/:guid/summary
Request
Route
GET /v2/apps/17100d17-6f68-4f99-acb9-ba971eb146a7/summary
Body
| Name |
Description |
Default |
Valid Values |
Example Values |
|
guid
|
The guid of the app for which summary is requested
|
|
|
|
|
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.
|
|
|
|
|
disk_quota
|
The maximum amount of disk available to an instance of an app. In megabytes.
|
|
|
|
|
space_guid
|
The guid of the associated space.
|
|
|
|
|
stack_guid
|
The guid of the associated stack.
|
Uses the default system stack.
|
|
|
|
state
|
The current state of the app. One of STOPPED or STARTED.
|
STOPPED
|
|
|
|
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.
|
|
|
|
|
health_check_timeout
|
Timeout for health checking of an staged app when starting up
|
|
|
|
|
environment_json
|
Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
|
|
|
|
|
detected_buildpack
|
The autodetected buildpack that staged the app.
|
|
|
|
|
detected_buildpack_guid
|
The guid of the autodetected admin buildpack that staged the app.
|
|
|
|
|
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
|
|
|
|
package_state
|
The current state of the package. One of PENDING, STAGED or FAILED.
|
|
|
|
|
package_updated_at
|
Time when the package was last updated
|
|
|
|
|
system_env_json
|
environment_json for system variables, contains vcap_services by default, a hash containing key/value pairs of the names and information of the services associated with your app.
|
|
|
|
|
staging_task_id
|
Staging task id
|
|
|
|
|
running_instances
|
The number of instances of the app that are currently running.
|
|
|
|
|
available_domain
|
List of available domains configured for the app
|
|
|
|
|
routes
|
List of routes configured for the app
|
|
|
|
|
version
|
Version guid of the app
|
|
|
|
|
services
|
List of services that are bound to the app
|
|
|
|
Headers
cURL
curl "https://api.[your-domain.com]/v2/apps/17100d17-6f68-4f99-acb9-ba971eb146a7/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NyIsImVtYWlsIjoiZW1haWwtMjAzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5OTN9.prfKEdW6On_-h76vqwpA_kdmvrqYro-TXkmik8U_UBM" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{"guid":"17100d17-6f68-4f99-acb9-ba971eb146a7","name":"name-1831","routes":[{"guid":"f56e68ee-2fe7-4316-9b04-238623ec1caf","host":"host-19","domain":{"guid":"a00abbbc-3412-4dea-bb55-2800fa716af9","name":"domain-57.example.com"}}],"running_instances":0,"services":[{"guid":"b8ff1678-9053-41c8-829f-17bda6d93ea2","name":"name-1833","bound_app_count":1,"last_operation":null,"dashboard_url":null,"service_plan":{"guid":"9630cf17-c514-445d-8174-119811b11893","name":"name-1834","service":{"guid":"f28c3b84-1f60-4607-a5fa-3195b560890c","label":"label-59","provider":null,"version":null}}}],"available_domains":[{"guid":"a00abbbc-3412-4dea-bb55-2800fa716af9","name":"domain-57.example.com","owning_organization_guid":"a6f57d72-402c-46c7-a44b-aab815943822"},{"guid":"3e8ca2ca-04cd-4de0-b001-15cb8a4c4984","name":"customer-app-domain1.com"},{"guid":"165929c0-f477-43b6-ac4e-e9b99ffb4c14","name":"customer-app-domain2.com"}],"name":"name-1831","production":false,"space_guid":"18f0659d-b50c-4203-a222-6ea4125e1f33","stack_guid":"dc40c066-cf1f-4575-bfc0-f7451e977258","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"b6f94401-5d55-46ef-ab45-5ff6f0da1ed7","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,"diego":false,"docker_image":null,"package_updated_at":"2015-05-21T01:03:13Z","detected_start_command":"","enable_ssh":true}
Headers