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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 38d229b5-cc1a-4cf9-b602-01c9f3f545cd
Content-Length: 1299
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "e6e65257-ee49-41b8-9bf7-297e50eaf69d",
        "url": "/v2/service_brokers/e6e65257-ee49-41b8-9bf7-297e50eaf69d",
        "created_at": "2014-12-24T01:39:30+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-1378",
        "broker_url": "https://foo.com/url-55",
        "auth_username": "auth_username-22"
      }
    },
    {
      "metadata": {
        "guid": "4747e6e7-ae7a-4402-b394-90adec7032c3",
        "url": "/v2/service_brokers/4747e6e7-ae7a-4402-b394-90adec7032c3",
        "created_at": "2014-12-24T01:39:30+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-1379",
        "broker_url": "https://foo.com/url-56",
        "auth_username": "auth_username-23"
      }
    },
    {
      "metadata": {
        "guid": "ab34b0e9-795b-4883-b327-101a719d9281",
        "url": "/v2/service_brokers/ab34b0e9-795b-4883-b327-101a719d9281",
        "created_at": "2014-12-24T01:39:30+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "name-1380",
        "broker_url": "https://foo.com/url-57",
        "auth_username": "auth_username-24"
      }
    }
  ]
}