Get the catalog of services that the service broker offers
get
/openservicebroker/v2/catalog
Returns the Open Service Broker catalog for the associated database pool.
Request
Supported Media Types
- application/json
Header Parameters
-
X-Broker-API-Originating-Identity(optional): string
The identity of the Platform user that initiated the request from the Platform. The value for this header consists of two parts which are described in the Open Service Broker specification.
-
X-Broker-API-Request-Identity(optional): string
A Platform might wish to uniquely identify a specific request as it flows throughout the system. This header holds that request tracking information.
-
X-Broker-API-Version: string
The version number of the Service Broker API that the Platform will use.
Response
Supported Media Types
- application/json
200 Response
List of all services available on the Service Broker.
Root Schema : OpenServiceBrokerCatalog
Type:
object
Title:
OpenServiceBrokerCatalog
This object is a list of all services available on the Service Broker.
Show Source
Nested Schema : services
Type:
Show Source
array
-
Array of:
object OpenServiceBrokerService
Title:
OpenServiceBrokerService
This object is a list of all services available on the Service Broker.
Nested Schema : OpenServiceBrokerService
Type:
object
Title:
OpenServiceBrokerService
This object is a list of all services available on the Service Broker.
Show Source
-
bindable(optional):
boolean
Specifies whether Service Instances of the service can be bound to applications. This specifies the default for all Service Plans of this Service Offering.
-
description(optional):
string
A short description of the service.
-
id(optional):
string
An identifier used to correlate this Service Offering in future requests to the Service Broker. This MUST be globally unique such that Platforms (and their users) MUST be able to assume that seeing the same value (no matter what Service Broker uses it) will always refer to this Service Offering.
-
metadata(optional):
object metadata
-
name(optional):
string
The name of the Service Offering.
-
plans(optional):
array plans
-
tags(optional):
array tags
Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service, enabling equivalent services to be swapped out without changes to dependent logic in applications, buildpacks, or other services.
Nested Schema : metadata
Type:
object
Match All
Show Source
-
object
Metadata
Title:
Metadata
An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details. -
An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.
Nested Schema : plans
Type:
Show Source
array
-
Array of:
object OpenServiceBrokerPlan
Title:
OpenServiceBrokerPlan
The representation of the costs and benefits for a given variant of the Service Offering, potentially as a tier.
Nested Schema : Metadata
Type:
object
Title:
Metadata
An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.
Show Source
-
displayName(optional):
string
The name of the service to be displayed in graphical clients.
-
documentationUrl(optional):
string
Link to documentation page for the service.
-
imageUrl(optional):
string
TThe URL to an image or a data URL containing an image.
-
longDescription(optional):
string
Long description of the Service Offering.
-
providerDisplayName(optional):
string
The name of the upstream entity providing the actual service.
-
supportUrl(optional):
string
Link to support page for the service.
Nested Schema : OpenServiceBrokerPlan
Type:
object
Title:
OpenServiceBrokerPlan
The representation of the costs and benefits for a given variant of the Service Offering, potentially as a tier.
Show Source
-
description(optional):
string
A short description of the Service Plan.
-
free(optional):
boolean
When false, Service Instances of this Service Plan have a cost. The default is true.
-
id(optional):
string
An identifier used to correlate this Plan in future requests to the Service Broker. This MUST be globally unique such that Platforms (and their users) MUST be able to assume that seeing the same value (no matter what Service Broker uses it) will always refer to this Service Plan.
-
metadata(optional):
object metadata
-
name(optional):
string
The name of the Service Plan.
-
schemas(optional):
object schemas
Nested Schema : metadata
Type:
object
Match All
Show Source
-
object
Metadata1
Title:
Metadata1
An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details. -
An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.
Nested Schema : schemas
Type:
object
Match All
Show Source
-
object
OpenServiceBrokerSchemas
Title:
OpenServiceBrokerSchemas
Schema definitions for Service Instances for the Service Plan. Note that Service Bindings not defined in this release. -
Schema definitions for Service Instances for the Service Plan. Note that Service Bindings not defined in this release.
Nested Schema : Metadata1
Type:
object
Title:
Metadata1
An opaque object of metadata for a Service Offering which aid in the display of catalog data. See [Service Metadata Conventions](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata) for more details.
Show Source
-
bullets(optional):
array bullets
Features of this Service Plan, to be displayed in a bulleted-list.
-
displayName(optional):
string
The name of the Service Plan to be displayed in graphical clients.
Nested Schema : bullets
Type:
array
Features of this Service Plan, to be displayed in a bulleted-list.
Show Source
Nested Schema : OpenServiceBrokerSchemas
Type:
object
Title:
OpenServiceBrokerSchemas
Schema definitions for Service Instances for the Service Plan. Note that Service Bindings not defined in this release.
Show Source
Nested Schema : service_instance
Type:
object
Match All
Show Source
-
object
OpenServiceBrokerServiceInstanceSchema
Title:
OpenServiceBrokerServiceInstanceSchema
The schema definitions for creating and updating a Service Instance. -
The schema definitions for creating and updating a Service Instance.
Nested Schema : OpenServiceBrokerServiceInstanceSchema
Type:
object
Title:
OpenServiceBrokerServiceInstanceSchema
The schema definitions for creating and updating a Service Instance.
Show Source
Nested Schema : create
Type:
object
Match All
Show Source
-
object
OpenServiceBrokerSchemaParameters
Title:
OpenServiceBrokerSchemaParameters
The schema definitions for providing parameters to a Service Broker operation. -
The schema definitions for providing parameters to a Service Broker operation.
Nested Schema : OpenServiceBrokerSchemaParameters
Type:
object
Title:
OpenServiceBrokerSchemaParameters
The schema definitions for providing parameters to a Service Broker operation.
Show Source
-
parameters(optional):
object parameters
The schema definition for the input parameters. Each input parameter is expressed as a property within a JSON object.
Nested Schema : parameters
Type:
object
The schema definition for the input parameters. Each input parameter is expressed as a property within a JSON object.