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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MiIsImVtYWlsIjoiZW1haWwtMTg4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDh9.9sveSYdasFYvz0RrskJbCm9MfWrccJn_LYLLbp3uaSU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MiIsImVtYWlsIjoiZW1haWwtMTg4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDh9.9sveSYdasFYvz0RrskJbCm9MfWrccJn_LYLLbp3uaSU" \
	-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": "2db747e2-b687-405f-9d26-7e7bd35cd1ca",
        "url": "/v2/service_brokers/2db747e2-b687-405f-9d26-7e7bd35cd1ca",
        "created_at": "2015-08-31T21:50:08Z",
        "updated_at": "2015-08-31T21:50:08Z"
      },
      "entity": {
        "name": "name-993",
        "broker_url": "https://foo.com/url-52",
        "auth_username": "auth_username-52",
        "space_guid": "5e14c8ea-ca19-4a7f-8dd5-08660f04acbb"
      }
    },
    {
      "metadata": {
        "guid": "6fe83e51-18f6-4d8e-93d7-12aaa4101c99",
        "url": "/v2/service_brokers/6fe83e51-18f6-4d8e-93d7-12aaa4101c99",
        "created_at": "2015-08-31T21:50:08Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-994",
        "broker_url": "https://foo.com/url-53",
        "auth_username": "auth_username-53",
        "space_guid": null
      }
    },
    {
      "metadata": {
        "guid": "1398e274-b1a1-4049-9cd6-4112f9c98035",
        "url": "/v2/service_brokers/1398e274-b1a1-4049-9cd6-4112f9c98035",
        "created_at": "2015-08-31T21:50:08Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-995",
        "broker_url": "https://foo.com/url-54",
        "auth_username": "auth_username-54",
        "space_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 62851bd7-e7f4-4f70-a3c4-08c8b50ae419
Content-Length: 1417
X-Content-Type-Options: nosniff