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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3IiwiZW1haWwiOiJlbWFpbC0xN0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI5MDM4Njk2fQ.gkJ2elSQR02fN9icZQdgZpL342vRyJWPv4n626H120k
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3IiwiZW1haWwiOiJlbWFpbC0xN0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI5MDM4Njk2fQ.gkJ2elSQR02fN9icZQdgZpL342vRyJWPv4n626H120k" \
	-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": "cc35fc35-89c4-42d1-86c6-706ea6f128f8",
        "url": "/v2/service_brokers/cc35fc35-89c4-42d1-86c6-706ea6f128f8",
        "created_at": "2015-04-07T19:11:36Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-56",
        "broker_url": "https://foo.com/url-12",
        "auth_username": "auth_username-12"
      }
    },
    {
      "metadata": {
        "guid": "52494d6a-850b-4727-b6c4-2cdc60f2a09e",
        "url": "/v2/service_brokers/52494d6a-850b-4727-b6c4-2cdc60f2a09e",
        "created_at": "2015-04-07T19:11:36Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-57",
        "broker_url": "https://foo.com/url-13",
        "auth_username": "auth_username-13"
      }
    },
    {
      "metadata": {
        "guid": "eefcac34-8854-4067-9755-dcffb82116f1",
        "url": "/v2/service_brokers/eefcac34-8854-4067-9755-dcffb82116f1",
        "created_at": "2015-04-07T19:11:36Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-58",
        "broker_url": "https://foo.com/url-14",
        "auth_username": "auth_username-14"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: efd666ee-a1dd-41dd-ab1f-dd7d97a65c3b
Content-Length: 1278
X-Content-Type-Options: nosniff