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, 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.eyJ1c2VyX2lkIjoidWFhLWlkLTMxMCIsImVtYWlsIjoiZW1haWwtMjE2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTN9.zKV6yPMZpS2v_XWw9cwrcdqn-q-D7_1jN68O07mA3i4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMxMCIsImVtYWlsIjoiZW1haWwtMjE2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTN9.zKV6yPMZpS2v_XWw9cwrcdqn-q-D7_1jN68O07mA3i4" \
	-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": "af3e75ea-4cf7-4996-bb5e-4c333d0f0aa8",
        "url": "/v2/service_brokers/af3e75ea-4cf7-4996-bb5e-4c333d0f0aa8",
        "created_at": "2015-12-22T18:28:13Z",
        "updated_at": "2015-12-22T18:28:13Z"
      },
      "entity": {
        "name": "name-1038",
        "broker_url": "https://foo.com/url-61",
        "auth_username": "auth_username-39",
        "space_guid": "9e6ac814-1237-4583-bb03-eb5e6aadd918"
      }
    },
    {
      "metadata": {
        "guid": "4ec2413a-5bb4-4e08-933c-aa23b5777575",
        "url": "/v2/service_brokers/4ec2413a-5bb4-4e08-933c-aa23b5777575",
        "created_at": "2015-12-22T18:28:13Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1039",
        "broker_url": "https://foo.com/url-62",
        "auth_username": "auth_username-40",
        "space_guid": null
      }
    },
    {
      "metadata": {
        "guid": "413dbae9-01bf-466d-aff4-334c938f9a6e",
        "url": "/v2/service_brokers/413dbae9-01bf-466d-aff4-334c938f9a6e",
        "created_at": "2015-12-22T18:28:13Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1040",
        "broker_url": "https://foo.com/url-63",
        "auth_username": "auth_username-41",
        "space_guid": null
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1420
X-Content-Type-Options: nosniff