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.eyJ1c2VyX2lkIjoidWFhLWlkLTk4IiwiZW1haWwiOiJlbWFpbC02OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDIyMzIzNTM1fQ.y9rfSOlBu1i32As9tr3E_DEsLXKSrYumH4WOd754p9g
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.eyJ1c2VyX2lkIjoidWFhLWlkLTk4IiwiZW1haWwiOiJlbWFpbC02OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDIyMzIzNTM1fQ.y9rfSOlBu1i32As9tr3E_DEsLXKSrYumH4WOd754p9g" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 688526d4-fe90-4951-be18-2cf5e8122bf8
Content-Length: 1291
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "ba053987-e254-479a-86d4-0f90882eff36",
        "url": "/v2/service_brokers/ba053987-e254-479a-86d4-0f90882eff36",
        "created_at": "2015-01-20T01:52:15+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-374",
        "broker_url": "https://foo.com/url-8",
        "auth_username": "auth_username-1"
      }
    },
    {
      "metadata": {
        "guid": "84779787-1813-40a7-84ee-311b6dc9af18",
        "url": "/v2/service_brokers/84779787-1813-40a7-84ee-311b6dc9af18",
        "created_at": "2015-01-20T01:52:15+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-375",
        "broker_url": "https://foo.com/url-9",
        "auth_username": "auth_username-2"
      }
    },
    {
      "metadata": {
        "guid": "39c2f611-c622-4820-befe-03ac0d07601d",
        "url": "/v2/service_brokers/39c2f611-c622-4820-befe-03ac0d07601d",
        "created_at": "2015-01-20T01:52:15+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-376",
        "broker_url": "https://foo.com/url-10",
        "auth_username": "auth_username-3"
      }
    }
  ]
}