| 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 |
|
|
|
| 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 |
|
|
| 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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OSIsImVtYWlsIjoiZW1haWwtMjA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzZ9.Y6l235bWjLnb9ALmOntf3Oo_P0jSt-HQSEr36HAy1R4 Host: example.org Cookie:
GET /v2/apps
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OSIsImVtYWlsIjoiZW1haWwtMjA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzZ9.Y6l235bWjLnb9ALmOntf3Oo_P0jSt-HQSEr36HAy1R4" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 23ee640e-bce9-47a0-8a82-881e26d2babe Content-Length: 4596 X-Content-Type-Options: nosniff
200 OK
{
"total_results": 3,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "2306b1e2-02fd-4c76-bc1c-84ac01e56243",
"url": "/v2/apps/2306b1e2-02fd-4c76-bc1c-84ac01e56243",
"created_at": "2015-02-12T01:42:16Z",
"updated_at": "2015-02-12T01:42:16Z"
},
"entity": {
"name": "name-1596",
"production": false,
"space_guid": "08995a0f-1ea2-4f25-b385-cbff5bcbdf80",
"stack_guid": "dfd7ac19-d438-4ff5-b754-f976610500e0",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "e58339f9-6cf5-4a0d-8a1a-40bd99324e99",
"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,
"docker_image": null,
"package_updated_at": "2015-02-12T01:42:16Z",
"detected_start_command": "",
"space_url": "/v2/spaces/08995a0f-1ea2-4f25-b385-cbff5bcbdf80",
"stack_url": "/v2/stacks/dfd7ac19-d438-4ff5-b754-f976610500e0",
"events_url": "/v2/apps/2306b1e2-02fd-4c76-bc1c-84ac01e56243/events",
"service_bindings_url": "/v2/apps/2306b1e2-02fd-4c76-bc1c-84ac01e56243/service_bindings",
"routes_url": "/v2/apps/2306b1e2-02fd-4c76-bc1c-84ac01e56243/routes"
}
},
{
"metadata": {
"guid": "3f5db2d2-6694-4edc-b36d-cded87f7ea66",
"url": "/v2/apps/3f5db2d2-6694-4edc-b36d-cded87f7ea66",
"created_at": "2015-02-12T01:42:16Z",
"updated_at": "2015-02-12T01:42:16Z"
},
"entity": {
"name": "name-1591",
"production": false,
"space_guid": "bbd8d6e4-ceb9-406b-b4ca-8dac50bb9fef",
"stack_guid": "21f743e8-376d-41ac-afb3-a598df703fc3",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "345c1a91-40bc-4e86-b0b6-0f2cdc9f9dbf",
"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,
"docker_image": null,
"package_updated_at": "2015-02-12T01:42:16Z",
"detected_start_command": "",
"space_url": "/v2/spaces/bbd8d6e4-ceb9-406b-b4ca-8dac50bb9fef",
"stack_url": "/v2/stacks/21f743e8-376d-41ac-afb3-a598df703fc3",
"events_url": "/v2/apps/3f5db2d2-6694-4edc-b36d-cded87f7ea66/events",
"service_bindings_url": "/v2/apps/3f5db2d2-6694-4edc-b36d-cded87f7ea66/service_bindings",
"routes_url": "/v2/apps/3f5db2d2-6694-4edc-b36d-cded87f7ea66/routes"
}
},
{
"metadata": {
"guid": "49975c72-5e0d-4d51-a2ab-0fa4a3a44bcc",
"url": "/v2/apps/49975c72-5e0d-4d51-a2ab-0fa4a3a44bcc",
"created_at": "2015-02-12T01:42:16Z",
"updated_at": "2015-02-12T01:42:16Z"
},
"entity": {
"name": "name-1601",
"production": false,
"space_guid": "5df6877e-7158-4a5a-b0ca-2a9d8ec58063",
"stack_guid": "628b5144-bacb-4822-b8af-5a6d5796edd4",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "d1123f50-9872-4c4b-aa37-b06edcd098aa",
"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,
"docker_image": null,
"package_updated_at": "2015-02-12T01:42:16Z",
"detected_start_command": "",
"space_url": "/v2/spaces/5df6877e-7158-4a5a-b0ca-2a9d8ec58063",
"stack_url": "/v2/stacks/628b5144-bacb-4822-b8af-5a6d5796edd4",
"events_url": "/v2/apps/49975c72-5e0d-4d51-a2ab-0fa4a3a44bcc/events",
"service_bindings_url": "/v2/apps/49975c72-5e0d-4d51-a2ab-0fa4a3a44bcc/service_bindings",
"routes_url": "/v2/apps/49975c72-5e0d-4d51-a2ab-0fa4a3a44bcc/routes"
}
}
]
}