Get App summary
GET /v2/apps/:guid/summary
Request
Route
GET /v2/apps/f9e77323-a13c-41ab-9641-9a5d2cbabb1d/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/f9e77323-a13c-41ab-9641-9a5d2cbabb1d/summary" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyMSIsImVtYWlsIjoiZW1haWwtMTQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3MTd9.9P1pPCckte9fjMxw1qY1s5aRgTbYbO-QXYP0fP5Qe34" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{
"guid": "f9e77323-a13c-41ab-9641-9a5d2cbabb1d",
"name": "name-1549",
"routes": [
{
"guid": "1a393e14-b12c-4b66-949d-0a89d72b7a74",
"host": "host-16",
"port": null,
"path": "",
"domain": {
"guid": "d9c378ac-ecbc-4f66-b2a0-0bee11f04e70",
"name": "domain-64.example.com"
}
}
],
"running_instances": 0,
"services": [
{
"guid": "245af8ff-b832-44b0-9b2c-660d18544952",
"name": "name-1552",
"bound_app_count": 1,
"last_operation": null,
"dashboard_url": null,
"service_plan": {
"guid": "48f1fd99-22d6-4aaa-9675-f50a9f4c5d55",
"name": "name-1553",
"service": {
"guid": "d1406438-9f37-442a-928c-3a30027b80fd",
"label": "label-43",
"provider": null,
"version": null
}
}
}
],
"available_domains": [
{
"guid": "d9c378ac-ecbc-4f66-b2a0-0bee11f04e70",
"name": "domain-64.example.com",
"owning_organization_guid": "6c3050f6-8f39-41cf-90c5-3a537e801e5a"
},
{
"guid": "7267b8d0-eb52-451e-a78e-a6c3f681f7ec",
"name": "customer-app-domain1.com",
"router_group_guid": null,
"router_group_type": null
},
{
"guid": "29ffa9f8-9bee-454f-899b-d5ca17bc8c90",
"name": "customer-app-domain2.com",
"router_group_guid": null,
"router_group_type": null
}
],
"production": false,
"space_guid": "1241485e-4bef-4878-8af9-84c5e485aa5d",
"stack_guid": "1cde8bb8-6386-4d4e-9756-e9eea740f03f",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "cda66064-7959-4b42-84a2-fc816123ca51",
"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": "2016-05-12T00:45:16Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"ports": null
}
Headers