Jump to

• Request
• Response

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

Header Parameters

• X-Broker-API-Originating-Identity:
  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:
  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(required):
  The version number of the Service Broker API that the Platform will use.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of all services available on the Service Broker.

Body ()

Root Schema : OpenServiceBrokerCatalog

Type: object

This object is a list of all services available on the Service Broker.

Show Source

• services: array services

{
    "type":"object",
    "description":"This object is a list of all services available on the Service Broker.",
    "properties":{
        "services":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OpenServiceBrokerService"
            }
        }
    }
}

Nested Schema : services

Type: array

Show Source

• Array of: object OpenServiceBrokerService
  This object is a list of all services available on the Service Broker.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OpenServiceBrokerService"
    }
}

Nested Schema : OpenServiceBrokerService

Type: object

This object is a list of all services available on the Service Broker.

Show Source

• bindable: 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: string
  A short description of the service.
• id: 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: object 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.
• name: string
  The name of the Service Offering.
• plans: array plans
• tags: 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.

{
    "type":"object",
    "description":"This object is a list of all services available on the Service Broker.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the Service Offering."
        },
        "id":{
            "type":"string",
            "description":"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."
        },
        "description":{
            "type":"string",
            "description":"A short description of the service."
        },
        "bindable":{
            "type":"boolean",
            "description":"Specifies whether Service Instances of the service can be bound to applications. This specifies the default for all Service Plans of this Service Offering."
        },
        "tags":{
            "type":"array",
            "description":"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.",
            "items":{
                "type":"string"
            }
        },
        "metadata":{
            "type":"object",
            "description":"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.",
            "properties":{
                "displayName":{
                    "type":"string",
                    "description":"The name of the service to be displayed in graphical clients."
                },
                "documentationUrl":{
                    "type":"string",
                    "description":"Link to documentation page for the service."
                },
                "imageUrl":{
                    "type":"string",
                    "description":"TThe URL to an image or a data URL containing an image."
                },
                "longDescription":{
                    "type":"string",
                    "description":"Long description of the Service Offering."
                },
                "providerDisplayName":{
                    "type":"string",
                    "description":"The name of the upstream entity providing the actual service."
                },
                "supportUrl":{
                    "type":"string",
                    "description":"Link to support page for the service."
                }
            }
        },
        "plans":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OpenServiceBrokerPlan"
            }
        }
    }
}

Nested Schema : metadata

Type: object

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: string
  The name of the service to be displayed in graphical clients.
• documentationUrl: string
  Link to documentation page for the service.
• imageUrl: string
  TThe URL to an image or a data URL containing an image.
• longDescription: string
  Long description of the Service Offering.
• providerDisplayName: string
  The name of the upstream entity providing the actual service.
• supportUrl: string
  Link to support page for the service.

{
    "type":"object",
    "description":"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.",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"The name of the service to be displayed in graphical clients."
        },
        "documentationUrl":{
            "type":"string",
            "description":"Link to documentation page for the service."
        },
        "imageUrl":{
            "type":"string",
            "description":"TThe URL to an image or a data URL containing an image."
        },
        "longDescription":{
            "type":"string",
            "description":"Long description of the Service Offering."
        },
        "providerDisplayName":{
            "type":"string",
            "description":"The name of the upstream entity providing the actual service."
        },
        "supportUrl":{
            "type":"string",
            "description":"Link to support page for the service."
        }
    }
}

Nested Schema : plans

Type: array

Show Source

• Array of: object OpenServiceBrokerPlan
  The representation of the costs and benefits for a given variant of the Service Offering, potentially as a tier.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OpenServiceBrokerPlan"
    }
}

Nested Schema : tags

Type: array

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.

Show Source

• Array of: string

{
    "type":"array",
    "description":"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.",
    "items":{
        "type":"string"
    }
}

Nested Schema : OpenServiceBrokerPlan

Type: object

The representation of the costs and benefits for a given variant of the Service Offering, potentially as a tier.

Show Source

• description: string
  A short description of the Service Plan.
• free: boolean
  When false, Service Instances of this Service Plan have a cost. The default is true.
• id: 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: object 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.
• name: string
  The name of the Service Plan.
• schemas: object OpenServiceBrokerSchemas
  Schema definitions for Service Instances for the Service Plan. Note that Service Bindings not defined in this release.

{
    "type":"object",
    "description":"The representation of the costs and benefits for a given variant of the Service Offering, potentially as a tier.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the Service Plan."
        },
        "id":{
            "type":"string",
            "description":"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."
        },
        "description":{
            "type":"string",
            "description":"A short description of the Service Plan."
        },
        "free":{
            "type":"boolean",
            "description":"When false, Service Instances of this Service Plan have a cost. The default is true."
        },
        "metadata":{
            "type":"object",
            "description":"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.",
            "properties":{
                "displayName":{
                    "type":"string",
                    "description":"The name of the Service Plan to be displayed in graphical clients."
                },
                "bullets":{
                    "type":"array",
                    "description":"Features of this Service Plan, to be displayed in a bulleted-list.",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "schemas":{
            "$ref":"#/components/schemas/OpenServiceBrokerSchemas"
        }
    }
}

Nested Schema : metadata

Type: object

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: array bullets
  Features of this Service Plan, to be displayed in a bulleted-list.
• displayName: string
  The name of the Service Plan to be displayed in graphical clients.

{
    "type":"object",
    "description":"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.",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"The name of the Service Plan to be displayed in graphical clients."
        },
        "bullets":{
            "type":"array",
            "description":"Features of this Service Plan, to be displayed in a bulleted-list.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : OpenServiceBrokerSchemas

Type: object

Schema definitions for Service Instances for the Service Plan. Note that Service Bindings not defined in this release.

Show Source

• service_instance: object OpenServiceBrokerServiceInstanceSchema
  The schema definitions for creating and updating a Service Instance.

{
    "type":"object",
    "description":"Schema definitions for Service Instances for the Service Plan. Note that Service Bindings not defined in this release.",
    "properties":{
        "service_instance":{
            "$ref":"#/components/schemas/OpenServiceBrokerServiceInstanceSchema"
        }
    }
}

Nested Schema : bullets

Type: array

Features of this Service Plan, to be displayed in a bulleted-list.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Features of this Service Plan, to be displayed in a bulleted-list.",
    "items":{
        "type":"string"
    }
}

Nested Schema : OpenServiceBrokerServiceInstanceSchema

Type: object

The schema definitions for creating and updating a Service Instance.

Show Source

• create: object OpenServiceBrokerSchemaParameters
  The schema definitions for providing parameters to a Service Broker operation.

{
    "type":"object",
    "description":"The schema definitions for creating and updating a Service Instance.",
    "properties":{
        "create":{
            "$ref":"#/components/schemas/OpenServiceBrokerSchemaParameters"
        }
    }
}

Nested Schema : OpenServiceBrokerSchemaParameters

Type: object

The schema definitions for providing parameters to a Service Broker operation.

Show Source

• parameters: object parameters
  The schema definition for the input parameters. Each input parameter is expressed as a property within a JSON object.

{
    "type":"object",
    "description":"The schema definitions for providing parameters to a Service Broker operation.",
    "properties":{
        "parameters":{
            "description":"The schema definition for the input parameters. Each input parameter is expressed as a property within a JSON object.",
            "type":"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.

Back to Top