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.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNiIsImVtYWlsIjoiZW1haWwtMjMxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjl9.FIze-gH7k66gSbkIa64Rrdw1VmKcKcRaqAL3zpJiCzY Host: example.org Cookie:
GET /v2/apps
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNiIsImVtYWlsIjoiZW1haWwtMjMxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTc0NjIzNjl9.FIze-gH7k66gSbkIa64Rrdw1VmKcKcRaqAL3zpJiCzY" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 2728465c-54de-45ad-962a-1d00dfbb6700 Content-Length: 4530 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "54e9d84d-00fb-452d-bbd1-d9da1c4e5958", "url": "/v2/apps/54e9d84d-00fb-452d-bbd1-d9da1c4e5958", "created_at": "2014-11-24T19:32:49+00:00", "updated_at": "2014-11-24T19:32:49+00:00" }, "entity": { "name": "name-1084", "production": false, "space_guid": "e8a8a486-5053-4c4c-9fc7-b4849df74f1f", "stack_guid": "ed185dd1-4dad-41e9-9264-e600c7f59462", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "8999cd6b-ef84-49a7-bc8a-89f0c3c63334", "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-24T19:32:49+00:00", "detected_start_command": "", "space_url": "/v2/spaces/e8a8a486-5053-4c4c-9fc7-b4849df74f1f", "stack_url": "/v2/stacks/ed185dd1-4dad-41e9-9264-e600c7f59462", "events_url": "/v2/apps/54e9d84d-00fb-452d-bbd1-d9da1c4e5958/events", "service_bindings_url": "/v2/apps/54e9d84d-00fb-452d-bbd1-d9da1c4e5958/service_bindings", "routes_url": "/v2/apps/54e9d84d-00fb-452d-bbd1-d9da1c4e5958/routes" } }, { "metadata": { "guid": "5a4f999e-95a8-44e2-bb39-61e1e0dca499", "url": "/v2/apps/5a4f999e-95a8-44e2-bb39-61e1e0dca499", "created_at": "2014-11-24T19:32:49+00:00", "updated_at": "2014-11-24T19:32:49+00:00" }, "entity": { "name": "name-1089", "production": false, "space_guid": "912c7ed6-5e78-46fa-9155-26301fa349b9", "stack_guid": "4a449b46-81ca-4fea-a935-6c0ca1e56ba3", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "74915a42-3cca-4c53-8cba-a978b146b393", "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-24T19:32:49+00:00", "detected_start_command": "", "space_url": "/v2/spaces/912c7ed6-5e78-46fa-9155-26301fa349b9", "stack_url": "/v2/stacks/4a449b46-81ca-4fea-a935-6c0ca1e56ba3", "events_url": "/v2/apps/5a4f999e-95a8-44e2-bb39-61e1e0dca499/events", "service_bindings_url": "/v2/apps/5a4f999e-95a8-44e2-bb39-61e1e0dca499/service_bindings", "routes_url": "/v2/apps/5a4f999e-95a8-44e2-bb39-61e1e0dca499/routes" } }, { "metadata": { "guid": "c7de1e2a-9864-4837-a395-308ed078151c", "url": "/v2/apps/c7de1e2a-9864-4837-a395-308ed078151c", "created_at": "2014-11-24T19:32:49+00:00", "updated_at": "2014-11-24T19:32:49+00:00" }, "entity": { "name": "name-1079", "production": false, "space_guid": "fc9bb47d-5ed1-4b26-92b3-42e7dc36b6f5", "stack_guid": "84774e84-cbcf-4e51-81e1-6d59e6f1d4e8", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "6d1ee9cc-5e19-46f1-80f7-da9c3515ac50", "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-24T19:32:49+00:00", "detected_start_command": "", "space_url": "/v2/spaces/fc9bb47d-5ed1-4b26-92b3-42e7dc36b6f5", "stack_url": "/v2/stacks/84774e84-cbcf-4e51-81e1-6d59e6f1d4e8", "events_url": "/v2/apps/c7de1e2a-9864-4837-a395-308ed078151c/events", "service_bindings_url": "/v2/apps/c7de1e2a-9864-4837-a395-308ed078151c/service_bindings", "routes_url": "/v2/apps/c7de1e2a-9864-4837-a395-308ed078151c/routes" } } ] }