| 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.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NCIsImVtYWlsIjoiZW1haWwtMjQ3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNzd9.uPpnj1WJ7H3JgoDzgQ6fgp9Y2NMuTMpROt-j4dFwQRM Host: example.org Cookie:
GET /v2/apps
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NCIsImVtYWlsIjoiZW1haWwtMjQ3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNzd9.uPpnj1WJ7H3JgoDzgQ6fgp9Y2NMuTMpROt-j4dFwQRM" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: abd87bf8-87ac-4fb8-8efd-036052007b69 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": "54c5a3ef-88bc-4d3f-9ebf-c03b26cdf52a",
"url": "/v2/apps/54c5a3ef-88bc-4d3f-9ebf-c03b26cdf52a",
"created_at": "2015-02-10T01:42:57Z",
"updated_at": "2015-02-10T01:42:57Z"
},
"entity": {
"name": "name-1713",
"production": false,
"space_guid": "45e09f5f-7197-4c20-ba08-328c5d44db9b",
"stack_guid": "661d04a7-1d30-4f27-b223-59cedabe72a0",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "d4dc7ac7-1eeb-413d-87c3-857953997eb8",
"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-10T01:42:57Z",
"detected_start_command": "",
"space_url": "/v2/spaces/45e09f5f-7197-4c20-ba08-328c5d44db9b",
"stack_url": "/v2/stacks/661d04a7-1d30-4f27-b223-59cedabe72a0",
"events_url": "/v2/apps/54c5a3ef-88bc-4d3f-9ebf-c03b26cdf52a/events",
"service_bindings_url": "/v2/apps/54c5a3ef-88bc-4d3f-9ebf-c03b26cdf52a/service_bindings",
"routes_url": "/v2/apps/54c5a3ef-88bc-4d3f-9ebf-c03b26cdf52a/routes"
}
},
{
"metadata": {
"guid": "843cfd76-a6b1-40cf-a4f4-040f2a0985a9",
"url": "/v2/apps/843cfd76-a6b1-40cf-a4f4-040f2a0985a9",
"created_at": "2015-02-10T01:42:57Z",
"updated_at": "2015-02-10T01:42:57Z"
},
"entity": {
"name": "name-1708",
"production": false,
"space_guid": "634b2fbd-9eeb-4a5d-ad6d-8bdc46262a9b",
"stack_guid": "7a18437e-ba12-43c6-9804-38fadc6e557c",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "87d2c08c-80fb-4cef-82bb-e51a2656e239",
"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-10T01:42:57Z",
"detected_start_command": "",
"space_url": "/v2/spaces/634b2fbd-9eeb-4a5d-ad6d-8bdc46262a9b",
"stack_url": "/v2/stacks/7a18437e-ba12-43c6-9804-38fadc6e557c",
"events_url": "/v2/apps/843cfd76-a6b1-40cf-a4f4-040f2a0985a9/events",
"service_bindings_url": "/v2/apps/843cfd76-a6b1-40cf-a4f4-040f2a0985a9/service_bindings",
"routes_url": "/v2/apps/843cfd76-a6b1-40cf-a4f4-040f2a0985a9/routes"
}
},
{
"metadata": {
"guid": "cd8c87dd-1a98-4b5a-8424-dd827d3513b3",
"url": "/v2/apps/cd8c87dd-1a98-4b5a-8424-dd827d3513b3",
"created_at": "2015-02-10T01:42:57Z",
"updated_at": "2015-02-10T01:42:57Z"
},
"entity": {
"name": "name-1718",
"production": false,
"space_guid": "54d1a94f-2b71-4d09-90c4-bccda73589ac",
"stack_guid": "232115ca-95ee-40a9-bccd-72bdc9730f56",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "00d54fd5-14c2-4776-bba4-53b5e75e31df",
"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-10T01:42:57Z",
"detected_start_command": "",
"space_url": "/v2/spaces/54d1a94f-2b71-4d09-90c4-bccda73589ac",
"stack_url": "/v2/stacks/232115ca-95ee-40a9-bccd-72bdc9730f56",
"events_url": "/v2/apps/cd8c87dd-1a98-4b5a-8424-dd827d3513b3/events",
"service_bindings_url": "/v2/apps/cd8c87dd-1a98-4b5a-8424-dd827d3513b3/service_bindings",
"routes_url": "/v2/apps/cd8c87dd-1a98-4b5a-8424-dd827d3513b3/routes"
}
}
]
}