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.eyJ1c2VyX2lkIjoidWFhLWlkLTUwIiwiZW1haWwiOiJlbWFpbC00OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2NjMzODk3fQ.VOhxhHhPK6m3H-5rZ2_eJYfuJQ6uYlxG0NylnoWRVik
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTUwIiwiZW1haWwiOiJlbWFpbC00OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI2NjMzODk3fQ.VOhxhHhPK6m3H-5rZ2_eJYfuJQ6uYlxG0NylnoWRVik" \
	-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": "9f009fbc-42ad-47ae-9157-fc5e47591724",
        "url": "/v2/service_brokers/9f009fbc-42ad-47ae-9157-fc5e47591724",
        "created_at": "2015-03-10T23:11:37Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-200",
        "broker_url": "https://foo.com/url-23",
        "auth_username": "auth_username-23"
      }
    },
    {
      "metadata": {
        "guid": "63ec8dbc-2955-417d-933b-fedd6701d6f0",
        "url": "/v2/service_brokers/63ec8dbc-2955-417d-933b-fedd6701d6f0",
        "created_at": "2015-03-10T23:11:37Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-201",
        "broker_url": "https://foo.com/url-24",
        "auth_username": "auth_username-24"
      }
    },
    {
      "metadata": {
        "guid": "f813272c-8de5-4ffd-b557-a47002dbd728",
        "url": "/v2/service_brokers/f813272c-8de5-4ffd-b557-a47002dbd728",
        "created_at": "2015-03-10T23:11:37Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-202",
        "broker_url": "https://foo.com/url-25",
        "auth_username": "auth_username-25"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: dec7cba7-5f4b-48d2-bc8e-1d7ea8d63d41
Content-Length: 1281
X-Content-Type-Options: nosniff