Home
Version 3
Service Instances API

Service Instances API

List all Service Instances

GET /v2/service_instances

Request

Route

GET /v2/service_instances

Parameters

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
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIiLCJlbWFpbCI6ImVtYWlsLTJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjE4NzczM30.nBiztE_RaeN_6U5UOJ7-V3mlLi18PRJ3BXkqezcAN-0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIiLCJlbWFpbCI6ImVtYWlsLTJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjE4NzczM30.nBiztE_RaeN_6U5UOJ7-V3mlLi18PRJ3BXkqezcAN-0" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

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.
  • managed_service_instance
  • user_provided_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
  • create
  • update
  • delete
last_operation.state The status of the last operation or current operation being performed on the service instance.
  • in progress
  • succeeded
  • failed
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.
{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "1dc7e251-bbc7-4735-b8f7-3af5232e806c",
        "url": "/v2/service_instances/1dc7e251-bbc7-4735-b8f7-3af5232e806c",
        "created_at": "2015-03-05T19:15:33Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-11",
        "credentials": {
          "creds-key-6": "creds-val-6"
        },
        "service_plan_guid": "62a95a4f-ec89-47e6-b37b-da023b844ae1",
        "space_guid": "f3b69d20-a86b-4d84-ac25-21f993b81869",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": {
          "type": "create",
          "state": "succeeded",
          "description": "service broker-provided description",
          "updated_at": "2015-03-05T19:15:33Z"
        },
        "space_url": "/v2/spaces/f3b69d20-a86b-4d84-ac25-21f993b81869",
        "service_plan_url": "/v2/service_plans/62a95a4f-ec89-47e6-b37b-da023b844ae1",
        "service_bindings_url": "/v2/service_instances/1dc7e251-bbc7-4735-b8f7-3af5232e806c/service_bindings"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 97c66ba9-80d8-4602-b0d5-ebacd7495274
Content-Length: 1195
X-Content-Type-Options: nosniff