Service Brokers API

List all Service Brokers

GET /v2/service_brokers

Request

Route

GET /v2/service_brokers

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, space_guid	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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NSIsImVtYWlsIjoiZW1haWwtMTgwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE4MDN9.XJdKgOzEUn397bpzdbsENJcnDKDP4J86yiF4rBlAgi0
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NSIsImVtYWlsIjoiZW1haWwtMTgwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE4MDN9.XJdKgOzEUn397bpzdbsENJcnDKDP4J86yiF4rBlAgi0" \
	-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": "b52de6f1-15dd-4069-8b42-f052cc9333fc",
        "url": "/v2/service_brokers/b52de6f1-15dd-4069-8b42-f052cc9333fc",
        "created_at": "2015-07-27T22:43:23Z",
        "updated_at": "2015-07-27T22:43:23Z"
      },
      "entity": {
        "name": "name-980",
        "broker_url": "https://foo.com/url-39",
        "auth_username": "auth_username-39",
        "space_guid": "4f34c35e-be0d-409e-9279-1ccd7058c5d8"
      }
    },
    {
      "metadata": {
        "guid": "812e9e7f-b5b0-4587-ba3c-b4a7c574fb88",
        "url": "/v2/service_brokers/812e9e7f-b5b0-4587-ba3c-b4a7c574fb88",
        "created_at": "2015-07-27T22:43:23Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-981",
        "broker_url": "https://foo.com/url-40",
        "auth_username": "auth_username-40",
        "space_guid": null
      }
    },
    {
      "metadata": {
        "guid": "93e760c4-ff3d-447a-9cff-a17f4454eaee",
        "url": "/v2/service_brokers/93e760c4-ff3d-447a-9cff-a17f4454eaee",
        "created_at": "2015-07-27T22:43:23Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-982",
        "broker_url": "https://foo.com/url-41",
        "auth_username": "auth_username-41",
        "space_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f72fbb1b-bc3a-413e-b630-b3ecc47ab875
Content-Length: 1417
X-Content-Type-Options: nosniff