Get App summary
GET /v2/apps/:guid/summary
Request
Route
GET /v2/apps/dbf60e44-298d-4aeb-b8ca-4cdcbac0c2a0/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/dbf60e44-298d-4aeb-b8ca-4cdcbac0c2a0/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM5NyIsImVtYWlsIjoiZW1haWwtMjk1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzIzMTM2Mjd9.JGq-n2lOqWiGYur3jNpqHzWkrlWBI9F-Gwrw-NQSeSA" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{"guid":"dbf60e44-298d-4aeb-b8ca-4cdcbac0c2a0","name":"name-2204","routes":[{"guid":"3f5eeb52-aacd-429a-bd75-f97169183909","host":"host-25","domain":{"guid":"53d10614-4c5f-4c2e-9e3c-9a7bd13d06c0","name":"domain-69.example.com"}}],"running_instances":0,"services":[{"guid":"456c270d-12f9-4eea-9b8e-0e6671c01eaa","name":"name-2206","bound_app_count":1,"last_operation":null,"dashboard_url":null,"service_plan":{"guid":"62a73166-a989-4747-a3f9-e3c2005bb538","name":"name-2207","service":{"guid":"297399e9-ff16-43bc-b200-b7e17adfafe0","label":"label-82","provider":null,"version":null}}}],"available_domains":[{"guid":"53d10614-4c5f-4c2e-9e3c-9a7bd13d06c0","name":"domain-69.example.com","owning_organization_guid":"6002d52e-609b-4469-a03b-cdf4330b330e"},{"guid":"1b9d7fb7-c503-43c0-b72c-0f80f1ebb788","name":"customer-app-domain1.com"},{"guid":"b13efacf-446b-4f94-b9c0-a34959ce84d8","name":"customer-app-domain2.com"}],"name":"name-2204","production":false,"space_guid":"248aa08d-ad78-41ac-b094-ecac18281336","stack_guid":"55796c7e-692c-4e2e-9899-713bfb8568b0","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"ab3c6705-dcf0-41e7-bdc8-81e3a10faf0b","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-15T16:53:47Z","detected_start_command":"","enable_ssh":true}
Headers