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.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NyIsImVtYWlsIjoiZW1haWwtMjQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDF9.xNfOpOrIIwWA1xDXpNr2GM5Tvfpvj0hQ-3oP_5T9SgE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NyIsImVtYWlsIjoiZW1haWwtMjQ5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDF9.xNfOpOrIIwWA1xDXpNr2GM5Tvfpvj0hQ-3oP_5T9SgE" \
	-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": "aefb54c3-d97f-4e16-8324-087266f61af5",
        "url": "/v2/service_brokers/aefb54c3-d97f-4e16-8324-087266f61af5",
        "created_at": "2016-04-16T01:24:01Z",
        "updated_at": "2016-04-16T01:24:01Z"
      },
      "entity": {
        "name": "name-1142",
        "broker_url": "https://foo.com/url-68",
        "auth_username": "auth_username-49",
        "space_guid": "4c12de84-90f9-4537-92f4-328cd5d49aeb"
      }
    },
    {
      "metadata": {
        "guid": "26c86157-6d0a-48dd-b6fd-6d8b458e5b24",
        "url": "/v2/service_brokers/26c86157-6d0a-48dd-b6fd-6d8b458e5b24",
        "created_at": "2016-04-16T01:24:01Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1143",
        "broker_url": "https://foo.com/url-69",
        "auth_username": "auth_username-50",
        "space_guid": null
      }
    },
    {
      "metadata": {
        "guid": "6c7cef6c-0be9-41de-8ce3-5cb187d8d6ce",
        "url": "/v2/service_brokers/6c7cef6c-0be9-41de-8ce3-5cb187d8d6ce",
        "created_at": "2016-04-16T01:24:01Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1144",
        "broker_url": "https://foo.com/url-70",
        "auth_username": "auth_username-51",
        "space_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 11f091bd-f623-46df-add7-13848d772826
Content-Length: 1420
X-Content-Type-Options: nosniff