GET /v2/service_instances
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, service_key_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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NiIsImVtYWlsIjoiZW1haWwtMTgyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDd9.MoReh5LaROqxUC8ldBsr89Jsn9HJFIHaOLmqskiJpHw Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/service_instances" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NiIsImVtYWlsIjoiZW1haWwtMTgyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDd9.MoReh5LaROqxUC8ldBsr89Jsn9HJFIHaOLmqskiJpHw" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
Name | Description | Valid Values |
---|---|---|
name | The human-readable name of the service instance. |
|
credentials | The service broker-provided credentials to use this service. |
|
service_plan_guid | The service plan GUID that this service instance is utilizing. |
|
space_guid | The space GUID that this service instance belongs to. |
|
gateway_data |
|
|
dashboard_url | The service broker-provided URL to access administrative features of the service instance. May be null. |
|
type | The type of service instance. |
|
last_operation | The status of the last operation requested on the service instance. May be null. |
|
last_operation.type | The type of operation that was last performed or currently being performed on the service instance |
|
last_operation.state | The status of the last operation or current operation being performed on the service instance. |
|
last_operation.description | The service broker-provided description of the operation. May be null. |
|
last_operation.updated_at | The timestamp that the Cloud Controller last checked the service instance state from the broker. |
|
space_url | The relative path to the space resource that this service instance belongs to. |
|
service_plan_url | The relative path to the service plan resource that this service instance belongs to. |
|
service_binding_url | The relative path to the service bindings that this service instance is bound to. |
|
routes_url | Routes bound to the service instance. Requests to these routes will be forwarded to the service instance. |
|
tags | A list of tags for the service instance |
|
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "774eb65c-827b-4c6d-ac40-238452919d15", "url": "/v2/service_instances/774eb65c-827b-4c6d-ac40-238452919d15", "created_at": "2015-08-31T21:50:07Z", "updated_at": null }, "entity": { "name": "name-959", "credentials": { "creds-key-400": "creds-val-400" }, "service_plan_guid": "74c7d0f7-c26e-4324-ad25-db083bc5a67c", "space_guid": "2f7d80b2-b34e-48e8-9c15-7933b7232354", "gateway_data": null, "dashboard_url": null, "type": "managed_service_instance", "last_operation": { "type": "create", "state": "succeeded", "description": "service broker-provided description", "updated_at": "2015-08-31T21:50:07Z", "created_at": "2015-08-31T21:50:07Z" }, "tags": [ "accounting", "mongodb" ], "space_url": "/v2/spaces/2f7d80b2-b34e-48e8-9c15-7933b7232354", "service_plan_url": "/v2/service_plans/74c7d0f7-c26e-4324-ad25-db083bc5a67c", "service_bindings_url": "/v2/service_instances/774eb65c-827b-4c6d-ac40-238452919d15/service_bindings", "service_keys_url": "/v2/service_instances/774eb65c-827b-4c6d-ac40-238452919d15/service_keys", "routes_url": "/v2/service_instances/774eb65c-827b-4c6d-ac40-238452919d15/routes" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 7fda38f9-d588-4cf0-adf1-204cb4010d54 Content-Length: 1515 X-Content-Type-Options: nosniff