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, diego, stack_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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNiIsImVtYWlsIjoiZW1haWwtMTE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5ODZ9.LhCYlQkpR4_dlwi0azSsDSK9VNryJf_7ORJTrusOXcU Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNiIsImVtYWlsIjoiZW1haWwtMTE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5ODZ9.LhCYlQkpR4_dlwi0azSsDSK9VNryJf_7ORJTrusOXcU" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 3,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "68ca7ff3-eb9e-48b3-8fbf-6b4896a658e6",
"url": "/v2/apps/68ca7ff3-eb9e-48b3-8fbf-6b4896a658e6",
"created_at": "2015-05-21T01:03:06Z",
"updated_at": "2015-05-21T01:03:06Z"
},
"entity": {
"name": "name-619",
"production": false,
"space_guid": "32955471-5fd2-4bf9-9ccd-65f4dfb1cfb4",
"stack_guid": "a4158324-744c-45b8-8499-92cc9f6a1f7f",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "5e4710eb-0159-4e2f-8776-a2a04abcdad3",
"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-05-21T01:03:06Z",
"detected_start_command": "",
"enable_ssh": true,
"space_url": "/v2/spaces/32955471-5fd2-4bf9-9ccd-65f4dfb1cfb4",
"stack_url": "/v2/stacks/a4158324-744c-45b8-8499-92cc9f6a1f7f",
"events_url": "/v2/apps/68ca7ff3-eb9e-48b3-8fbf-6b4896a658e6/events",
"service_bindings_url": "/v2/apps/68ca7ff3-eb9e-48b3-8fbf-6b4896a658e6/service_bindings",
"routes_url": "/v2/apps/68ca7ff3-eb9e-48b3-8fbf-6b4896a658e6/routes"
}
},
{
"metadata": {
"guid": "a9bbd40f-c521-4e10-abf8-da11e1684e95",
"url": "/v2/apps/a9bbd40f-c521-4e10-abf8-da11e1684e95",
"created_at": "2015-05-21T01:03:06Z",
"updated_at": "2015-05-21T01:03:06Z"
},
"entity": {
"name": "name-609",
"production": false,
"space_guid": "69906895-21c1-45e0-83c1-be01b269820b",
"stack_guid": "fe26905a-bd53-4c5f-a2e4-7ea3169da508",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "984d5887-d9a1-430f-806f-d09e47cbd91f",
"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-05-21T01:03:06Z",
"detected_start_command": "",
"enable_ssh": true,
"space_url": "/v2/spaces/69906895-21c1-45e0-83c1-be01b269820b",
"stack_url": "/v2/stacks/fe26905a-bd53-4c5f-a2e4-7ea3169da508",
"events_url": "/v2/apps/a9bbd40f-c521-4e10-abf8-da11e1684e95/events",
"service_bindings_url": "/v2/apps/a9bbd40f-c521-4e10-abf8-da11e1684e95/service_bindings",
"routes_url": "/v2/apps/a9bbd40f-c521-4e10-abf8-da11e1684e95/routes"
}
},
{
"metadata": {
"guid": "b0b09c07-ecf4-4c9f-969c-152e145de776",
"url": "/v2/apps/b0b09c07-ecf4-4c9f-969c-152e145de776",
"created_at": "2015-05-21T01:03:06Z",
"updated_at": "2015-05-21T01:03:06Z"
},
"entity": {
"name": "name-614",
"production": false,
"space_guid": "f9695cce-3493-422a-b426-8046fc02ad01",
"stack_guid": "775bf377-2cf6-4f49-b77b-90fce995b013",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "84001a96-c36a-49f1-8f93-2541487f9faf",
"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-05-21T01:03:06Z",
"detected_start_command": "",
"enable_ssh": true,
"space_url": "/v2/spaces/f9695cce-3493-422a-b426-8046fc02ad01",
"stack_url": "/v2/stacks/775bf377-2cf6-4f49-b77b-90fce995b013",
"events_url": "/v2/apps/b0b09c07-ecf4-4c9f-969c-152e145de776/events",
"service_bindings_url": "/v2/apps/b0b09c07-ecf4-4c9f-969c-152e145de776/service_bindings",
"routes_url": "/v2/apps/b0b09c07-ecf4-4c9f-969c-152e145de776/routes"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: c60087d6-3e42-404f-b465-ff949f893716 Content-Length: 4749 X-Content-Type-Options: nosniff