Version 3
Service Instances API

Service Instances API

List all Service Instances

GET /v2/service_instances



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
  • 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


Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5ODd9.lM0A2rxSn3P_8jlEFFsb86Co5jQ2pQP47cYNo_O1-98
Host: example.org


curl "https://api.[your-domain.com]/v2/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5ODd9.lM0A2rxSn3P_8jlEFFsb86Co5jQ2pQP47cYNo_O1-98" \
	-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.
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.
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": "4ecb00a6-6494-4058-8aa8-7edf7e89c120",
        "url": "/v2/service_instances/4ecb00a6-6494-4058-8aa8-7edf7e89c120",
        "created_at": "2016-01-13T17:29:47Z",
        "updated_at": null
      "entity": {
        "name": "name-1784",
        "credentials": {
          "creds-key-56": "creds-val-56"
        "service_plan_guid": "d49b7a0f-8749-43f5-b343-efc15b74028e",
        "space_guid": "5eb38e4f-62f9-4804-8400-7aa6f776f570",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": {
          "type": "create",
          "state": "succeeded",
          "description": "service broker-provided description",
          "updated_at": "2016-01-13T17:29:47Z",
          "created_at": "2016-01-13T17:29:47Z"
        "tags": [
        "space_url": "/v2/spaces/5eb38e4f-62f9-4804-8400-7aa6f776f570",
        "service_plan_url": "/v2/service_plans/d49b7a0f-8749-43f5-b343-efc15b74028e",
        "service_bindings_url": "/v2/service_instances/4ecb00a6-6494-4058-8aa8-7edf7e89c120/service_bindings",
        "service_keys_url": "/v2/service_instances/4ecb00a6-6494-4058-8aa8-7edf7e89c120/service_keys",
        "routes_url": "/v2/service_instances/4ecb00a6-6494-4058-8aa8-7edf7e89c120/routes"


Content-Type: application/json;charset=utf-8
Content-Length: 1514
X-Content-Type-Options: nosniff