Home
Version 3
Apps API

Apps API

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
  • STOPPED
  • STARTED
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
  • true
  • false
console Open the console port for the app (at $CONSOLE_PORT). false
  • true
  • false
debug Open the debug port for the app (at $DEBUG_PORT). false
  • true
  • false
package_state The current state of the package. One of PENDING, STAGED or FAILED.
  • PENDING
  • STAGED
  • 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

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNyIsImVtYWlsIjoiZW1haWwtMTQ4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzR9.Rjv0RI96rqMA-5ugi1YqIGf47x2CJi2bcff5hPbRp8Y
Host: example.org
Cookie:

Route

GET /v2/apps/ef6f0731-8b98-4d17-bf30-5e840c82d75e/summary

cURL

curl "https://api.[your-domain.com]/v2/apps/ef6f0731-8b98-4d17-bf30-5e840c82d75e/summary" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNyIsImVtYWlsIjoiZW1haWwtMTQ4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzR9.Rjv0RI96rqMA-5ugi1YqIGf47x2CJi2bcff5hPbRp8Y" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: febc86f7-c180-4dcc-aff0-81bf27618617
Content-Length: 1574
X-Content-Type-Options: nosniff

Status

200 OK

Body

{"guid":"ef6f0731-8b98-4d17-bf30-5e840c82d75e","name":"name-1353","routes":[{"guid":"cb4372fd-e7ff-425e-ad58-77e72ac3f5de","host":"host-12","domain":{"guid":"c509059b-d8f4-4617-b264-beb544d29ad4","name":"domain-42.example.com"}}],"running_instances":0,"services":[{"guid":"a7a4a615-cfa7-4b10-bb35-6f5f375e1754","name":"name-1355","bound_app_count":1,"state":"in progress","state_description":"state_description goes here","dashboard_url":null,"service_plan":{"guid":"17d0bd00-427f-4c21-b9b6-826b18492b93","name":"name-1356","service":{"guid":"5c73a48a-dbb4-4fff-9e64-54cfc32aa4e7","label":"label-50","provider":"provider-50","version":"version-34"}}}],"available_domains":[{"guid":"c509059b-d8f4-4617-b264-beb544d29ad4","name":"domain-42.example.com","owning_organization_guid":"c297a149-8c52-4310-ab2f-51aead6b8f46"},{"guid":"ccf9fe3a-f953-4c4e-977b-98a5282311e5","name":"customer-app-domain1.com"},{"guid":"105da5ad-e7c7-401d-851c-ad4aa7f002f6","name":"customer-app-domain2.com"}],"name":"name-1353","production":false,"space_guid":"043465ca-8356-4ba9-83fe-61c74c936268","stack_guid":"61550278-cc76-4a97-b132-e7519689a87a","buildpack":null,"detected_buildpack":null,"environment_json":null,"memory":1024,"instances":1,"disk_quota":1024,"state":"STOPPED","version":"856ef93e-6cc6-49a9-8901-a030f4180b84","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":"2015-01-27T19:14:34Z","detected_start_command":""}