Home
Version 3
Service Instances API

Service Instances API

List all Service Instances

GET /v2/service_instances

Fields

Name Description Default Valid Values Example Values

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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYiLCJlbWFpbCI6ImVtYWlsLTZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxNTc1NDEyOX0.KqO5XDG66rH1Y-XznQu6cFSs5jaRfVJTn4d7QhtRNfo
Host: example.org
Cookie: 

Route

GET /v2/service_instances

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 63c089f4-da3d-4f2e-b1c7-a9de55c01b40
Content-Length: 992
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "1f8e2109-cf90-4476-bd65-a354979f0772",
        "url": "/v2/service_instances/1f8e2109-cf90-4476-bd65-a354979f0772",
        "created_at": "2014-11-05T01:02:09+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-32",
        "credentials": {
          "creds-key-15": "creds-val-15"
        },
        "service_plan_guid": "3d8dcaa5-0499-4d47-9a96-1dcc7da68b95",
        "space_guid": "0a38ad3f-2dac-4150-92b9-04dbe16e4439",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "space_url": "/v2/spaces/0a38ad3f-2dac-4150-92b9-04dbe16e4439",
        "service_plan_url": "/v2/service_plans/3d8dcaa5-0499-4d47-9a96-1dcc7da68b95",
        "service_bindings_url": "/v2/service_instances/1f8e2109-cf90-4476-bd65-a354979f0772/service_bindings"
      }
    }
  ]
}