Get App summary
GET /v2/apps/:guid/summary
Request
Route
GET /v2/apps/c4df6d6b-4f4c-44c8-aeac-b54c676fe90b/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/c4df6d6b-4f4c-44c8-aeac-b54c676fe90b/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYzIiwiZW1haWwiOiJlbWFpbC0zMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDQyNjAxNTI3fQ.yR1CPgCVLGRGU2fNbs79Pp5NNiIybiYcE17DfD6nNBc" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{"guid":"c4df6d6b-4f4c-44c8-aeac-b54c676fe90b","name":"name-108","routes":[{"guid":"59ea0fe8-81ab-4dd7-b63e-ffd64de8da31","host":"host-2","domain":{"guid":"8c1d5a7f-d76a-4384-bfbf-ad5bf7c686dd","name":"domain-2.example.com"}}],"running_instances":0,"services":[{"guid":"c2893788-7417-4e82-916d-7353548e80bc","name":"name-110","bound_app_count":1,"last_operation":null,"dashboard_url":null,"service_plan":{"guid":"019772e6-6d97-4ee3-ba7d-0a3df6129c3c","name":"name-111","service":{"guid":"a8a0d36a-e6bb-43e9-bc93-ec37227fcd9b","label":"label-3","provider":null,"version":null}}}],"available_domains":[{"guid":"8c1d5a7f-d76a-4384-bfbf-ad5bf7c686dd","name":"domain-2.example.com","owning_organization_guid":"75ef2278-845a-4df5-9884-ff200408b558"},{"guid":"2829c684-dcc2-4f9a-ae9b-318ad3a5b52e","name":"customer-app-domain1.com"},{"guid":"e9d521e2-5b91-4250-8cba-5c517b58006c","name":"customer-app-domain2.com"}],"name":"name-108","production":false,"space_guid":"b56e0a37-c9fd-4462-adb9-aff72a23a205","stack_guid":"334be2a7-1cf5-4ebc-b514-7581bc4ba016","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"70ab0fe3-fe04-449c-961e-190fa85f3620","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-09-11T18:38:46Z","detected_start_command":"","enable_ssh":true,"docker_credentials_json":{"redacted_message":"[PRIVATE DATA HIDDEN]"}}
Headers