Get App summary
GET /v2/apps/:guid/summary
Request
Route
GET /v2/apps/710f9485-5722-4547-8328-1a04bf73a938/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/710f9485-5722-4547-8328-1a04bf73a938/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3MCIsImVtYWlsIjoiZW1haWwtMjcyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MjJ9.YFyiV6Y8CL_e_FxlR5j18C95n6ALpKj2EblBmtEKWL0" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{"guid":"710f9485-5722-4547-8328-1a04bf73a938","name":"name-2066","routes":[{"guid":"32aecb18-eac1-46ef-bf7a-39582afb5d3d","host":"host-20","domain":{"guid":"26c056a6-287f-4253-9bf4-0975ca78858c","name":"domain-49.example.com"}}],"running_instances":0,"services":[{"guid":"88640f4a-28e2-473b-b429-d37abfee7ebc","name":"name-2068","bound_app_count":1,"last_operation":null,"dashboard_url":null,"service_plan":{"guid":"70a41c54-dd9e-46f9-864f-95b06748038b","name":"name-2069","service":{"guid":"d0b86807-ce3b-4d1a-8e6e-06739aa67846","label":"label-76","provider":null,"version":null}}}],"available_domains":[{"guid":"26c056a6-287f-4253-9bf4-0975ca78858c","name":"domain-49.example.com","owning_organization_guid":"9bd36156-fff3-46fd-9299-256452bb750c"},{"guid":"93f24315-31a4-406d-8a68-5b86967bf74b","name":"customer-app-domain1.com"},{"guid":"5fd82af0-b871-4e5f-bd07-12608ff25299","name":"customer-app-domain2.com"}],"name":"name-2066","production":false,"space_guid":"67de13b7-ffbc-4c30-b51c-cb34bec7687d","stack_guid":"df6b8b64-7806-450b-8cd5-9570b1812cda","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"141acc2c-3aa3-45e1-96c0-35fc9706732e","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-10T23:12:02Z","detected_start_command":""}
Headers