GET /v2/apps
| Name | Description | Valid Values | Example Values |
|---|---|---|---|
| q |
Parameters used to filter the result set. Format queries as <filter><op><value> Valid ops: : >= <= < > IN Valid filters: name, space_guid, organization_guid, diego, stack_guid |
|
|
| page | Page of results to fetch |
|
|
| results-per-page | Number of results per page |
|
|
| order-direction | Order of the results: asc (default) or desc |
|
|
| inline-relations-depth | 0 - don't inline any relations and return URLs. Otherwise, inline to depth N. |
|
|
| orphan-relations | 0 - de-duplicate object entries in response |
|
|
| exclude-relations | comma-delimited list of relations to drop from response |
|
|
| include-relations | comma-delimited list of the only relations to include in response |
|
|
| Name | Description | Default | Valid Values | Example Values |
|---|---|---|---|---|
| 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. To ensure optimal availability, ensure there are at least 2 instances. |
|
|
|
| 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 desired state of the app. One of STOPPED or STARTED. | STOPPED |
|
|
| detected_start_command | The command detected by the buildpack during staging. |
|
|
|
| command | The command to start an app after it is staged, maximum length: 4096 (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_type | Type of health check to perform. | port |
|
|
| health_check_timeout | Timeout for health checking of an staged app when starting up |
|
|
|
| diego | Use diego to stage and to run when available | false |
|
|
| docker_image | Name of the Docker image containing the app |
|
|
|
| docker_credentials_json | Docker credentials for pulling docker image. | {} |
|
|
| environment_json | Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables. |
|
|
|
| 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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYiLCJlbWFpbCI6ImVtYWlsLTZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzNTEwMjg0M30.KWNrbWuLjNcliUwRhxrZoPIMZTU4xX_JBIs8pKJD2TI Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYiLCJlbWFpbCI6ImVtYWlsLTZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzNTEwMjg0M30.KWNrbWuLjNcliUwRhxrZoPIMZTU4xX_JBIs8pKJD2TI" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 3,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "0b576d0d-c97d-4906-b0c1-34bbddf969ce",
"url": "/v2/apps/0b576d0d-c97d-4906-b0c1-34bbddf969ce",
"created_at": "2015-06-16T23:40:43Z",
"updated_at": "2015-06-16T23:40:43Z"
},
"entity": {
"name": "name-91",
"production": false,
"space_guid": "05b7be1c-4ac7-45e0-a21c-ec13b12cf353",
"stack_guid": "c465f16f-ae8d-4375-b0e5-47dda671b53d",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "ca654a2e-2d58-4440-8642-ddb2ea126fd1",
"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,
"diego": false,
"docker_image": null,
"package_updated_at": "2015-06-16T23:40:43Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"space_url": "/v2/spaces/05b7be1c-4ac7-45e0-a21c-ec13b12cf353",
"stack_url": "/v2/stacks/c465f16f-ae8d-4375-b0e5-47dda671b53d",
"events_url": "/v2/apps/0b576d0d-c97d-4906-b0c1-34bbddf969ce/events",
"service_bindings_url": "/v2/apps/0b576d0d-c97d-4906-b0c1-34bbddf969ce/service_bindings",
"routes_url": "/v2/apps/0b576d0d-c97d-4906-b0c1-34bbddf969ce/routes"
}
},
{
"metadata": {
"guid": "0d615e43-bb63-44f7-973a-0e37328093cb",
"url": "/v2/apps/0d615e43-bb63-44f7-973a-0e37328093cb",
"created_at": "2015-06-16T23:40:43Z",
"updated_at": "2015-06-16T23:40:43Z"
},
"entity": {
"name": "name-96",
"production": false,
"space_guid": "875d2b02-abf8-4e93-bf63-fd68c9d49d4f",
"stack_guid": "c3dac60c-7a6e-45fe-b653-d7b9adf0389a",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "437a218d-9cdf-4793-a661-8ce618076fbc",
"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,
"diego": false,
"docker_image": null,
"package_updated_at": "2015-06-16T23:40:43Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"space_url": "/v2/spaces/875d2b02-abf8-4e93-bf63-fd68c9d49d4f",
"stack_url": "/v2/stacks/c3dac60c-7a6e-45fe-b653-d7b9adf0389a",
"events_url": "/v2/apps/0d615e43-bb63-44f7-973a-0e37328093cb/events",
"service_bindings_url": "/v2/apps/0d615e43-bb63-44f7-973a-0e37328093cb/service_bindings",
"routes_url": "/v2/apps/0d615e43-bb63-44f7-973a-0e37328093cb/routes"
}
},
{
"metadata": {
"guid": "9556460d-08fc-475a-a3c5-bc7bfa5215fb",
"url": "/v2/apps/9556460d-08fc-475a-a3c5-bc7bfa5215fb",
"created_at": "2015-06-16T23:40:43Z",
"updated_at": "2015-06-16T23:40:43Z"
},
"entity": {
"name": "name-101",
"production": false,
"space_guid": "093d530c-41d3-4acb-a991-c4a41bfd0e85",
"stack_guid": "7a2d7fb3-f495-4997-837e-5ab27e49d0f3",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "aed324bd-311b-4715-9db0-381a64f8eaac",
"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,
"diego": false,
"docker_image": null,
"package_updated_at": "2015-06-16T23:40:43Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"space_url": "/v2/spaces/093d530c-41d3-4acb-a991-c4a41bfd0e85",
"stack_url": "/v2/stacks/7a2d7fb3-f495-4997-837e-5ab27e49d0f3",
"events_url": "/v2/apps/9556460d-08fc-475a-a3c5-bc7bfa5215fb/events",
"service_bindings_url": "/v2/apps/9556460d-08fc-475a-a3c5-bc7bfa5215fb/service_bindings",
"routes_url": "/v2/apps/9556460d-08fc-475a-a3c5-bc7bfa5215fb/routes"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: fba4dc1f-bee5-4343-8228-9443760b1bda Content-Length: 5053 X-Content-Type-Options: nosniff