Get App summary
GET /v2/apps/:guid/summary
Request
Route
GET /v2/apps/fa7a457f-fdf6-4293-b1f0-e037ce5bf473/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/fa7a457f-fdf6-4293-b1f0-e037ce5bf473/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MiIsImVtYWlsIjoiZW1haWwtMTE4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDN9.-aHP1Pbt35xIfvaW72m0XHJ6Lanht2wEFv_CXKu03uc" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{"guid":"fa7a457f-fdf6-4293-b1f0-e037ce5bf473","name":"name-716","routes":[{"guid":"6122fc82-86a0-4e76-9157-845378d581ac","host":"host-12","domain":{"guid":"36b96b03-23f8-45cb-8295-fea015c05b50","name":"domain-37.example.com"}}],"running_instances":0,"services":[{"guid":"0d58be81-c6f0-4737-80be-038b7c3c75b4","name":"name-718","bound_app_count":1,"last_operation":null,"dashboard_url":null,"service_plan":{"guid":"753c673a-92fb-4565-8cd1-8a6093898a7e","name":"name-719","service":{"guid":"3dc9704f-afb4-435f-ab7b-0ae8a0797399","label":"label-38","provider":null,"version":null}}}],"available_domains":[{"guid":"36b96b03-23f8-45cb-8295-fea015c05b50","name":"domain-37.example.com","owning_organization_guid":"41a481fa-f9fc-4ced-b962-214ab0c84a6b"},{"guid":"767022a4-9669-4bce-ad4d-5e68061b03f4","name":"customer-app-domain1.com"},{"guid":"add7189e-c123-4fcf-96fd-844bfde51081","name":"customer-app-domain2.com"}],"name":"name-716","production":false,"space_guid":"1f80d81a-abbd-45d2-a6a8-42d7a66c8cd0","stack_guid":"39e65698-d8f9-4164-b7c2-b740c97a158c","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"b0a99b25-2596-4201-b6b9-e2c01015ec34","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-08-31T21:50:03Z","detected_start_command":"","enable_ssh":true,"docker_credentials_json":{"redacted_message":"[PRIVATE DATA HIDDEN]"}}
Headers