Home
Version 3
Service Brokers API

Service Brokers API

List all Service Brokers

GET /v2/service_brokers

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzOCIsImVtYWlsIjoiZW1haWwtMTAxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxMzZ9.MDLiHRxcphr62CSi46J9GTmT_EeMYEjFoLyIde0Vch0
Host: example.org
Cookie: 

Route

GET /v2/service_brokers

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 46f82e8b-109b-44aa-a240-b7de891d9342
Content-Length: 1294
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "007a89d7-ad71-4628-bd6e-1081f7fc6632",
        "url": "/v2/service_brokers/007a89d7-ad71-4628-bd6e-1081f7fc6632",
        "created_at": "2014-11-05T01:02:16+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-647",
        "broker_url": "https://foo.com/url-28",
        "auth_username": "auth_username-8"
      }
    },
    {
      "metadata": {
        "guid": "d2a571c5-12f8-4b17-897c-25c5ac24d361",
        "url": "/v2/service_brokers/d2a571c5-12f8-4b17-897c-25c5ac24d361",
        "created_at": "2014-11-05T01:02:16+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-648",
        "broker_url": "https://foo.com/url-29",
        "auth_username": "auth_username-9"
      }
    },
    {
      "metadata": {
        "guid": "a2ad7ccd-6e48-4065-a7a8-4ba319cb54d7",
        "url": "/v2/service_brokers/a2ad7ccd-6e48-4065-a7a8-4ba319cb54d7",
        "created_at": "2014-11-05T01:02:16+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-649",
        "broker_url": "https://foo.com/url-30",
        "auth_username": "auth_username-10"
      }
    }
  ]
}