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.eyJ1c2VyX2lkIjoidWFhLWlkLTMxMyIsImVtYWlsIjoiZW1haWwtMjQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5NzR9.AcLvnfcpREDLrWvI7Xi-9v84fJQ2hqMn82ceDu8YbHI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxMyIsImVtYWlsIjoiZW1haWwtMjQ0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjczMjM5NzR9.AcLvnfcpREDLrWvI7Xi-9v84fJQ2hqMn82ceDu8YbHI" \
	-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": "0512119a-50fc-470e-9489-bf2d1485b7de",
        "url": "/v2/service_brokers/0512119a-50fc-470e-9489-bf2d1485b7de",
        "created_at": "2015-03-18T22:52:54Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1187",
        "broker_url": "https://foo.com/url-43",
        "auth_username": "auth_username-37"
      }
    },
    {
      "metadata": {
        "guid": "d5500c9a-6a23-4c4c-9b3a-c0e5237368b2",
        "url": "/v2/service_brokers/d5500c9a-6a23-4c4c-9b3a-c0e5237368b2",
        "created_at": "2015-03-18T22:52:54Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1188",
        "broker_url": "https://foo.com/url-44",
        "auth_username": "auth_username-38"
      }
    },
    {
      "metadata": {
        "guid": "07a576ab-ada1-47b3-a1a4-2ef09d24bf0f",
        "url": "/v2/service_brokers/07a576ab-ada1-47b3-a1a4-2ef09d24bf0f",
        "created_at": "2015-03-18T22:52:54Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1189",
        "broker_url": "https://foo.com/url-45",
        "auth_username": "auth_username-39"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 1e9cf69a-917c-42de-80c6-71d0a45c4740
Content-Length: 1284
X-Content-Type-Options: nosniff