APIHub
Back to Explore

Service Broker

The Service Broker API lets you create and manage GCP Service Brokers, list the services they expose, provision service instances, create and delete bindings to those instances, poll operation status, and control access via IAM policies.

Uncategorized
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

4416ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
DELETE

/v1beta1/{name}

Unbinds from a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If binding does not exist HTTP 410 status will be returned.

  • name (path, required) — Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `v2/service_instances/[INSTANCE_ID]/service_bindings/[BINDING_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `/instances/[INSTANCE_ID]/bindings/[BINDING_ID]`.
  • acceptsIncomplete (query) — See CreateServiceInstanceRequest for details.
  • planId (query) — The plan id of the service instance.
  • serviceId (query) — Additional query parameter hints. The service id of the service instance.
GET

/v1beta1/{name}

GetBinding returns the binding information.

  • name (path, required) — Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_bindings`.
  • planId (query) — Plan id.
  • serviceId (query) — Service id.
PATCH

/v1beta1/{name}

Updates an existing service instance. See CreateServiceInstance for possible response codes.

  • name (path, required) — Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`.
  • acceptsIncomplete (query) — See CreateServiceInstanceRequest for details.
GET

/v1beta1/{name}/last_operation

Returns the state of the last operation for the binding. Only last (or current) operation can be polled.

  • name (path, required) — Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`.
  • operation (query) — If `operation` was returned during mutation operation, this field must be populated with the provided value.
  • planId (query) — Plan id.
  • serviceId (query) — Service id.
GET

/v1beta1/{parent}/bindings

Lists all the bindings in the instance.

  • parent (path, required) — Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`.
  • pageSize (query, limit) — Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
  • pageToken (query) — Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.
GET

/v1beta1/{parent}/brokers

ListBrokers lists brokers.

  • parent (path, required) — Parent must match `projects/[PROJECT_ID]/brokers`.
  • pageSize (query, limit) — Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
  • pageToken (query) — Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.
POST

/v1beta1/{parent}/brokers

CreateBroker creates a Broker.

  • parent (path, required) — The project in which to create broker.
GET

/v1beta1/{parent}/instances

Lists 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.

  • parent (path, required) — Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`.
  • pageSize (query, limit) — Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
  • pageToken (query) — Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.
PUT

/v1beta1/{parent}/service_bindings/{binding_id}

CreateBinding generates a service binding to an existing service instance. See ProviServiceInstance for async operation details.

  • parent (path, required) — The GCP container. Must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`.
  • binding_id (path, required) — The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required.
  • acceptsIncomplete (query) — See CreateServiceInstanceRequest for details.
GET

/v1beta1/{parent}/v2/catalog

Lists all the Services registered with this broker for consumption for given service registry broker, which contains an set of services. Note, that Service producer API is separate from Broker API.

  • parent (path, required) — Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`.
  • pageSize (query, limit) — Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned.
  • pageToken (query) — Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.
PUT

/v1beta1/{parent}/v2/service_instances/{instance_id}

Provisions a service instance. If `request.accepts_incomplete` is false and Broker cannot execute request synchronously HTTP 422 error will be returned along with FAILED_PRECONDITION status. If `request.accepts_incomplete` is true and the Broker decides to execute resource asynchronously then HTTP 202 response code will be returned and a valid polling operation in the response will be included. If Broker executes the request synchronously and it succeeds HTTP 201 response will be furnished. If identical instance exists, then HTTP 200 response will be returned. If an instance with identical ID but mismatching parameters exists, then HTTP 409 status code will be returned.

  • parent (path, required) — Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`.
  • instance_id (path, required) — The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required.
  • acceptsIncomplete (query) — Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous.
GET

/v1beta1/{resource}:getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • resource (path, required) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • options.requestedPolicyVersion (query) — Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.
POST

/v1beta1/{resource}:setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

  • resource (path, required) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
POST

/v1beta1/{resource}:testIamPermissions

Returns 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 error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • resource (path, required) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

14 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X DELETE \
  "https://servicebroker.googleapis.com/v1beta1/{name}"

servicebroker.googleapis.com · HTTPS only