Get App summary
GET /v2/apps/:guid/summary
Request
Route
GET /v2/apps/48f1c0cb-8620-4487-ad6d-8853656469b3/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/48f1c0cb-8620-4487-ad6d-8853656469b3/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyNyIsImVtYWlsIjoiZW1haWwtMTU4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1MjV9.gLHJyc8K-tLfkR7Tpbb7_n-Ds5auXfRDcRmaqsUvr0M" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{
"guid": "48f1c0cb-8620-4487-ad6d-8853656469b3",
"name": "name-1827",
"routes": [
{
"guid": "acabd696-ef02-4f54-89f8-befc4717876f",
"host": "host-13",
"domain": {
"guid": "11430e5f-3de9-4f72-bf13-ba037bad9893",
"name": "domain-28.example.com"
}
}
],
"running_instances": 0,
"services": [
{
"guid": "3e74ec1f-a648-4755-98c5-a245b4ec210e",
"name": "name-1829",
"bound_app_count": 1,
"last_operation": null,
"dashboard_url": null,
"service_plan": {
"guid": "88a5a9c3-a443-4fba-9c7f-e2d157c74a84",
"name": "name-1830",
"service": {
"guid": "2233cbd0-8a5a-4322-91ad-76a6391ccd2d",
"label": "label-45",
"provider": null,
"version": null
}
}
}
],
"available_domains": [
{
"guid": "11430e5f-3de9-4f72-bf13-ba037bad9893",
"name": "domain-28.example.com",
"owning_organization_guid": "c2668ca8-153f-492b-a424-be529feeca77"
},
{
"guid": "f01b174d-c750-46b0-9ddf-3aeb2064d796",
"name": "customer-app-domain1.com",
"router_group_guid": null
},
{
"guid": "3595f6cb-81cf-424e-a546-533877ccccfd",
"name": "customer-app-domain2.com",
"router_group_guid": null
}
],
"production": false,
"space_guid": "4a06f139-15ed-4cf4-8435-43fc64b15e23",
"stack_guid": "c1801894-aeff-4b85-858f-9c0dbc58bb4a",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "f364a9f9-561b-4448-9f92-7491e052646b",
"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,
"staging_failed_description": null,
"diego": false,
"docker_image": null,
"package_updated_at": "2015-11-30T23:38:45Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"ports": null
}
Headers