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/b1f448d2-cf1b-42a2-bde5-b6668a653893/summary
cURL
curl "https://api.[your-domain.com]/v2/apps/b1f448d2-cf1b-42a2-bde5-b6668a653893/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTUzIiwiZW1haWwiOiJlbWFpbC00NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk4fQ.nGyEz0c4_CovtL7mfZcMTXszHDAdAgG611lnQLoh0Xo" \
-H "Host: example.org" \
-H "Cookie: "
Response
Headers
Status
200 OK
Body
{"guid":"b1f448d2-cf1b-42a2-bde5-b6668a653893","name":"name-354","routes":[{"guid":"1b72222a-46b3-443f-aba6-ab366ceae85e","host":"host-2","domain":{"guid":"bc16440a-99da-4524-b5f4-73de326530a6","name":"domain-8.example.com"}}],"running_instances":0,"services":[{"guid":"e4f2d82a-cb7d-441f-97f9-3afb458632d7","name":"name-356","bound_app_count":1,"dashboard_url":null,"service_plan":{"guid":"cab92852-d69e-4687-a23e-780775cddab2","name":"name-357","service":{"guid":"49839133-5496-40ed-a0fa-48f58d1e5a12","label":"label-18","provider":"provider-18","version":"version-2"}}}],"available_domains":[{"guid":"bc16440a-99da-4524-b5f4-73de326530a6","name":"domain-8.example.com","owning_organization_guid":"0ff11c88-c6d5-4aef-b22e-37d87707341e"},{"guid":"10e72d9a-9f21-4fdc-a17e-7a3c8f5dcdf9","name":"customer-app-domain1.com"},{"guid":"2a42f853-463e-4a7c-80fd-1a3c394a54c7","name":"customer-app-domain2.com"}],"name":"name-354","production":false,"space_guid":"bd4cb78d-944d-4f40-a6bc-92d5e518d8aa","stack_guid":"e63d9c44-8c88-4e48-afe5-85839798f257","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"67e706fa-dc24-432c-8b7e-0aa0f596cf1b","command":null,"console":false,"debug":null,"staging_task_id":null,"package_state":"PENDING","health_check_timeout":null,"staging_failed_reason":null,"docker_image":null,"package_updated_at":"2014-11-13T23:38:18+00:00","detected_start_command":""}