Home
Version 3
Service Brokers API

Service Brokers API

List all Service Brokers

GET /v2/service_brokers

Request

Route

GET /v2/service_brokers

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
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTUiLCJlbWFpbCI6ImVtYWlsLTVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MTk1ODM5MH0.w0z2_1IM58P2G3FQDlnUKSfGt6-ICJRXNi7d10HSF-w
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTUiLCJlbWFpbCI6ImVtYWlsLTVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MTk1ODM5MH0.w0z2_1IM58P2G3FQDlnUKSfGt6-ICJRXNi7d10HSF-w" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "bebd77fc-2564-4d74-a35c-a3985cd0ac8c",
        "url": "/v2/service_brokers/bebd77fc-2564-4d74-a35c-a3985cd0ac8c",
        "created_at": "2016-04-22T19:33:10Z",
        "updated_at": "2016-04-22T19:33:10Z"
      },
      "entity": {
        "name": "name-25",
        "broker_url": "https://foo.com/url-13",
        "auth_username": "auth_username-13",
        "space_guid": "b03a9660-16ff-4500-a00c-bf089884c0ba"
      }
    },
    {
      "metadata": {
        "guid": "54fb1a59-2d7c-4a1c-8b0e-3cfed651fa4d",
        "url": "/v2/service_brokers/54fb1a59-2d7c-4a1c-8b0e-3cfed651fa4d",
        "created_at": "2016-04-22T19:33:10Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-26",
        "broker_url": "https://foo.com/url-14",
        "auth_username": "auth_username-14",
        "space_guid": null
      }
    },
    {
      "metadata": {
        "guid": "d0bfbbc0-c7a8-4b9c-90b5-8fd17b298c94",
        "url": "/v2/service_brokers/d0bfbbc0-c7a8-4b9c-90b5-8fd17b298c94",
        "created_at": "2016-04-22T19:33:10Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-27",
        "broker_url": "https://foo.com/url-15",
        "auth_username": "auth_username-15",
        "space_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f9b2feb2-b9e3-4493-b1fc-5a3279b6fb03
Content-Length: 1414
X-Content-Type-Options: nosniff