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.eyJ1c2VyX2lkIjoidWFhLWlkLTE2NCIsImVtYWlsIjoiZW1haWwtOTdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NTM2MjMwMX0.BEYtVl-8Q2pVLOwYQRnBeABC1WmbfTTk2wjR9Yiycqw
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2NCIsImVtYWlsIjoiZW1haWwtOTdAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NTM2MjMwMX0.BEYtVl-8Q2pVLOwYQRnBeABC1WmbfTTk2wjR9Yiycqw" \
	-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": "b81352ac-79ed-44f7-b256-9f8c6aa0c1b5",
        "url": "/v2/service_brokers/b81352ac-79ed-44f7-b256-9f8c6aa0c1b5",
        "created_at": "2015-10-13T17:31:41Z",
        "updated_at": "2015-10-13T17:31:41Z"
      },
      "entity": {
        "name": "name-353",
        "broker_url": "https://foo.com/url-18",
        "auth_username": "auth_username-18",
        "space_guid": "c349a528-7d5d-4f2f-8549-472c0b4c6b9b"
      }
    },
    {
      "metadata": {
        "guid": "7f3fc378-6638-46cc-b956-d31fce11733f",
        "url": "/v2/service_brokers/7f3fc378-6638-46cc-b956-d31fce11733f",
        "created_at": "2015-10-13T17:31:41Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-354",
        "broker_url": "https://foo.com/url-19",
        "auth_username": "auth_username-19",
        "space_guid": null
      }
    },
    {
      "metadata": {
        "guid": "021ebbf8-1053-4ee2-9afe-4d06f19c069a",
        "url": "/v2/service_brokers/021ebbf8-1053-4ee2-9afe-4d06f19c069a",
        "created_at": "2015-10-13T17:31:41Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-355",
        "broker_url": "https://foo.com/url-20",
        "auth_username": "auth_username-20",
        "space_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 39d13c2e-7ccd-4f75-a2ba-3a851dbde121
Content-Length: 1417
X-Content-Type-Options: nosniff