Revision as of 13:38, 31 October 2018

APIs
Open Service Broker API

Overview

The open service broker API is used by service brokers; the brokers of services available to developers to supplement their applications.
It allows service brokers to register services, configure, manage, etc.

Manual Queries

Queries are structured like so:

~$  curl http://username:password@service-broker-url/v2/catalog -H "X-Broker-API-Version: 2.14"

The components are:

curl  -   command used.
http://username:password   -   username and password for the service broker placed inline with the GET request
@service-broker-url   -   the service broker URL specific to the service deployed.
/v2/catalog   -   the service broker API endpoint
-H "X-Broker-API-Version: 2.14"   -    A required header for the request that must declare the version number of the Open Service Broker API that the platform is using.

In order to manually query the service broker API endpoints, you will need to gather the credentials used to register the service. As of today, PAS 2.3, these credentials are stored within the BOSH credhub instance in Cloud Foundry.