Get App summary
GET /v2/apps/:guid/summary
Request
Route
GET /v2/apps/1c40de10-c03f-49d7-a8c0-c686eb14d0f9/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/1c40de10-c03f-49d7-a8c0-c686eb14d0f9/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NyIsImVtYWlsIjoiZW1haWwtMTE5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5NjV9.aHlnz2FYWpAsvmdgpjY7_oJbib_0eq0dXhG4ymXgoTA" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{"guid":"1c40de10-c03f-49d7-a8c0-c686eb14d0f9","name":"name-661","routes":[{"guid":"6ff9487b-ca71-445d-be3c-0615eec1defe","host":"host-18","domain":{"guid":"dda19f85-96d5-441b-bf19-89affdbe48e9","name":"domain-23.example.com"}}],"running_instances":0,"services":[{"guid":"3b293bfb-989e-41f8-a773-4e6804e42947","name":"name-663","bound_app_count":1,"last_operation":null,"dashboard_url":null,"service_plan":{"guid":"5d853252-70d4-4e91-a635-3714da2aa148","name":"name-664","service":{"guid":"9ff56fcc-a307-4fbf-88f5-ae358b3848e2","label":"label-49","provider":null,"version":null}}}],"available_domains":[{"guid":"dda19f85-96d5-441b-bf19-89affdbe48e9","name":"domain-23.example.com","owning_organization_guid":"1f767e24-f29f-4772-a4c3-230c714944e1"},{"guid":"e63b955d-66c6-4d6e-8a66-b68260c4f670","name":"customer-app-domain1.com"},{"guid":"906bad5e-b7da-4fd1-a15c-46527364d155","name":"customer-app-domain2.com"}],"name":"name-661","production":false,"space_guid":"26158dc1-e6a9-4fba-b857-2bda7e44713b","stack_guid":"27a4ac4e-6cb0-4cbb-8fdf-9c13c6f658fe","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"d2d6bb8f-3aa0-4afc-b7c2-7f6637fc1122","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-18T22:52:45Z","detected_start_command":""}
Headers