Service Broker API

by googleapis.com

Overview

The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/).

Service Broker is a development API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 14 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Development
Base URL: https://servicebroker.googleapis.com/
Version: v1beta1
Endpoints: 14
OpenAPI: Specification ↗
Spec updated: 2020-01-07

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://servicebroker.googleapis.com/v1beta1/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://servicebroker.googleapis.com/v1beta1/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://servicebroker.googleapis.com/v1beta1/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/v1beta1/{name}`	GetBinding returns the binding information.
PATCH	`/v1beta1/{name}`	Updates an existing service instance.
DELETE	`/v1beta1/{name}`	Unbinds from a service instance.
GET	`/v1beta1/{name}/last_operation`	Returns the state of the last operation for the binding.
GET	`/v1beta1/{parent}/bindings`	Lists all the bindings in the instance.
GET	`/v1beta1/{parent}/brokers`	ListBrokers lists brokers.
POST	`/v1beta1/{parent}/brokers`	CreateBroker creates a Broker.
GET	`/v1beta1/{parent}/instances`	Lists all the instances in the brokers
PUT	`/v1beta1/{parent}/service_bindings/{binding_id}`	CreateBinding generates a service binding to an existing service instance.
GET	`/v1beta1/{parent}/v2/catalog`	Lists all the Services registered with this broker for consumption for
PUT	`/v1beta1/{parent}/v2/service_instances/{instance_id}`	Provisions a service instance.
GET	`/v1beta1/{resource}:getIamPolicy`	Gets the access control policy for a resource.
POST	`/v1beta1/{resource}:setIamPolicy`	Sets the access control policy on the specified resource. Replaces any
POST	`/v1beta1/{resource}:testIamPermissions`	Returns permissions that a caller has on the specified resource.