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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ1NCIsImVtYWlsIjoiZW1haWwtMzI1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM3MDJ9.KLDIhiSo2rKPuUsZImLy5po_bFOL00_xWI3EmIlFBcI Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ1NCIsImVtYWlsIjoiZW1haWwtMzI1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM3MDJ9.KLDIhiSo2rKPuUsZImLy5po_bFOL00_xWI3EmIlFBcI" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "5605df23-4acd-4ef4-9f8d-61cbf573faa8", "url": "/v2/apps/5605df23-4acd-4ef4-9f8d-61cbf573faa8", "created_at": "2015-12-22T18:28:22Z", "updated_at": "2015-12-22T18:28:22Z" }, "entity": { "name": "name-2474", "production": false, "space_guid": "28514b22-2370-43ca-b830-cc41239c67d2", "stack_guid": "234362ad-c896-4290-a894-dcd412c268c1", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "13e52364-d068-4312-b8b2-6e76fb6f2793", "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-12-22T18:28:22Z", "detected_start_command": "", "enable_ssh": true, "docker_credentials_json": { "redacted_message": "[PRIVATE DATA HIDDEN]" }, "ports": null, "space_url": "/v2/spaces/28514b22-2370-43ca-b830-cc41239c67d2", "stack_url": "/v2/stacks/234362ad-c896-4290-a894-dcd412c268c1", "events_url": "/v2/apps/5605df23-4acd-4ef4-9f8d-61cbf573faa8/events", "service_bindings_url": "/v2/apps/5605df23-4acd-4ef4-9f8d-61cbf573faa8/service_bindings", "routes_url": "/v2/apps/5605df23-4acd-4ef4-9f8d-61cbf573faa8/routes" } }, { "metadata": { "guid": "a555f2b6-be23-45d7-aa86-5d815baed16b", "url": "/v2/apps/a555f2b6-be23-45d7-aa86-5d815baed16b", "created_at": "2015-12-22T18:28:22Z", "updated_at": "2015-12-22T18:28:22Z" }, "entity": { "name": "name-2469", "production": false, "space_guid": "3919ba66-92d8-4416-a0cf-d8a180959ffb", "stack_guid": "142f2588-da40-486b-8918-73dafc2460dc", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "14adda2b-671d-48a9-95e6-80efb5b91bfc", "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-12-22T18:28:22Z", "detected_start_command": "", "enable_ssh": true, "docker_credentials_json": { "redacted_message": "[PRIVATE DATA HIDDEN]" }, "ports": null, "space_url": "/v2/spaces/3919ba66-92d8-4416-a0cf-d8a180959ffb", "stack_url": "/v2/stacks/142f2588-da40-486b-8918-73dafc2460dc", "events_url": "/v2/apps/a555f2b6-be23-45d7-aa86-5d815baed16b/events", "service_bindings_url": "/v2/apps/a555f2b6-be23-45d7-aa86-5d815baed16b/service_bindings", "routes_url": "/v2/apps/a555f2b6-be23-45d7-aa86-5d815baed16b/routes" } }, { "metadata": { "guid": "b4be7177-8180-4b1f-82fb-0025a08b8142", "url": "/v2/apps/b4be7177-8180-4b1f-82fb-0025a08b8142", "created_at": "2015-12-22T18:28:22Z", "updated_at": "2015-12-22T18:28:22Z" }, "entity": { "name": "name-2479", "production": false, "space_guid": "5fc4fa2e-9163-48e9-9529-c95edf5d8cfe", "stack_guid": "9e3eff0e-ed44-4e2c-87b4-0279c7ddfddb", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "7287de62-8015-4c5f-aeae-cc9d3c0735f7", "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-12-22T18:28:22Z", "detected_start_command": "", "enable_ssh": true, "docker_credentials_json": { "redacted_message": "[PRIVATE DATA HIDDEN]" }, "ports": null, "space_url": "/v2/spaces/5fc4fa2e-9163-48e9-9529-c95edf5d8cfe", "stack_url": "/v2/stacks/9e3eff0e-ed44-4e2c-87b4-0279c7ddfddb", "events_url": "/v2/apps/b4be7177-8180-4b1f-82fb-0025a08b8142/events", "service_bindings_url": "/v2/apps/b4be7177-8180-4b1f-82fb-0025a08b8142/service_bindings", "routes_url": "/v2/apps/b4be7177-8180-4b1f-82fb-0025a08b8142/routes" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 5259 X-Content-Type-Options: nosniff