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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MyIsImVtYWlsIjoiZW1haWwtMTgwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk3OTB9.1xnwOYGjOnC8qN7CZRd5EPBK4es_HUMJ1VhhgDJuI1U
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MyIsImVtYWlsIjoiZW1haWwtMTgwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk3OTB9.1xnwOYGjOnC8qN7CZRd5EPBK4es_HUMJ1VhhgDJuI1U" \
	-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": "957ee99b-f000-4d2e-b3d9-ee40f671d875",
        "url": "/v2/service_brokers/957ee99b-f000-4d2e-b3d9-ee40f671d875",
        "created_at": "2015-07-06T23:23:10Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1628",
        "broker_url": "https://foo.com/url-61",
        "auth_username": "auth_username-58"
      }
    },
    {
      "metadata": {
        "guid": "9d70d93b-eea7-48f3-a167-c6d9d7f310cc",
        "url": "/v2/service_brokers/9d70d93b-eea7-48f3-a167-c6d9d7f310cc",
        "created_at": "2015-07-06T23:23:10Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1629",
        "broker_url": "https://foo.com/url-62",
        "auth_username": "auth_username-59"
      }
    },
    {
      "metadata": {
        "guid": "1d49f977-0552-47ae-ae94-bafb3a8ab53a",
        "url": "/v2/service_brokers/1d49f977-0552-47ae-ae94-bafb3a8ab53a",
        "created_at": "2015-07-06T23:23:10Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1630",
        "broker_url": "https://foo.com/url-63",
        "auth_username": "auth_username-60"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 0b6300f4-d9a1-4555-899c-db6b66398857
Content-Length: 1284
X-Content-Type-Options: nosniff