Get App summary
GET /v2/apps/:guid/summary
Request
Route
GET /v2/apps/51a4381f-ad34-4863-a731-32d8089c14f7/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/51a4381f-ad34-4863-a731-32d8089c14f7/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3MSIsImVtYWlsIjoiZW1haWwtMjc0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4Njl9.cfi2menWtuInPRex3XioX7YRfMyiSuYhdNnzmpK-JRw" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{"guid":"51a4381f-ad34-4863-a731-32d8089c14f7","name":"name-2038","routes":[{"guid":"6f93b18c-6274-45a1-9f2f-3ac35072162a","host":"host-12","domain":{"guid":"44116a8c-2620-4e2c-98cc-008ad62239ca","name":"domain-56.example.com"}}],"running_instances":0,"services":[{"guid":"f3e9658d-92c4-4123-9c89-e30121708787","name":"name-2040","bound_app_count":1,"last_operation":null,"dashboard_url":null,"service_plan":{"guid":"e8d4bbb3-8e27-40fe-b85d-cfe425ed39e7","name":"name-2041","service":{"guid":"bd4aafc5-738c-48a1-b739-e57797e99bc7","label":"label-74","provider":null,"version":null}}}],"available_domains":[{"guid":"44116a8c-2620-4e2c-98cc-008ad62239ca","name":"domain-56.example.com","owning_organization_guid":"572a4c7f-5eac-45d6-9ea5-ca0af1dcee5e"},{"guid":"4c0d8867-d1bb-4cc1-917b-1ef4b34b2228","name":"customer-app-domain1.com"},{"guid":"22ef0219-441e-4fd9-9767-472fde60af54","name":"customer-app-domain2.com"}],"name":"name-2038","production":false,"space_guid":"4bf4c93c-ec3f-40a2-92ba-b99642f22cbd","stack_guid":"4e81dc8f-a138-4b3b-afe8-daaf5391c87c","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"55f57209-d16b-4c58-b4c1-2511f0ffa064","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-20T18:27:49Z","detected_start_command":""}
Headers