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.eyJ1c2VyX2lkIjoidWFhLWlkLTE2OSIsImVtYWlsIjoiZW1haWwtMTA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2NzJ9.wkQHHr5X0tHTZslj8MvkfOoT8GknmdWYSlREJKvhBtc Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/apps" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2OSIsImVtYWlsIjoiZW1haWwtMTA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2NzJ9.wkQHHr5X0tHTZslj8MvkfOoT8GknmdWYSlREJKvhBtc" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "2a47d224-e4ba-4f52-b162-d849feda9fd0", "url": "/v2/apps/2a47d224-e4ba-4f52-b162-d849feda9fd0", "created_at": "2016-03-17T21:41:12Z", "updated_at": "2016-03-17T21:41:12Z" }, "entity": { "name": "name-622", "production": false, "space_guid": "fb45363a-de7e-41ab-a38e-2e6488a6c107", "stack_guid": "41922100-3c9f-4e89-90ee-d2c0ec251bec", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "c51a9120-2d20-4451-bb01-c7cf80b2872c", "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-17T21:41:12Z", "detected_start_command": "", "enable_ssh": true, "docker_credentials_json": { "redacted_message": "[PRIVATE DATA HIDDEN]" }, "ports": null, "space_url": "/v2/spaces/fb45363a-de7e-41ab-a38e-2e6488a6c107", "stack_url": "/v2/stacks/41922100-3c9f-4e89-90ee-d2c0ec251bec", "routes_url": "/v2/apps/2a47d224-e4ba-4f52-b162-d849feda9fd0/routes", "events_url": "/v2/apps/2a47d224-e4ba-4f52-b162-d849feda9fd0/events", "service_bindings_url": "/v2/apps/2a47d224-e4ba-4f52-b162-d849feda9fd0/service_bindings", "route_mappings_url": "/v2/apps/2a47d224-e4ba-4f52-b162-d849feda9fd0/route_mappings" } }, { "metadata": { "guid": "809dab69-2965-49ad-9ecc-1b728fb1113e", "url": "/v2/apps/809dab69-2965-49ad-9ecc-1b728fb1113e", "created_at": "2016-03-17T21:41:12Z", "updated_at": "2016-03-17T21:41:12Z" }, "entity": { "name": "name-627", "production": false, "space_guid": "3016225a-72c8-4680-8089-43b8cfe7849b", "stack_guid": "8f23310f-33cb-4c50-a9b5-bd7a0a930b4a", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "92475327-c3e8-40a0-b2e8-e69b959e99e8", "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-17T21:41:12Z", "detected_start_command": "", "enable_ssh": true, "docker_credentials_json": { "redacted_message": "[PRIVATE DATA HIDDEN]" }, "ports": null, "space_url": "/v2/spaces/3016225a-72c8-4680-8089-43b8cfe7849b", "stack_url": "/v2/stacks/8f23310f-33cb-4c50-a9b5-bd7a0a930b4a", "routes_url": "/v2/apps/809dab69-2965-49ad-9ecc-1b728fb1113e/routes", "events_url": "/v2/apps/809dab69-2965-49ad-9ecc-1b728fb1113e/events", "service_bindings_url": "/v2/apps/809dab69-2965-49ad-9ecc-1b728fb1113e/service_bindings", "route_mappings_url": "/v2/apps/809dab69-2965-49ad-9ecc-1b728fb1113e/route_mappings" } }, { "metadata": { "guid": "f4e42b1c-38de-4638-b713-ba78c8b5851c", "url": "/v2/apps/f4e42b1c-38de-4638-b713-ba78c8b5851c", "created_at": "2016-03-17T21:41:12Z", "updated_at": "2016-03-17T21:41:12Z" }, "entity": { "name": "name-632", "production": false, "space_guid": "d4afd857-04c4-45ad-96e7-b124217aa852", "stack_guid": "dca84db0-fb4e-44f1-9cb2-915184bfb009", "buildpack": null, "detected_buildpack": null, "environment_json": null, "memory": 1024, "instances": 1, "disk_quota": 1024, "state": "STOPPED", "version": "22f5f6ec-2cf0-4b57-b61a-4b204cc6e585", "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-17T21:41:12Z", "detected_start_command": "", "enable_ssh": true, "docker_credentials_json": { "redacted_message": "[PRIVATE DATA HIDDEN]" }, "ports": null, "space_url": "/v2/spaces/d4afd857-04c4-45ad-96e7-b124217aa852", "stack_url": "/v2/stacks/dca84db0-fb4e-44f1-9cb2-915184bfb009", "routes_url": "/v2/apps/f4e42b1c-38de-4638-b713-ba78c8b5851c/routes", "events_url": "/v2/apps/f4e42b1c-38de-4638-b713-ba78c8b5851c/events", "service_bindings_url": "/v2/apps/f4e42b1c-38de-4638-b713-ba78c8b5851c/service_bindings", "route_mappings_url": "/v2/apps/f4e42b1c-38de-4638-b713-ba78c8b5851c/route_mappings" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 5538 X-Content-Type-Options: nosniff