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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: a2ea27d2-7d1e-4386-893b-ed8f30315943
Content-Length: 1284
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "67118daa-8666-47d2-9714-abcbfedfc2ec",
        "url": "/v2/service_brokers/67118daa-8666-47d2-9714-abcbfedfc2ec",
        "created_at": "2015-02-13T22:35:07Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1939",
        "broker_url": "https://foo.com/url-85",
        "auth_username": "auth_username-50"
      }
    },
    {
      "metadata": {
        "guid": "242479de-8545-4092-9e27-838ffa67264c",
        "url": "/v2/service_brokers/242479de-8545-4092-9e27-838ffa67264c",
        "created_at": "2015-02-13T22:35:07Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1940",
        "broker_url": "https://foo.com/url-86",
        "auth_username": "auth_username-51"
      }
    },
    {
      "metadata": {
        "guid": "dc0c3b88-d3f0-4b58-859a-2fd86716c875",
        "url": "/v2/service_brokers/dc0c3b88-d3f0-4b58-859a-2fd86716c875",
        "created_at": "2015-02-13T22:35:07Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1941",
        "broker_url": "https://foo.com/url-87",
        "auth_username": "auth_username-52"
      }
    }
  ]
}