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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1MyIsImVtYWlsIjoiZW1haWwtMjU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MTB9.qZWyG8icgou9uQ-ERRqHhrtJM1xCjDrKckSthAEY_kE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1MyIsImVtYWlsIjoiZW1haWwtMjU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MTB9.qZWyG8icgou9uQ-ERRqHhrtJM1xCjDrKckSthAEY_kE" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

Name Description Valid Values Example 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.
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": "0d527d6f-c794-4f5c-b4a8-a93ba4a1f880",
        "url": "/v2/service_instances/0d527d6f-c794-4f5c-b4a8-a93ba4a1f880",
        "created_at": "2016-04-22T19:33:30Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1187",
        "credentials": {
          "creds-key-49": "creds-val-49"
        },
        "service_plan_guid": "b7b6eddc-fa3b-4952-91a3-45602dd05130",
        "space_guid": "ce8736e5-d617-4022-a6bd-25b92420548e",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": {
          "type": "create",
          "state": "succeeded",
          "description": "service broker-provided description",
          "updated_at": "2016-04-22T19:33:30Z",
          "created_at": "2016-04-22T19:33:30Z"
        },
        "tags": [
          "accounting",
          "mongodb"
        ],
        "space_url": "/v2/spaces/ce8736e5-d617-4022-a6bd-25b92420548e",
        "service_plan_url": "/v2/service_plans/b7b6eddc-fa3b-4952-91a3-45602dd05130",
        "service_bindings_url": "/v2/service_instances/0d527d6f-c794-4f5c-b4a8-a93ba4a1f880/service_bindings",
        "service_keys_url": "/v2/service_instances/0d527d6f-c794-4f5c-b4a8-a93ba4a1f880/service_keys",
        "routes_url": "/v2/service_instances/0d527d6f-c794-4f5c-b4a8-a93ba4a1f880/routes"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7f1155c2-c416-4d9d-bd46-024a40bbfb52
Content-Length: 1514
X-Content-Type-Options: nosniff