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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ5IiwiZW1haWwiOiJlbWFpbC00OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU2NDUyMjIyfQ.dfwzPSzkGHi_tONxQw6wnvM5nJkHYQTqm3yTDdoX9Q4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ5IiwiZW1haWwiOiJlbWFpbC00OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU2NDUyMjIyfQ.dfwzPSzkGHi_tONxQw6wnvM5nJkHYQTqm3yTDdoX9Q4" \
	-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": "06f87669-f756-411b-955e-182f5a08ad7a",
        "url": "/v2/service_brokers/06f87669-f756-411b-955e-182f5a08ad7a",
        "created_at": "2016-02-19T02:03:42Z",
        "updated_at": "2016-02-19T02:03:42Z"
      },
      "entity": {
        "name": "name-192",
        "broker_url": "https://foo.com/url-14",
        "auth_username": "auth_username-14",
        "space_guid": "1aee4e32-08e3-41b7-94b1-4e983d224d9d"
      }
    },
    {
      "metadata": {
        "guid": "c97bbd02-1365-4a66-a65a-5433c96853f3",
        "url": "/v2/service_brokers/c97bbd02-1365-4a66-a65a-5433c96853f3",
        "created_at": "2016-02-19T02:03:42Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-193",
        "broker_url": "https://foo.com/url-15",
        "auth_username": "auth_username-15",
        "space_guid": null
      }
    },
    {
      "metadata": {
        "guid": "8a251859-a141-4c77-8d0b-970722d9c9b0",
        "url": "/v2/service_brokers/8a251859-a141-4c77-8d0b-970722d9c9b0",
        "created_at": "2016-02-19T02:03:42Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-194",
        "broker_url": "https://foo.com/url-16",
        "auth_username": "auth_username-16",
        "space_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1417
X-Content-Type-Options: nosniff