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.eyJ1c2VyX2lkIjoidWFhLWlkLTMzIiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyNzc0OTc5fQ.lrU4gK2-awPdOfRbTKlOMOj-5sICZoZQeC3VHC_Cwnc
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzIiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyNzc0OTc5fQ.lrU4gK2-awPdOfRbTKlOMOj-5sICZoZQeC3VHC_Cwnc" \
	-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": "5b349eee-dc35-4633-89e5-bb93a49d49ac",
        "url": "/v2/service_brokers/5b349eee-dc35-4633-89e5-bb93a49d49ac",
        "created_at": "2015-05-21T01:02:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-158",
        "broker_url": "https://foo.com/url-25",
        "auth_username": "auth_username-19"
      }
    },
    {
      "metadata": {
        "guid": "a1a20e2a-3d06-4605-bd73-fb8db29393a6",
        "url": "/v2/service_brokers/a1a20e2a-3d06-4605-bd73-fb8db29393a6",
        "created_at": "2015-05-21T01:02:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-159",
        "broker_url": "https://foo.com/url-26",
        "auth_username": "auth_username-20"
      }
    },
    {
      "metadata": {
        "guid": "fd1a3281-3c0b-41b9-aa15-5d68f8ccd288",
        "url": "/v2/service_brokers/fd1a3281-3c0b-41b9-aa15-5d68f8ccd288",
        "created_at": "2015-05-21T01:02:59Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-160",
        "broker_url": "https://foo.com/url-27",
        "auth_username": "auth_username-21"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 510b0fd6-15ab-4f4c-98d4-24bf89b8ea42
Content-Length: 1281
X-Content-Type-Options: nosniff