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.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MiIsImVtYWlsIjoiZW1haWwtMTA3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTB9.k03ouh689ZpTbz_YbkIIhboeV4Qyo4f81HqX5lEaBhw
Host: example.org


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



200 OK


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.
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.
shared_from_url Source information for a shared service instance. Users of a shared service instance can find out its space and org information.
shared_to_url Information about where the service instance instance has been shared to.
service_instance_parameters_url The relative path to discover the current configuration parameters of 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": "215b97be-ec77-4224-9c38-c4f2d86b56c1",
        "url": "/v2/service_instances/215b97be-ec77-4224-9c38-c4f2d86b56c1",
        "created_at": "2016-06-08T16:41:29Z",
        "updated_at": "2016-06-08T16:41:26Z"
      "entity": {
        "name": "name-1523",
        "credentials": {
          "creds-key-40": "creds-val-40"
        "service_guid": "3ab19880-ab42-4d0e-a229-ac93fc02beb4"
        "service_plan_guid": "05a372c6-6dc2-4f7f-8f65-a90ebe5fa6e2",
        "space_guid": "53b78e76-23d6-476d-8cd8-5ccaf5ad0770",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": {
          "type": "create",
          "state": "succeeded",
          "description": "service broker-provided description",
          "updated_at": "2016-06-08T16:41:29Z",
          "created_at": "2016-06-08T16:41:29Z"
        "tags": [
        "space_url": "/v2/spaces/53b78e76-23d6-476d-8cd8-5ccaf5ad0770",
        "service_url": "/v2/services/3ab19880-ab42-4d0e-a229-ac93fc02beb4",
        "service_plan_url": "/v2/service_plans/05a372c6-6dc2-4f7f-8f65-a90ebe5fa6e2",
        "service_bindings_url": "/v2/service_instances/215b97be-ec77-4224-9c38-c4f2d86b56c1/service_bindings",
        "service_keys_url": "/v2/service_instances/215b97be-ec77-4224-9c38-c4f2d86b56c1/service_keys",
        "routes_url": "/v2/service_instances/215b97be-ec77-4224-9c38-c4f2d86b56c1/routes",
        "shared_from_url": "/v2/service_instances/215b97be-ec77-4224-9c38-c4f2d86b56c1/shared_from",
        "shared_to_url": "/v2/service_instances/215b97be-ec77-4224-9c38-c4f2d86b56c1/shared_to",
        "service_instance_parameters_url": "/v2/service_instances/215b97be-ec77-4224-9c38-c4f2d86b56c1/parameters"


Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f5987ac5-1620-439f-874a-ea9dad6c843f
Content-Length: 1514
X-Content-Type-Options: nosniff