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.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MiIsImVtYWlsIjoiZW1haWwtMjAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzk0MjYyMDh9.fFB93VD7H6wDK_A8U_rX-OjLaRteXv7asgzCd_7YnvQ
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MiIsImVtYWlsIjoiZW1haWwtMjAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzk0MjYyMDh9.fFB93VD7H6wDK_A8U_rX-OjLaRteXv7asgzCd_7YnvQ" \
	-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": "0084a2fc-9753-4366-88c0-852a2376a175",
        "url": "/v2/service_brokers/0084a2fc-9753-4366-88c0-852a2376a175",
        "created_at": "2015-08-06T00:36:48Z",
        "updated_at": "2015-08-06T00:36:48Z"
      },
      "entity": {
        "name": "name-1878",
        "broker_url": "https://foo.com/url-55",
        "auth_username": "auth_username-46",
        "space_guid": "2123b730-e941-4438-87b7-0f82bdd78a62"
      }
    },
    {
      "metadata": {
        "guid": "e45a3410-e4af-4022-a45d-5efa7981f1e2",
        "url": "/v2/service_brokers/e45a3410-e4af-4022-a45d-5efa7981f1e2",
        "created_at": "2015-08-06T00:36:48Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1879",
        "broker_url": "https://foo.com/url-56",
        "auth_username": "auth_username-47",
        "space_guid": null
      }
    },
    {
      "metadata": {
        "guid": "49ec186e-ebd3-491e-9dc6-816a31b55b0e",
        "url": "/v2/service_brokers/49ec186e-ebd3-491e-9dc6-816a31b55b0e",
        "created_at": "2015-08-06T00:36:48Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1880",
        "broker_url": "https://foo.com/url-57",
        "auth_username": "auth_username-48",
        "space_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 70ead318-e8b0-4822-94ff-d20289f4184c
Content-Length: 1420
X-Content-Type-Options: nosniff