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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYxIiwiZW1haWwiOiJlbWFpbC0zMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMzOTgxMDk4fQ.Ke-FVRY3YTLoaWGusfeFL9cTYletU23cdL_FfKvu1V4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYxIiwiZW1haWwiOiJlbWFpbC0zMkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMzOTgxMDk4fQ.Ke-FVRY3YTLoaWGusfeFL9cTYletU23cdL_FfKvu1V4" \
	-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.
tags A list of tags for the service instance
{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "53ae730e-de79-4201-a7fd-68820c2b56a9",
        "url": "/v2/service_instances/53ae730e-de79-4201-a7fd-68820c2b56a9",
        "created_at": "2015-06-04T00:04:58Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-209",
        "credentials": {
          "creds-key-70": "creds-val-70"
        },
        "service_plan_guid": "a10766ba-757d-4dca-b1fe-75853322b5ec",
        "space_guid": "2e6fea3d-1757-422d-8e0a-b4f3a7a0cc11",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": {
          "type": "create",
          "state": "succeeded",
          "description": "service broker-provided description",
          "updated_at": "2015-06-04T00:04:58Z",
          "created_at": "2015-06-04T00:04:58Z"
        },
        "tags": [
          "accounting_mongodb"
        ],
        "space_url": "/v2/spaces/2e6fea3d-1757-422d-8e0a-b4f3a7a0cc11",
        "service_plan_url": "/v2/service_plans/a10766ba-757d-4dca-b1fe-75853322b5ec",
        "service_bindings_url": "/v2/service_instances/53ae730e-de79-4201-a7fd-68820c2b56a9/service_bindings",
        "service_keys_url": "/v2/service_instances/53ae730e-de79-4201-a7fd-68820c2b56a9/service_keys"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: dcb8d01d-7bf0-4b4c-bd2a-0b4cedb1717a
Content-Length: 1409
X-Content-Type-Options: nosniff