Google

Service Broker

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

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 14

projects

  • GETservicebroker.projects.brokers.v2.service_instances.service_bindings.get/v1beta1/:name?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&planId=string&serviceId=stringGetBinding returns the binding information.
  • DELETEservicebroker.projects.brokers.v2.service_instances.service_bindings.delete/v1beta1/:name?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&acceptsIncomplete=true&planId=string&serviceId=stringUnbinds from a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If binding does not exist HTTP 410 status will…
  • PATCHservicebroker.projects.brokers.v2.service_instances.patch/v1beta1/:name?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&acceptsIncomplete=trueUpdates an existing service instance. See CreateServiceInstance for possible response codes.
  • GETservicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation/v1beta1/:name/last_operation?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&operation=string&planId=string&serviceId=stringReturns the state of the last operation for the binding. Only last (or current) operation can be polled.
  • GETservicebroker.projects.brokers.instances.bindings.list/v1beta1/:parent/bindings?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&pageSize=0&pageToken=stringLists all the bindings in the instance.
  • GETservicebroker.projects.brokers.list/v1beta1/:parent/brokers?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&pageSize=0&pageToken=stringListBrokers lists brokers.
  • POSTservicebroker.projects.brokers.create/v1beta1/:parent/brokers?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=trueCreateBroker creates a Broker.
  • GETservicebroker.projects.brokers.instances.list/v1beta1/:parent/instances?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&pageSize=0&pageToken=stringLists all the instances in the brokers This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL.
  • PUTservicebroker.projects.brokers.v2.service_instances.service_bindings.create/v1beta1/:parent/service_bindings/:binding_id?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&acceptsIncomplete=trueCreateBinding generates a service binding to an existing service instance. See ProviServiceInstance for async operation details.
  • GETservicebroker.projects.brokers.v2.catalog.list/v1beta1/:parent/v2/catalog?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&pageSize=0&pageToken=stringLists all the Services registered with this broker for consumption for given service registry broker, which contains an set of services. Note, that Service…
  • PUTservicebroker.projects.brokers.v2.service_instances.create/v1beta1/:parent/v2/service_instances/:instance_id?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&acceptsIncomplete=trueProvisions a service instance. If request.accepts_incomplete is false and Broker cannot execute request synchronously HTTP 422 error will be returned along…

v1beta1

  • GETservicebroker.getIamPolicy/v1beta1/:resource:getIamPolicy?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • POSTservicebroker.setIamPolicy/v1beta1/:resource:setIamPolicy?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=trueSets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and…
  • POSTservicebroker.testIamPermissions/v1beta1/:resource:testIamPermissions?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=trueReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND…

API details

Base URL
https://servicebroker.googleapis.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
OAuth 2.0 (authorization code flow) with 1 scope
Operations
14 operations on 11 pathsGET 7POST 3PUT 2PATCH 1DELETE 1
Main resources
projects 11v1beta1 3
Response formats
*/*
Description format
OpenAPI 3.0.0, API version v1beta1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Service Broker in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Service Broker collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “servicebroker.projects.brokers.v2.service_instances.service_bindings.get” (GET /v1beta1/:name?fields=string&uploadType=string&callback=string&oauth_token=string&$.xgafv=1&alt=json&access_token=string&key=string&upload_protocol=string&quotaUser=string&prettyPrint=true&planId=string&serviceId=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Service Broker?

The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/). It is listed under Developer tools and has 14 endpoints.

Who publishes the Service Broker?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Service Broker?

Requests go to https://servicebroker.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Service Broker?

It accepts 2 methods: OAuth 2.0 (implicit flow) with 1 scope; OAuth 2.0 (authorization code flow) with 1 scope.

How many endpoints does the Service Broker have?

14 operations on 11 paths (7 GET, 3 POST, 2 PUT, 1 PATCH, 1 DELETE). The largest groups are projects, v1beta1.

Is forking the Service Broker free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.