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.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MyIsImVtYWlsIjoiZW1haWwtMTM0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0MzV9.3wVp-0I5OHs7Bf2v1GFVGM_zfiwpGjiGDkBxf_BR5g0 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3MyIsImVtYWlsIjoiZW1haWwtMTM0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg1OTk0MzV9.3wVp-0I5OHs7Bf2v1GFVGM_zfiwpGjiGDkBxf_BR5g0" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "12f830d7-2ec9-4c66-ad0a-dc5d32affb1f", "url": "/v2/apps/12f830d7-2ec9-4c66-ad0a-dc5d32affb1f", "created_at": "2016-03-14T22:30:35Z", "updated_at": "2016-03-14T22:30:35Z" }, "entity": { "name": "name-1568", "production": false, "space_guid": "84ab199d-4f64-4214-8146-7848e5bb2963", "stack_guid": "27d1515c-db8a-4620-954a-36e5eedc40e9", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "4b3586da-7cda-458d-bc6b-b9150938e259", "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": "2016-03-14T22:30:35Z", "detected_start_command": "", "enable_ssh": true, "docker_credentials_json": { "redacted_message": "[PRIVATE DATA HIDDEN]" }, "ports": null, "space_url": "/v2/spaces/84ab199d-4f64-4214-8146-7848e5bb2963", "stack_url": "/v2/stacks/27d1515c-db8a-4620-954a-36e5eedc40e9", "routes_url": "/v2/apps/12f830d7-2ec9-4c66-ad0a-dc5d32affb1f/routes", "events_url": "/v2/apps/12f830d7-2ec9-4c66-ad0a-dc5d32affb1f/events", "service_bindings_url": "/v2/apps/12f830d7-2ec9-4c66-ad0a-dc5d32affb1f/service_bindings", "route_mappings_url": "/v2/apps/12f830d7-2ec9-4c66-ad0a-dc5d32affb1f/route_mappings" } }, { "metadata": { "guid": "57a2239b-1857-480a-855b-476c568c105b", "url": "/v2/apps/57a2239b-1857-480a-855b-476c568c105b", "created_at": "2016-03-14T22:30:35Z", "updated_at": "2016-03-14T22:30:35Z" }, "entity": { "name": "name-1573", "production": false, "space_guid": "75064f6e-bd49-4536-8f84-c9ec965f87be", "stack_guid": "bd967ade-da1d-4750-b90b-5ed91646aa93", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "62ac542b-2c90-4d52-9dee-e6d03a1e4f0d", "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": "2016-03-14T22:30:35Z", "detected_start_command": "", "enable_ssh": true, "docker_credentials_json": { "redacted_message": "[PRIVATE DATA HIDDEN]" }, "ports": null, "space_url": "/v2/spaces/75064f6e-bd49-4536-8f84-c9ec965f87be", "stack_url": "/v2/stacks/bd967ade-da1d-4750-b90b-5ed91646aa93", "routes_url": "/v2/apps/57a2239b-1857-480a-855b-476c568c105b/routes", "events_url": "/v2/apps/57a2239b-1857-480a-855b-476c568c105b/events", "service_bindings_url": "/v2/apps/57a2239b-1857-480a-855b-476c568c105b/service_bindings", "route_mappings_url": "/v2/apps/57a2239b-1857-480a-855b-476c568c105b/route_mappings" } }, { "metadata": { "guid": "5c137071-5cf8-4fd7-919e-b74c40701984", "url": "/v2/apps/5c137071-5cf8-4fd7-919e-b74c40701984", "created_at": "2016-03-14T22:30:35Z", "updated_at": "2016-03-14T22:30:35Z" }, "entity": { "name": "name-1578", "production": false, "space_guid": "b57db2d4-cbe4-407a-bf55-88ec65fd813a", "stack_guid": "fac601dd-e352-47fe-926c-12c7db7ee5e5", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "5dcf3807-4803-4633-97ce-5bc20e059356", "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": "2016-03-14T22:30:35Z", "detected_start_command": "", "enable_ssh": true, "docker_credentials_json": { "redacted_message": "[PRIVATE DATA HIDDEN]" }, "ports": null, "space_url": "/v2/spaces/b57db2d4-cbe4-407a-bf55-88ec65fd813a", "stack_url": "/v2/stacks/fac601dd-e352-47fe-926c-12c7db7ee5e5", "routes_url": "/v2/apps/5c137071-5cf8-4fd7-919e-b74c40701984/routes", "events_url": "/v2/apps/5c137071-5cf8-4fd7-919e-b74c40701984/events", "service_bindings_url": "/v2/apps/5c137071-5cf8-4fd7-919e-b74c40701984/service_bindings", "route_mappings_url": "/v2/apps/5c137071-5cf8-4fd7-919e-b74c40701984/route_mappings" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 5541 X-Content-Type-Options: nosniff