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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTg1IiwiZW1haWwiOiJlbWFpbC03OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2NzAwfQ.ximo0VoTq9NMDF_Zc0cN7VfVNku0aBEJXi0uxLFHL1g
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.eyJ1c2VyX2lkIjoidWFhLWlkLTg1IiwiZW1haWwiOiJlbWFpbC03OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2NzAwfQ.ximo0VoTq9NMDF_Zc0cN7VfVNku0aBEJXi0uxLFHL1g" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 317ca78a-4270-4a5c-993d-8bd77c5551c9
Content-Length: 1293
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "8219b47f-3c44-4c04-954d-7483b77385f0",
        "url": "/v2/service_brokers/8219b47f-3c44-4c04-954d-7483b77385f0",
        "created_at": "2014-11-13T23:38:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-482",
        "broker_url": "https://foo.com/url-20",
        "auth_username": "auth_username-4"
      }
    },
    {
      "metadata": {
        "guid": "54baedc5-dcf4-4ef4-bf91-c6d0a1014321",
        "url": "/v2/service_brokers/54baedc5-dcf4-4ef4-bf91-c6d0a1014321",
        "created_at": "2014-11-13T23:38:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-483",
        "broker_url": "https://foo.com/url-21",
        "auth_username": "auth_username-5"
      }
    },
    {
      "metadata": {
        "guid": "62c32416-3ce9-467b-860b-d4ade0c21d8a",
        "url": "/v2/service_brokers/62c32416-3ce9-467b-860b-d4ade0c21d8a",
        "created_at": "2014-11-13T23:38:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-484",
        "broker_url": "https://foo.com/url-22",
        "auth_username": "auth_username-6"
      }
    }
  ]
}