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 |
|
|
| 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.eyJ1c2VyX2lkIjoidWFhLWlkLTMzMiIsImVtYWlsIjoiZW1haWwtMjM0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2NzV9.BFHO3bKYC3M1SsmK_wQD0pyuQDKcLToV-rPofdube9A Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzMiIsImVtYWlsIjoiZW1haWwtMjM0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2NzV9.BFHO3bKYC3M1SsmK_wQD0pyuQDKcLToV-rPofdube9A" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 3,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "290d5e2d-8384-45d5-9bf9-4df14eb453d9",
"url": "/v2/apps/290d5e2d-8384-45d5-9bf9-4df14eb453d9",
"created_at": "2015-03-03T00:51:15Z",
"updated_at": "2015-03-03T00:51:15Z"
},
"entity": {
"name": "name-1774",
"production": false,
"space_guid": "c0e404bb-7856-4835-b0ec-89d9d3f41c7f",
"stack_guid": "aa317121-fbee-4064-af91-73e869d27458",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "a3c94305-94b4-4de8-a5d9-be0235e21aa0",
"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-03-03T00:51:15Z",
"detected_start_command": "",
"space_url": "/v2/spaces/c0e404bb-7856-4835-b0ec-89d9d3f41c7f",
"stack_url": "/v2/stacks/aa317121-fbee-4064-af91-73e869d27458",
"events_url": "/v2/apps/290d5e2d-8384-45d5-9bf9-4df14eb453d9/events",
"service_bindings_url": "/v2/apps/290d5e2d-8384-45d5-9bf9-4df14eb453d9/service_bindings",
"routes_url": "/v2/apps/290d5e2d-8384-45d5-9bf9-4df14eb453d9/routes"
}
},
{
"metadata": {
"guid": "70058015-50aa-4e6e-b081-f375e9880722",
"url": "/v2/apps/70058015-50aa-4e6e-b081-f375e9880722",
"created_at": "2015-03-03T00:51:15Z",
"updated_at": "2015-03-03T00:51:15Z"
},
"entity": {
"name": "name-1769",
"production": false,
"space_guid": "b560040f-7235-49c1-95f7-aff1af3e8332",
"stack_guid": "6fe5a8b9-1129-434b-b76f-502fbaae1718",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "bbf3b140-8e59-40b2-8390-e0df107731ba",
"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-03-03T00:51:15Z",
"detected_start_command": "",
"space_url": "/v2/spaces/b560040f-7235-49c1-95f7-aff1af3e8332",
"stack_url": "/v2/stacks/6fe5a8b9-1129-434b-b76f-502fbaae1718",
"events_url": "/v2/apps/70058015-50aa-4e6e-b081-f375e9880722/events",
"service_bindings_url": "/v2/apps/70058015-50aa-4e6e-b081-f375e9880722/service_bindings",
"routes_url": "/v2/apps/70058015-50aa-4e6e-b081-f375e9880722/routes"
}
},
{
"metadata": {
"guid": "8747dc50-39f8-442f-81db-10c277f8708e",
"url": "/v2/apps/8747dc50-39f8-442f-81db-10c277f8708e",
"created_at": "2015-03-03T00:51:15Z",
"updated_at": "2015-03-03T00:51:15Z"
},
"entity": {
"name": "name-1779",
"production": false,
"space_guid": "fdb49c8d-b6cd-4f96-8772-a2fd8ecfa6a5",
"stack_guid": "9c6f2af5-c2df-41c6-9318-66396142b821",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "87085f76-36dd-49b4-8132-df1c71fe92d6",
"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-03-03T00:51:15Z",
"detected_start_command": "",
"space_url": "/v2/spaces/fdb49c8d-b6cd-4f96-8772-a2fd8ecfa6a5",
"stack_url": "/v2/stacks/9c6f2af5-c2df-41c6-9318-66396142b821",
"events_url": "/v2/apps/8747dc50-39f8-442f-81db-10c277f8708e/events",
"service_bindings_url": "/v2/apps/8747dc50-39f8-442f-81db-10c277f8708e/service_bindings",
"routes_url": "/v2/apps/8747dc50-39f8-442f-81db-10c277f8708e/routes"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: a6239bbe-fe7f-4091-9c97-44cee5939801 Content-Length: 4668 X-Content-Type-Options: nosniff