Get App summary
GET /v2/apps/:guid/summary
Fields
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
|
|
|
|
Request
Headers
Route
GET /v2/apps/6283131e-1038-4147-989d-89b8d5501244/summary
cURL
curl "https://api.[your-domain.com]/v2/apps/6283131e-1038-4147-989d-89b8d5501244/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMiIsImVtYWlsIjoiZW1haWwtMTU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzN9.u5m55jF6d-mUa-pB19rdXw4fsnu29IvJp6yEtkJpO7M" \
-H "Host: example.org" \
-H "Cookie: "
Response
Headers
Status
200 OK
Body
{"guid":"6283131e-1038-4147-989d-89b8d5501244","name":"name-1532","routes":[{"guid":"3248e15d-4904-4484-a1ef-fdb2e4723596","host":"host-9","domain":{"guid":"6e2d0c48-defb-4aa3-8399-c7d5cf4c52c8","name":"domain-45.example.com"}}],"running_instances":0,"services":[{"guid":"6b9591b9-826f-4c64-98ff-4e3efb8ad900","name":"name-1534","bound_app_count":1,"dashboard_url":null,"service_plan":{"guid":"067a6c0c-e895-44ee-b691-151de97ba4a7","name":"name-1535","service":{"guid":"bcfbcb98-9fef-4cf0-b383-0209df0ee232","label":"label-39","provider":"provider-39","version":"version-39"}}}],"available_domains":[{"guid":"6e2d0c48-defb-4aa3-8399-c7d5cf4c52c8","name":"domain-45.example.com","owning_organization_guid":"5be09267-42f1-4e2e-8587-d51d3c70ff28"},{"guid":"d08d36d4-e77e-4ae4-aba1-24333c083816","name":"customer-app-domain1.com"},{"guid":"a109aafb-255b-4740-8295-0af754f4d6fe","name":"customer-app-domain2.com"}],"name":"name-1532","production":false,"space_guid":"d809f051-7e36-4808-8384-0c554343db5f","stack_guid":"31276907-6e47-4e08-881a-943047c5e101","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"ee7b9050-ebdc-4669-ad93-ec2a199016ae","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,"docker_image":null,"package_updated_at":"2014-12-24T01:39:33+00:00","detected_start_command":""}