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 |
|
|
|
| docker_credentials_json | Docker credentials for pulling docker image. | {} |
|
|
| 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 |
|
|
| staging_failed_reason | Reason for application staging failures |
|
|
|
| staging_failed_description | Detailed description for the staging_failed_reason |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxNCIsImVtYWlsIjoiZW1haWwtMjMxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk3OTZ9.lOAIDHm5fsWE5dGq5ZTppfYhwn0j0Sn3RRY1mZS3nag Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxNCIsImVtYWlsIjoiZW1haWwtMjMxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk3OTZ9.lOAIDHm5fsWE5dGq5ZTppfYhwn0j0Sn3RRY1mZS3nag" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{
"total_results": 3,
"total_pages": 1,
"prev_url": null,
"next_url": null,
"resources": [
{
"metadata": {
"guid": "9715a863-c10f-4356-b6e0-770a7fd5452f",
"url": "/v2/apps/9715a863-c10f-4356-b6e0-770a7fd5452f",
"created_at": "2015-07-06T23:23:16Z",
"updated_at": "2015-07-06T23:23:16Z"
},
"entity": {
"name": "name-1996",
"production": false,
"space_guid": "39e5b5e3-15e9-46af-8e76-7de5a82cb761",
"stack_guid": "47f9764c-e623-4526-80f5-5f8711060074",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "034aae95-67cc-4fc5-901f-24e23254d341",
"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,
"staging_failed_description": null,
"diego": false,
"docker_image": null,
"package_updated_at": "2015-07-06T23:23:16Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"space_url": "/v2/spaces/39e5b5e3-15e9-46af-8e76-7de5a82cb761",
"stack_url": "/v2/stacks/47f9764c-e623-4526-80f5-5f8711060074",
"events_url": "/v2/apps/9715a863-c10f-4356-b6e0-770a7fd5452f/events",
"service_bindings_url": "/v2/apps/9715a863-c10f-4356-b6e0-770a7fd5452f/service_bindings",
"routes_url": "/v2/apps/9715a863-c10f-4356-b6e0-770a7fd5452f/routes"
}
},
{
"metadata": {
"guid": "a32b4c5a-5468-4bd1-a3a5-a7870aa045ea",
"url": "/v2/apps/a32b4c5a-5468-4bd1-a3a5-a7870aa045ea",
"created_at": "2015-07-06T23:23:16Z",
"updated_at": "2015-07-06T23:23:16Z"
},
"entity": {
"name": "name-2001",
"production": false,
"space_guid": "44c5b28f-a54a-4874-b764-8c1c630ab28c",
"stack_guid": "a3a8ea8c-a4ca-4cb0-8daf-ac75b430e8fb",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "b8d0bb1b-8933-4b44-b11e-44dc7a0ac725",
"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,
"staging_failed_description": null,
"diego": false,
"docker_image": null,
"package_updated_at": "2015-07-06T23:23:16Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"space_url": "/v2/spaces/44c5b28f-a54a-4874-b764-8c1c630ab28c",
"stack_url": "/v2/stacks/a3a8ea8c-a4ca-4cb0-8daf-ac75b430e8fb",
"events_url": "/v2/apps/a32b4c5a-5468-4bd1-a3a5-a7870aa045ea/events",
"service_bindings_url": "/v2/apps/a32b4c5a-5468-4bd1-a3a5-a7870aa045ea/service_bindings",
"routes_url": "/v2/apps/a32b4c5a-5468-4bd1-a3a5-a7870aa045ea/routes"
}
},
{
"metadata": {
"guid": "e61c49ac-cd17-410b-9a04-a7596dde9bf0",
"url": "/v2/apps/e61c49ac-cd17-410b-9a04-a7596dde9bf0",
"created_at": "2015-07-06T23:23:16Z",
"updated_at": "2015-07-06T23:23:16Z"
},
"entity": {
"name": "name-1991",
"production": false,
"space_guid": "b27a65f3-ba00-406f-aa7a-e9c46b739a7c",
"stack_guid": "f5705a92-addd-4986-9506-5b03e0fd77e4",
"buildpack": null,
"detected_buildpack": null,
"environment_json": null,
"memory": 1024,
"instances": 1,
"disk_quota": 1024,
"state": "STOPPED",
"version": "5efa6131-9999-44b7-b0b4-8dfa1e112f3f",
"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,
"staging_failed_description": null,
"diego": false,
"docker_image": null,
"package_updated_at": "2015-07-06T23:23:16Z",
"detected_start_command": "",
"enable_ssh": true,
"docker_credentials_json": {
"redacted_message": "[PRIVATE DATA HIDDEN]"
},
"space_url": "/v2/spaces/b27a65f3-ba00-406f-aa7a-e9c46b739a7c",
"stack_url": "/v2/stacks/f5705a92-addd-4986-9506-5b03e0fd77e4",
"events_url": "/v2/apps/e61c49ac-cd17-410b-9a04-a7596dde9bf0/events",
"service_bindings_url": "/v2/apps/e61c49ac-cd17-410b-9a04-a7596dde9bf0/service_bindings",
"routes_url": "/v2/apps/e61c49ac-cd17-410b-9a04-a7596dde9bf0/routes"
}
}
]
}
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: a7281921-5fb9-4be5-bb01-ea816fcb2b1f Content-Length: 5190 X-Content-Type-Options: nosniff