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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1IiwiZW1haWwiOiJlbWFpbC0xOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzUwfQ.y6cVfPP6dmpmiynAY9Zxe_CBSba4rhT1I5UTSqgETOk Host: example.org Cookie:
GET /v2/service_instances
curl "https://api.[your-domain.com]/v2/service_instances" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1IiwiZW1haWwiOiJlbWFpbC0xOEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzUwfQ.y6cVfPP6dmpmiynAY9Zxe_CBSba4rhT1I5UTSqgETOk" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: df232cb6-be8c-4b83-84cf-711c143fcc13 Content-Length: 993 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "0acaab36-5c61-439d-b6da-370211f76c12", "url": "/v2/service_instances/0acaab36-5c61-439d-b6da-370211f76c12", "created_at": "2014-11-24T19:32:30+00:00", "updated_at": null }, "entity": { "name": "name-281", "credentials": { "creds-key-41": "creds-val-41" }, "service_plan_guid": "63589e98-0708-4c7d-834d-af8aca323300", "space_guid": "83f63275-89ae-49da-b69b-ec4924c93133", "gateway_data": null, "dashboard_url": null, "type": "managed_service_instance", "space_url": "/v2/spaces/83f63275-89ae-49da-b69b-ec4924c93133", "service_plan_url": "/v2/service_plans/63589e98-0708-4c7d-834d-af8aca323300", "service_bindings_url": "/v2/service_instances/0acaab36-5c61-439d-b6da-370211f76c12/service_bindings" } } ] }