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 |
|
|
|
| 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.eyJ1c2VyX2lkIjoidWFhLWlkLTI4OSIsImVtYWlsIjoiZW1haWwtMjE3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2NDF9.yKjtu765UBD81BnA6mjiL4VaH2_AfE2XbTPLTSJwqDs Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4OSIsImVtYWlsIjoiZW1haWwtMjE3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2NDF9.yKjtu765UBD81BnA6mjiL4VaH2_AfE2XbTPLTSJwqDs" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 3,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "74ce7f13-a68c-43bb-b0ae-3cf06a79821e",
"url": "/v2/apps/74ce7f13-a68c-43bb-b0ae-3cf06a79821e",
"created_at": "2015-05-07T23:37:21Z",
"updated_at": "2015-05-07T23:37:21Z"
},
"entity": {
"name": "name-1772",
"production": false,
"space_guid": "75416fd2-de0c-4647-ab5f-ea5961583454",
"stack_guid": "69b77cfc-10dc-47b1-87ee-1b70e7b8b9a3",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "ee34c90f-7c7b-425c-bf7f-3bf62e597b23",
"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-05-07T23:37:21Z",
"detected_start_command": "",
"enable_ssh": true,
"space_url": "/v2/spaces/75416fd2-de0c-4647-ab5f-ea5961583454",
"stack_url": "/v2/stacks/69b77cfc-10dc-47b1-87ee-1b70e7b8b9a3",
"events_url": "/v2/apps/74ce7f13-a68c-43bb-b0ae-3cf06a79821e/events",
"service_bindings_url": "/v2/apps/74ce7f13-a68c-43bb-b0ae-3cf06a79821e/service_bindings",
"routes_url": "/v2/apps/74ce7f13-a68c-43bb-b0ae-3cf06a79821e/routes"
}
},
{
"metadata": {
"guid": "9dafb72e-bcd3-47b5-95e8-a574d8ca542a",
"url": "/v2/apps/9dafb72e-bcd3-47b5-95e8-a574d8ca542a",
"created_at": "2015-05-07T23:37:21Z",
"updated_at": "2015-05-07T23:37:21Z"
},
"entity": {
"name": "name-1762",
"production": false,
"space_guid": "751293b0-28b3-4de7-8ee0-fec4a23b8b30",
"stack_guid": "05e066f1-cc86-47f1-a71a-3987de358bcf",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "fc1bba37-8151-4b7f-a7ae-38200ce8cbe3",
"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-05-07T23:37:21Z",
"detected_start_command": "",
"enable_ssh": true,
"space_url": "/v2/spaces/751293b0-28b3-4de7-8ee0-fec4a23b8b30",
"stack_url": "/v2/stacks/05e066f1-cc86-47f1-a71a-3987de358bcf",
"events_url": "/v2/apps/9dafb72e-bcd3-47b5-95e8-a574d8ca542a/events",
"service_bindings_url": "/v2/apps/9dafb72e-bcd3-47b5-95e8-a574d8ca542a/service_bindings",
"routes_url": "/v2/apps/9dafb72e-bcd3-47b5-95e8-a574d8ca542a/routes"
}
},
{
"metadata": {
"guid": "fd476eff-3e61-463f-81ea-d86877e29cbd",
"url": "/v2/apps/fd476eff-3e61-463f-81ea-d86877e29cbd",
"created_at": "2015-05-07T23:37:21Z",
"updated_at": "2015-05-07T23:37:21Z"
},
"entity": {
"name": "name-1767",
"production": false,
"space_guid": "d4739dc9-55e0-4578-8138-1ce094a6f790",
"stack_guid": "eb39e826-082f-4dbe-9118-b3bf368220bf",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "3c7f4fe0-46ef-4e06-8eb8-6442d80318ee",
"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-05-07T23:37:21Z",
"detected_start_command": "",
"enable_ssh": true,
"space_url": "/v2/spaces/d4739dc9-55e0-4578-8138-1ce094a6f790",
"stack_url": "/v2/stacks/eb39e826-082f-4dbe-9118-b3bf368220bf",
"events_url": "/v2/apps/fd476eff-3e61-463f-81ea-d86877e29cbd/events",
"service_bindings_url": "/v2/apps/fd476eff-3e61-463f-81ea-d86877e29cbd/service_bindings",
"routes_url": "/v2/apps/fd476eff-3e61-463f-81ea-d86877e29cbd/routes"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 21377f07-9f74-49e0-9dc5-f592d0372bb6 Content-Length: 4752 X-Content-Type-Options: nosniff