Get App summary
GET /v2/apps/:guid/summary
Request
Route
GET /v2/apps/10bb49b3-fd20-4490-bcec-976c25ee822b/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/10bb49b3-fd20-4490-bcec-976c25ee822b/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExOCIsImVtYWlsIjoiZW1haWwtODhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNTk0ODY2NH0.OhXdWvx4UqrS51YhzT80jw5NTx-vSH3Ca2cJ74Hpx5Y" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{"guid":"10bb49b3-fd20-4490-bcec-976c25ee822b","name":"name-1024","routes":[{"guid":"21b7084d-0044-407c-b5df-faab0e6b3647","host":"host-3","domain":{"guid":"c8ded5ca-1fd5-4ed9-97ac-b0b55791d13e","name":"domain-18.example.com"}}],"running_instances":0,"services":[{"guid":"d27a4d14-c14b-447e-beb9-531fb6f77d1b","name":"name-1026","bound_app_count":1,"last_operation":null,"dashboard_url":null,"service_plan":{"guid":"cce9a93a-9397-4a8a-b368-c09b66695386","name":"name-1027","service":{"guid":"81e9f0aa-613c-4f15-a5b2-938ea9b68f05","label":"label-30","provider":null,"version":null}}}],"available_domains":[{"guid":"c8ded5ca-1fd5-4ed9-97ac-b0b55791d13e","name":"domain-18.example.com","owning_organization_guid":"8e264e5a-53e9-432a-8889-4ec14fa5d0c2"},{"guid":"0aab0c3f-21ef-412b-a4c4-09a5a4e5b65f","name":"customer-app-domain1.com"},{"guid":"87c7d96a-48ad-4b01-8b0d-882125e41a6f","name":"customer-app-domain2.com"}],"name":"name-1024","production":false,"space_guid":"68c23bfb-4e2e-4113-8667-dfcf8369797b","stack_guid":"8e533024-883a-46e2-85cb-2cc5b8e6e708","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"f7473d3c-c430-4d7f-bd32-a970bcfa5568","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-03T00:51:04Z","detected_start_command":""}
Headers