Service Brokers API

List all Service Brokers

GET /v2/service_brokers

Fields

Name	Description	Default	Valid Values	Example Values

Parameters

Name	Description	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.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMiIsImVtYWlsIjoiZW1haWwtMTcyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzR9.PRdw4fGt-cKGveyKjeQnxDto671h2g5aAIS4xseg8r4
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.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMiIsImVtYWlsIjoiZW1haWwtMTcyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMzR9.PRdw4fGt-cKGveyKjeQnxDto671h2g5aAIS4xseg8r4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f59dc4f2-a266-445f-aa00-f430ab358db3
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": "2e69d88d-11d0-4b87-b270-cbe040adbe51",
        "url": "/v2/service_brokers/2e69d88d-11d0-4b87-b270-cbe040adbe51",
        "created_at": "2015-02-12T01:42:14Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1475",
        "broker_url": "https://foo.com/url-77",
        "auth_username": "auth_username-44"
      }
    },
    {
      "metadata": {
        "guid": "3f10722c-6bbe-4b6c-a817-a00d1d5ba8c2",
        "url": "/v2/service_brokers/3f10722c-6bbe-4b6c-a817-a00d1d5ba8c2",
        "created_at": "2015-02-12T01:42:14Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1476",
        "broker_url": "https://foo.com/url-78",
        "auth_username": "auth_username-45"
      }
    },
    {
      "metadata": {
        "guid": "fb9e2b34-c042-4319-afb8-6697701a34a5",
        "url": "/v2/service_brokers/fb9e2b34-c042-4319-afb8-6697701a34a5",
        "created_at": "2015-02-12T01:42:14Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1477",
        "broker_url": "https://foo.com/url-79",
        "auth_username": "auth_username-46"
      }
    }
  ]
}