Get App summary
GET /v2/apps/:guid/summary
Request
Route
GET /v2/apps/7b8f3dbf-add9-4b7a-adf8-85b1c545fd0a/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/7b8f3dbf-add9-4b7a-adf8-85b1c545fd0a/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMyIsImVtYWlsIjoiZW1haWwtMTY1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NDh9.pufveano4R0QwPB6--6bmO2wX1AQ1ENR2PoT_WfrXlU" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{"guid":"7b8f3dbf-add9-4b7a-adf8-85b1c545fd0a","name":"name-680","routes":[{"guid":"ef7cbda0-f691-4ea9-bfbf-fdcc2df917a1","host":"host-13","domain":{"guid":"7c0f01db-2e4d-4770-a4fb-ba2503acf837","name":"domain-42.example.com"}}],"running_instances":0,"services":[{"guid":"81387f49-4456-4c70-9447-67b5ee978ec7","name":"name-682","bound_app_count":1,"last_operation":null,"dashboard_url":null,"service_plan":{"guid":"0fbf304f-5751-4424-9146-673f5c16065f","name":"name-683","service":{"guid":"40dcc63a-765f-4c8a-b059-dda31243070a","label":"label-37","provider":null,"version":null}}}],"available_domains":[{"guid":"7c0f01db-2e4d-4770-a4fb-ba2503acf837","name":"domain-42.example.com","owning_organization_guid":"4d3c1a01-d9ab-4143-abfc-07de92b14e0c"},{"guid":"a5d4861e-8d41-4dc3-a6b6-02bbba589a5c","name":"customer-app-domain1.com"},{"guid":"9b85901f-f191-4d39-aeef-c043486a701c","name":"customer-app-domain2.com"}],"name":"name-680","production":false,"space_guid":"7d005d6c-a05d-4ac3-bb96-f88172532f26","stack_guid":"90d1044a-319d-4416-a621-362162d919b3","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"e12c8e35-fa51-43c6-a4ed-f746491851db","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-03-05T19:15:48Z","detected_start_command":""}
Headers