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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNiIsImVtYWlsIjoiZW1haWwtMjM5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNzZ9.v4dHr0IZO7uEQ4s0Mac22T2nFpkXQPNm0R2Cbohm0uU
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.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNiIsImVtYWlsIjoiZW1haWwtMjM5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNzZ9.v4dHr0IZO7uEQ4s0Mac22T2nFpkXQPNm0R2Cbohm0uU" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 1f25a102-4fb5-45b3-bc3d-2ab11da6e197
Content-Length: 1023
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "1a6f6860-5e8e-4d5a-b186-bd430b9d016e",
        "url": "/v2/service_instances/1a6f6860-5e8e-4d5a-b186-bd430b9d016e",
        "created_at": "2015-02-10T01:42:56Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1614",
        "credentials": {
          "creds-key-516": "creds-val-516"
        },
        "service_plan_guid": "5b84deb6-0893-469c-933c-572f4d3ecf5e",
        "space_guid": "2073d601-5ab3-4d11-aa83-a494d178f4bf",
        "gateway_data": null,
        "dashboard_url": null,
        "type": "managed_service_instance",
        "last_operation": null,
        "space_url": "/v2/spaces/2073d601-5ab3-4d11-aa83-a494d178f4bf",
        "service_plan_url": "/v2/service_plans/5b84deb6-0893-469c-933c-572f4d3ecf5e",
        "service_bindings_url": "/v2/service_instances/1a6f6860-5e8e-4d5a-b186-bd430b9d016e/service_bindings"
      }
    }
  ]
}