| 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 (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_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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OSIsImVtYWlsIjoiZW1haWwtMTk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDl9.9lzRDdxxEcg7-yxOugmnzMLrKtk56r-89b3cE-MJi80 Host: example.org Cookie:
GET /v2/apps
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OSIsImVtYWlsIjoiZW1haWwtMTk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDl9.9lzRDdxxEcg7-yxOugmnzMLrKtk56r-89b3cE-MJi80" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 945247ee-142f-4880-9b11-171710851e6e Content-Length: 4527 X-Content-Type-Options: nosniff
200 OK
{
"total_results": 3,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "5b97e55c-a0b9-4a70-99d4-b0b77e010027",
"url": "/v2/apps/5b97e55c-a0b9-4a70-99d4-b0b77e010027",
"created_at": "2014-11-13T23:38:29+00:00",
"updated_at": "2014-11-13T23:38:29+00:00"
},
"entity": {
"name": "name-947",
"production": false,
"space_guid": "87b78710-d548-4219-9aac-2aad362c4981",
"stack_guid": "2fa2420c-9e3a-4061-8691-72976f36f194",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "2dcecde6-53a9-40af-9ae8-6bf83ee07e64",
"command": null,
"console": false,
"debug": null,
"staging_task_id": null,
"package_state": "PENDING",
"health_check_timeout": null,
"staging_failed_reason": null,
"docker_image": null,
"package_updated_at": "2014-11-13T23:38:29+00:00",
"detected_start_command": "",
"space_url": "/v2/spaces/87b78710-d548-4219-9aac-2aad362c4981",
"stack_url": "/v2/stacks/2fa2420c-9e3a-4061-8691-72976f36f194",
"events_url": "/v2/apps/5b97e55c-a0b9-4a70-99d4-b0b77e010027/events",
"service_bindings_url": "/v2/apps/5b97e55c-a0b9-4a70-99d4-b0b77e010027/service_bindings",
"routes_url": "/v2/apps/5b97e55c-a0b9-4a70-99d4-b0b77e010027/routes"
}
},
{
"metadata": {
"guid": "70f87afa-91fc-4680-82a4-f8d0818df1d4",
"url": "/v2/apps/70f87afa-91fc-4680-82a4-f8d0818df1d4",
"created_at": "2014-11-13T23:38:29+00:00",
"updated_at": "2014-11-13T23:38:29+00:00"
},
"entity": {
"name": "name-942",
"production": false,
"space_guid": "71d310ca-68b7-413e-8ba8-f595b835c162",
"stack_guid": "a80f89b5-d8c7-453e-bf13-0fad034d0266",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "220462af-b7e7-407f-b650-30393260e475",
"command": null,
"console": false,
"debug": null,
"staging_task_id": null,
"package_state": "PENDING",
"health_check_timeout": null,
"staging_failed_reason": null,
"docker_image": null,
"package_updated_at": "2014-11-13T23:38:29+00:00",
"detected_start_command": "",
"space_url": "/v2/spaces/71d310ca-68b7-413e-8ba8-f595b835c162",
"stack_url": "/v2/stacks/a80f89b5-d8c7-453e-bf13-0fad034d0266",
"events_url": "/v2/apps/70f87afa-91fc-4680-82a4-f8d0818df1d4/events",
"service_bindings_url": "/v2/apps/70f87afa-91fc-4680-82a4-f8d0818df1d4/service_bindings",
"routes_url": "/v2/apps/70f87afa-91fc-4680-82a4-f8d0818df1d4/routes"
}
},
{
"metadata": {
"guid": "b26493a5-ed9b-4278-8c6e-98bfaa8af410",
"url": "/v2/apps/b26493a5-ed9b-4278-8c6e-98bfaa8af410",
"created_at": "2014-11-13T23:38:29+00:00",
"updated_at": "2014-11-13T23:38:29+00:00"
},
"entity": {
"name": "name-937",
"production": false,
"space_guid": "1f1cc163-4509-45a7-9f7b-4d2fd9f70540",
"stack_guid": "3b7f9010-cdc2-4892-a980-b5e2c7ca023f",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "6709c5bd-b1f6-4de3-a495-0adacb4a84d3",
"command": null,
"console": false,
"debug": null,
"staging_task_id": null,
"package_state": "PENDING",
"health_check_timeout": null,
"staging_failed_reason": null,
"docker_image": null,
"package_updated_at": "2014-11-13T23:38:29+00:00",
"detected_start_command": "",
"space_url": "/v2/spaces/1f1cc163-4509-45a7-9f7b-4d2fd9f70540",
"stack_url": "/v2/stacks/3b7f9010-cdc2-4892-a980-b5e2c7ca023f",
"events_url": "/v2/apps/b26493a5-ed9b-4278-8c6e-98bfaa8af410/events",
"service_bindings_url": "/v2/apps/b26493a5-ed9b-4278-8c6e-98bfaa8af410/service_bindings",
"routes_url": "/v2/apps/b26493a5-ed9b-4278-8c6e-98bfaa8af410/routes"
}
}
]
}