Name | Description | Default | Valid Values | Example Values |
---|
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, service_plan_guid, service_binding_guid, gateway_name, organization_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.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMyIsImVtYWlsIjoiZW1haWwtMTQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDN9.AoEPbeeVeFklFuv-WxtnwEGprIZbGx_3xyJuPnxW4FM Host: example.org Cookie:
GET /v2/service_instances
curl "https://api.[your-domain.com]/v2/service_instances" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwMyIsImVtYWlsIjoiZW1haWwtMTQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDN9.AoEPbeeVeFklFuv-WxtnwEGprIZbGx_3xyJuPnxW4FM" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 731d9e99-87be-4cae-a5bd-9060dcb9e3e7 Content-Length: 1054 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "702d4b3d-8144-4d0d-ab2a-57ac29cc40cf", "url": "/v2/service_instances/702d4b3d-8144-4d0d-ab2a-57ac29cc40cf", "created_at": "2015-01-20T01:52:23+00:00", "updated_at": null }, "entity": { "name": "name-1407", "credentials": { "creds-key-317": "creds-val-317" }, "service_plan_guid": "ae2e7fca-f855-4e35-b336-6748789486f3", "space_guid": "f52ab417-8a95-4b63-9cef-1a53bf2e4ca0", "gateway_data": null, "dashboard_url": null, "type": "managed_service_instance", "state": null, "state_description": null, "space_url": "/v2/spaces/f52ab417-8a95-4b63-9cef-1a53bf2e4ca0", "service_plan_url": "/v2/service_plans/ae2e7fca-f855-4e35-b336-6748789486f3", "service_bindings_url": "/v2/service_instances/702d4b3d-8144-4d0d-ab2a-57ac29cc40cf/service_bindings" } } ] }