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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNSIsImVtYWlsIjoiZW1haWwtOTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1NDQ1MTYxNH0.hr0khhqQOCl_oFgtniecX3qAkWSkUL7aDzzVqIQW08A
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNSIsImVtYWlsIjoiZW1haWwtOTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1NDQ1MTYxNH0.hr0khhqQOCl_oFgtniecX3qAkWSkUL7aDzzVqIQW08A" \
	-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": "a2280b6a-fc3a-40dd-a99f-65d70546dd86",
        "url": "/v2/service_brokers/a2280b6a-fc3a-40dd-a99f-65d70546dd86",
        "created_at": "2016-01-26T22:20:14Z",
        "updated_at": "2016-01-26T22:20:14Z"
      },
      "entity": {
        "name": "name-550",
        "broker_url": "https://foo.com/url-20",
        "auth_username": "auth_username-20",
        "space_guid": "2eb6ed03-2c3f-442b-a9a7-4dd32f72723f"
      }
    },
    {
      "metadata": {
        "guid": "3378002c-05c8-4839-8ab1-8a6288b9bab3",
        "url": "/v2/service_brokers/3378002c-05c8-4839-8ab1-8a6288b9bab3",
        "created_at": "2016-01-26T22:20:14Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-551",
        "broker_url": "https://foo.com/url-21",
        "auth_username": "auth_username-21",
        "space_guid": null
      }
    },
    {
      "metadata": {
        "guid": "3df7f84a-4efb-4779-8ebc-76e52824def4",
        "url": "/v2/service_brokers/3df7f84a-4efb-4779-8ebc-76e52824def4",
        "created_at": "2016-01-26T22:20:14Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-552",
        "broker_url": "https://foo.com/url-22",
        "auth_username": "auth_username-22",
        "space_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1417
X-Content-Type-Options: nosniff