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.eyJ1c2VyX2lkIjoidWFhLWlkLTMyOSIsImVtYWlsIjoiZW1haWwtMjIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3MjF9.xKtAwPyHcuDtyyGwKLIC5Ef03YTEQqEpkKUcX-PJhYs
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyOSIsImVtYWlsIjoiZW1haWwtMjIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjM2MTg3MjF9.xKtAwPyHcuDtyyGwKLIC5Ef03YTEQqEpkKUcX-PJhYs" \
	-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": "a719ede1-720f-4dbb-a1a6-c2dece02fbca",
        "url": "/v2/service_brokers/a719ede1-720f-4dbb-a1a6-c2dece02fbca",
        "created_at": "2016-05-12T00:45:21Z",
        "updated_at": "2016-05-12T00:45:21Z"
      },
      "entity": {
        "name": "name-1768",
        "broker_url": "https://foo.com/url-76",
        "auth_username": "auth_username-54",
        "space_guid": "d525745a-3822-479f-9705-cd2f4a78a764"
      }
    },
    {
      "metadata": {
        "guid": "d44e1dc3-570e-4091-a7df-9cede5817f9e",
        "url": "/v2/service_brokers/d44e1dc3-570e-4091-a7df-9cede5817f9e",
        "created_at": "2016-05-12T00:45:21Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1769",
        "broker_url": "https://foo.com/url-77",
        "auth_username": "auth_username-55",
        "space_guid": null
      }
    },
    {
      "metadata": {
        "guid": "412f69ca-7661-41b1-b8e8-a364d6d8ba28",
        "url": "/v2/service_brokers/412f69ca-7661-41b1-b8e8-a364d6d8ba28",
        "created_at": "2016-05-12T00:45:21Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1770",
        "broker_url": "https://foo.com/url-78",
        "auth_username": "auth_username-56",
        "space_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 0fe8e901-59e2-440a-a102-3762b277db05
Content-Length: 1420
X-Content-Type-Options: nosniff