- API Overview
- Notations and Terminology
- Changes
- API Version Header
- Authentication
- URL Properties
- Originating Identity
- Catalog Management
- Synchronous and Asynchronous Operations
- Blocking Operations
- Polling Last Operation
- Provisioning
- Updating a Service Instance
- Binding
- Unbinding
- Deprovisioning
- Service Broker Errors
- Orphans
The Service Broker API defines an HTTP interface between the services marketplace of a platform and Service Brokers.
The Service Broker is the component of the service that implements the Service Broker API, for which a platform's marketplace is a client. Service brokers are responsible for advertising a catalog of service offerings and service plans to the marketplace, and acting on requests from the marketplace for provisioning, binding, unbinding, and deprovisioning.
In general, provisioning reserves a resource on a service; we call this reserved resource a service instance. What a service instance represents can vary by service. Examples include a single database on a multi-tenant server, a dedicated cluster, or an account on a web application.
What a binding represents MAY also vary by service. In general creation of a binding either generates credentials necessary for accessing the resource or provides the service instance with information for a configuration change.
A platform marketplace MAY expose services from one or many Service Brokers, and an individual Service Broker MAY support one or many platform marketplaces using different URL prefixes and credentials.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
This specification defines the following terms:
-
Application: Often the entity using a Service Instance will be a piece of software, however, this does not need to be the case. For the purposes of this specification, the term "Application" will be used to represent all entities that might make use of, and be bound to, a Service Instance.
-
Marketplace: An aggregation of Services provided by Service Brokers curated and presented to end users of a Platform.
-
Platform: The software that will manage the cloud environment into which Applications and Service Brokers are provisioned. Users will not directly provision Services from Service Brokers, rather they will ask the Platform (ie. their cloud provider) to manage Services and interact with the Service Brokers for them.
-
Service: A managed software offering that can be used by an Application. Typically, Services will expose some API that can be invoked to perform some action. However, there can also be non-interactive Services that can perform the desired actions without direct prompting from the Application.
-
Service Binding: Represents the request to use a Service Instance. As part of this request there might be a reference to the entity, also known as the Application, that will use the Service Instance. Service Bindings will often contain the credentials that can then be used to communicate with the Service Instance.
-
Service Broker: Service Brokers manage the lifecycle of Services. Platforms interact with Service Brokers to provision, and manage, Service Instances and Service Bindings.
-
Service Instance: An instantiation of a Service offering.
-
Service Offering: The advertisement of a service that a Service Broker supports.
-
Service Plan: The representation of the costs and benefits for a given variant of the service, potentially as a tier.
- Existing endpoints and fields MUST NOT be removed or renamed.
- New OPTIONAL endpoints, or new HTTP methods for existing endpoints, MAY be added to enable support for new features.
- New fields MAY be added to existing request/response messages. These fields MUST be OPTIONAL and SHOULD be ignored by clients and servers that do not understand them.
- Added
schemasfield to services in the catalog that Service Brokers can use to declare the configuration parameters their service accepts for creating a service instance, updating a service instance and creating a service binding. - Added
contextfield to request body for creating a service binding. - Added warning text about using characters outside of the "Unreserved Characters" set in IDs.
- Added information about
volume_mountsobjects. instance_idandbinding_idMUST be globally unique non-empty strings.- Allow non-BasicAuth authentication mechanisms.
- Added a Getting Started page including sample Service Brokers.
- Define what a CLI-friendly string is.
- Add service/plan metadata conventions.
- Add originating identity HTTP header.
For changes in older versions, see the release notes.
Requests from the platform to the Service Broker MUST contain a header that declares the version number of the Service Broker API that the marketplace will use:
X-Broker-API-Version: 2.13
The version numbers are in the format MAJOR.MINOR using semantic versioning.
This header allows Service Brokers to reject requests from marketplaces for
versions they do not support. While minor API revisions will always be
additive, it is possible that Service Brokers depend on a feature from a newer
version of the API that is supported by the platform. In this scenario the
Service Broker MAY reject the request with 412 Precondition Failed and
provide a message that informs the operator of the API version that is to be
used instead.
While the communication between a platform and Service Broker MAY be unsecure, it is RECOMMENDED that all communications between a platform and a service broker are secured via TLS and authenticated.
Unless there is some out of band communication and agreement between a
platform and a Service Broker, the marketplace MUST authenticate with the
Service Broker using HTTP basic authentication (the Authorization: header)
on every request. This specification does not specify how platform and service
brokers agree on other methods of authentication.
If authentication is used, the Service Broker MUST authenticate the request
using the predetermined authentication mechanism and MUST return a 401 Unauthorized response if the authentication fails.
Note: Using an authentication mechanism that is agreed to via out of band communications could lead to interoperability issues with other platforms.
This specification defines the following properties that might appear within URLs:
service_idplan_idinstance_idbinding_idoperation
While this specification places no restriction on the set of characters used within these strings, it is RECOMMENDED that these properties only contain characters from the "Unreserved Characters" as defined by RFC3986. In other words: uppercase and lowercase letters, decimal digits, hyphen, period, underscore and tilde.
If a character outside of the "Unreserved Characters" set is used, then it SHOULD be percent-encoded prior to being used as part of the HTTP request, per RFC3986.
Often a Service Broker will need to know the identity of the user that initiated the request from the platform. For example, this might be needed for auditing or authorization purposes. In order to facilitate this, the platform will need to provide this identification information to the Service Broker on each request. Platforms MAY support this feature, and if they do, they MUST adhere to the following:
- For any OSB API request that is the result of an action taken by
a platform's user, there MUST be an associated
OriginatingIdentityheader on that HTTP request. - Any OSB API request that is not associated with an action from a platform's user, such as the platform querying the marketplace, MAY exclude the header from that HTTP request.
- If present on a request, the
OriginatingIdentityheader MUST contain the identify information for the platform's user that took the action to cause the request to be sent.
The format of the header MUST be:
X-Broker-API-Originating-Identity: platform value
platform MUST be a non-empty string indicating the platform from which
the request is being sent. The specific value SHOULD match the values
defined in the profile document for the context.platform
property. When context is sent as part of a message, this value MUST
be the same as the context.platform value.
value MUST be a Base64 encoded string. The string MUST be a serialized
JSON object. The specific properties will be platform specific - see
the profile document for more information.
For example:
X-Broker-API-Originating-Identity: cloudfoundry eyANCiAgInVzZXJfaWQiOiAiNjgzZWE3NDgtMzA5Mi00ZmY0LWI2NTYtMzljYWNjNGQ1MzYwIiwNCiAgInVzZXJfbmFtZSI6ICJqb2VAZXhhbXBsZS5jb20iDQp9
Where the value, when decoded, is:
{
"user_id": "683ea748-3092-4ff4-b656-39cacc4d5360"
}
Note that not all messages sent to a Service Broker are initiated by an end-user of the platform. For example, during orphan mitigation or during the querying of the Service Broker's catalog, the platform might not have an end-user with which to associate the request, therefore in those cases the originating identity header would not be included in those messages.
The first endpoint that a platform will interact with on the Service Broker is
the service catalog (/v2/catalog). This endpoint returns a list of all
services available on the Service Broker. Platforms query this endpoint from
all Service Brokers in order to present an aggregated user-facing catalog.
Periodically, a platform MAY re-query the service catalog endpoint for a Service Broker to see if there are any changes to the list of services. Service brokers MAY add, remove or modify (metadata, plans, etc.) the list of services from previous queries.
When determining what, if anything, has changed on a Service Broker, the
platform will use the id of the resources (services or plans) as the only
immutable property and MUST use that to locate the same resource as was
returned from a previous query. Likewise, a Service Broker MUST NOT change the
id of a resource across queries, otherwise a platform will treat it as a
different resource.
When a platform receives different id values for the same type of resource,
even if all of the other metadata in those resources are the exact same, it
MUST treat them as separate instances of that resource.
Service broker authors are expected to be cautious when removing services and plans from their catalogs, as platforms might have provisioned service instances of these plans. For example, platforms might restrict the actions that users can perform on existing service instances if the associated service or plan is deleted. Consider your deprecation strategy.
The following sections describe catalog requests and responses in the Service Broker API.
GET /v2/catalog
The following HTTP Headers are defined for this operation:
| Header | Type | Description |
|---|---|---|
| X-Broker-API-Version* | string | See API Version Header. |
* Headers with an asterisk are REQUIRED.
$ curl http://username:password@service-broker-url/v2/catalog -H "X-Broker-API-Version: 2.13"
| Status Code | Description |
|---|---|
| 200 OK | MUST be returned upon successful processing of this request. The expected response body is below. |
CLI clients will typically have restrictions on how names, such as service and plan names, will be provided by users. Therefore, this specification defines a "CLI-friendly" string as a short string that MUST only use lowercase characters, numbers and hyphens, with no spaces. This will make it easier for users when they have to type it as an argument on the command line.
| Response field | Type | Description |
|---|---|---|
| services* | array-of-service-objects | Schema of service objects defined below. MAY be empty. |
| Response field | Type | Description |
|---|---|---|
| name* | string | A CLI-friendly name of the service. MUST only contain lowercase characters, numbers and hyphens (no spaces). MUST be unique across all service objects returned in this response. MUST be a non-empty string. |
| id* | string | An identifier used to correlate this service in future requests to the Service Broker. This MUST be globally unique. MUST be a non-empty string. Using a GUID is RECOMMENDED. |
| description* | string | A short description of the service. MUST be a non-empty string. |
| tags | array-of-strings | 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. E.g. mysql, relational, redis, key-value, caching, messaging, amqp. |
| requires | array-of-strings | A list of permissions that the user would have to give the service, if they provision it. The only permissions currently supported are syslog_drain, route_forwarding and volume_mount. |
| bindable* | boolean | Specifies whether service instances of the service can be bound to applications. This specifies the default for all plans of this service. Plans can override this field (see Plan Object). |
| metadata | object | An opaque object of metadata for a service offering. Controller treats this as a blob. Note that there are conventions in existing Service Brokers and controllers for fields that aid in the display of catalog data. |
| dashboard_client | object | Contains the data necessary to activate the Dashboard SSO feature for this service. |
| plan_updateable | boolean | Whether the service supports upgrade/downgrade for some plans. Please note that the misspelling of the attribute plan_updatable as plan_updateable was done by mistake. We have opted to keep that misspelling instead of fixing it and thus breaking backward compatibility. Defaults to false. |
| plans* | array-of-objects | A list of plans for this service, schema is defined below. MUST contain at least one plan. |
Note: Platforms will typically use the service name as an input parameter from their users to indicate which service they want to instantiate. Therefore, it is important that these values be unique for all services within a platform's marketplace. To achieve this goal service providers often will prefix their service names with some unique value (such as the name of their company). Additionally, some platforms might modify the service names before presenting them to their users. This specification places no requirements on how platforms might expose these values to their users.
| Response field | Type | Description |
|---|---|---|
| id | string | The id of the Oauth client that the dashboard will use. If present, MUST be a non-empty string. |
| secret | string | A secret for the dashboard client. If present, MUST be a non-empty string. |
| redirect_uri | string | A URI for the service dashboard. Validated by the OAuth token server when the dashboard requests a token. |
| Response field | Type | Description |
|---|---|---|
| id* | string | An identifier used to correlate this plan in future requests to the Service Broker. This MUST be globally unique. MUST be a non-empty string. Using a GUID is RECOMMENDED. |
| name* | string | The CLI-friendly name of the plan. MUST only contain lowercase characters, numbers and hyphens (no spaces). MUST be unique within the service. MUST be a non-empty string. |
| description* | string | A short description of the plan. MUST be a non-empty string. |
| metadata | object | An opaque object of metadata for a service plan. Controller treats this as a blob. Note that there are conventions in existing Service Brokers and controllers for fields that aid in the display of catalog data. |
| free | boolean | When false, service instances of this plan have a cost. The default is true. |
| bindable | boolean | Specifies whether service instances of the service plan can be bound to applications. This field is OPTIONAL. If specified, this takes precedence over the bindable attribute of the service. If not specified, the default is derived from the service. |
| schemas | object | Schema definitions for service instances and bindings for the plan. |
* Fields with an asterisk are REQUIRED.
| Response field | Type | Description |
|---|---|---|
| service_instance | object | The schema definitions for creating and updating a service instance. |
| service_binding | object | The schema definition for creating a service binding. Used only if the service plan is bindable. |
| Response field | Type | Description |
|---|---|---|
| create | object | The schema definition for creating a service instance. |
| update | object | The schema definition for updating a service instance. |
| Response field | Type | Description |
|---|---|---|
| create | object | The schema definition for creating a service binding. |
| Response field | Type | Description |
|---|---|---|
| parameters | JSON schema object | The schema definition for the input parameters. Each input parameter is expressed as a property within a JSON object. |
The following rules apply if parameters is included anywhere in the catalog:
- Platforms MUST support at least JSON Schema draft v4.
- Platforms SHOULD be prepared to support later versions of JSON schema.
- The
$schemakey MUST be present in the schema declaring the version of JSON schema being used. - Schemas MUST NOT contain any external references.
- Schemas MUST NOT be larger than 64kB.
{
"services": [{
"name": "fake-service",
"id": "acb56d7c-XXXX-XXXX-XXXX-feb140a59a66",
"description": "fake service",
"tags": ["no-sql", "relational"],
"requires": ["route_forwarding"],
"bindable": true,
"metadata": {
"provider": {
"name": "The name"
},
"listing": {
"imageUrl": "http://example.com/cat.gif",
"blurb": "Add a blurb here",
"longDescription": "A long time ago, in a galaxy far far away..."
},
"displayName": "The Fake Service Broker"
},
"dashboard_client": {
"id": "398e2f8e-XXXX-XXXX-XXXX-19a71ecbcf64",
"secret": "277cabb0-XXXX-XXXX-XXXX-7822c0a90e5d",
"redirect_uri": "http://localhost:1234"
},
"plan_updateable": true,
"plans": [{
"name": "fake-plan-1",
"id": "d3031751-XXXX-XXXX-XXXX-a42377d3320e",
"description": "Shared fake Server, 5tb persistent disk, 40 max concurrent connections",
"free": false,
"metadata": {
"max_storage_tb": 5,
"costs":[
{
"amount":{
"usd":99.0
},
"unit":"MONTHLY"
},
{
"amount":{
"usd":0.99
},
"unit":"1GB of messages over 20GB"
}
],
"bullets": [
"Shared fake server",
"5 TB storage",
"40 concurrent connections"
]
},
"schemas": {
"service_instance": {
"create": {
"parameters": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"billing-account": {
"description": "Billing account number used to charge use of shared fake server.",
"type": "string"
}
}
}
},
"update": {
"parameters": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"billing-account": {
"description": "Billing account number used to charge use of shared fake server.",
"type": "string"
}
}
}
}
},
"service_binding": {
"create": {
"parameters": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"billing-account": {
"description": "Billing account number used to charge use of shared fake server.",
"type": "string"
}
}
}
}
}
}
}, {
"name": "fake-plan-2",
"id": "0f4008b5-XXXX-XXXX-XXXX-dace631cd648",
"description": "Shared fake Server, 5tb persistent disk, 40 max concurrent connections. 100 async",
"free": false,
"metadata": {
"max_storage_tb": 5,
"costs":[
{
"amount":{
"usd":199.0
},
"unit":"MONTHLY"
},
{
"amount":{
"usd":0.99
},
"unit":"1GB of messages over 20GB"
}
],
"bullets": [
"40 concurrent connections"
]
}
}]
}]
}
After implementing the first endpoint GET /v2/catalog documented
above, the Service Broker will need to be registered
with your platform to make your services and plans available to end users.
Platforms expect prompt responses to all API requests in order to provide users with fast feedback. Service broker authors SHOULD implement their Service Brokers to respond promptly to all requests but will need to decide whether to implement synchronous or asynchronous responses. Service brokers that can guarantee completion of the requested operation with the response SHOULD return the synchronous response. Service brokers that cannot guarantee completion of the operation with the response SHOULD implement the asynchronous response.
Providing a synchronous response for a provision, update, or bind operation before actual completion causes confusion for users as their service might not be usable and they have no way to find out when it will be. Asynchronous responses set expectations for users that an operation is in progress and can also provide updates on the status of the operation.
Support for synchronous or asynchronous responses MAY vary by service offering, even by service plan.
To execute a request synchronously, the Service Broker need only return the
usual status codes: 201 Created for provision and bind, and 200 OK for
update, unbind, and deprovision.
Service brokers that support synchronous responses for provision, update, and
delete can ignore the accepts_incomplete=true query parameter if it is
provided by the client.
Note: Asynchronous operations are currently supported only for provision, update, and deprovision.
For a Service Broker to return an asynchronous response, the query parameter
accepts_incomplete=true MUST be included the request. If the parameter is
not included or is set to false, and the Service Broker cannot fulfill the
request synchronously (guaranteeing that the operation is complete on
response), then the Service Broker SHOULD reject the request with the status
code 422 Unprocessable Entity and the following body
(see Service Broker Errors):
{
"error": "AsyncRequired",
"description": "This service plan requires client support for asynchronous service operations."
}
If the query parameter described above is present, and the Service Broker
executes the request asynchronously, the Service Broker MUST return the
asynchronous response 202 Accepted. The response body SHOULD be the same as
if the Service Broker were serving the request synchronously.
An asynchronous response triggers the platform marketplace to poll the
endpoint GET /v2/service_instances/:instance_id/last_operation until the
Service Broker indicates that the requested operation has succeeded or failed.
Service brokers MAY include a status message with each response for the
last_operation endpoint that provides visibility to end users as to the
progress of the operation.
Service Brokers do not have to support concurrent requests that mutate the
same resource. If a Service Broker receives a request that it is not
able to process due to other activity being done on that resource then the
Service Broker MUST reject the request with a HTTP 422 Unprocessable Entity error and the following body (see Service Broker Errors:
{
"error": "ConcurrencyError",
"description": "Another operation for this service instance is in progress"
}
Note that per the Orphans section, this error response does not cause orphan mitigation to be initiated. Therefore, platforms receiving this error response SHOULD resend the request at a later time.
Brokers MAY choose to treat the creation of a binding as a mutation of the corresponding service instance - it is an implementation choice. Doing so would cause platforms to serialize multiple binding creation requests when they are directed at the same service instance if concurrent updates are not supported.
When a Service Broker returns status code 202 Accepted for
Provision, Update, or
Deprovision, the platform will begin polling the
/v2/service_instances/:instance_id/last_operation endpoint to obtain the
state of the last requested operation. The Service Broker response MUST
contain the field state and MAY contain the field description.
Valid values for state are in progress, succeeded, and failed. The
platform will poll the last_operation endpoint as long as the Service Broker
returns "state": "in progress". Returning "state": "succeeded" or
"state": "failed" will cause the platform to cease polling. The value
provided for description will be passed through to the platform API client
and can be used to provide additional detail for users about the progress of
the operation.
GET /v2/service_instances/:instance_id/last_operation
:instance_id MUST be a globally unique non-empty string.
The request provides these query string parameters as useful hints for Service Brokers.
| Query-String Field | Type | Description |
|---|---|---|
| service_id | string | If present, it MUST be the ID of the service being used. |
| plan_id | string | If present, it MUST be the ID of the plan for the service being use. |
| operation | string | A Service Broker-provided identifier for the operation. When a value for operation is included with asynchronous responses for Provision, Update, and Deprovision requests, the platform MUST provide the same value using this query parameter as a percent-encoded string. If present, MUST be a non-empty string. |
Note: Although the request query parameters service_id and plan_id are not
mandatory, the platform SHOULD include them on all last_operation requests
it makes to Service Brokers.
The following HTTP Headers are defined for this operation:
| Header | Type | Description |
|---|---|---|
| X-Broker-API-Version* | string | See API Version Header. |
* Headers with an asterisk are REQUIRED.
$ curl http://username:password@service-broker-url/v2/service_instances/:instance_id/last_operation -H "X-Broker-API-Version: 2.13"
| Status Code | Description |
|---|---|
| 200 OK | MUST be returned upon successful processing of this request. The expected response body is below. |
| 400 Bad Request | MUST be returned if the request is malformed or missing mandatory data. |
| 410 Gone | Appropriate only for asynchronous delete operations. The platform MUST consider this response a success and remove the resource from its database. The expected response body is {}. Returning this while the platform is polling for create or update operations SHOULD be interpreted as an invalid response and the platform SHOULD continue polling. |
Responses with any other status code SHOULD be interpreted as an error or
invalid response. The platform SHOULD continue polling until the service
broker returns a valid response or the maximum polling
duration is reached. Service brokers MAY use
the description field to expose user-facing error messages about the
operation state; for more info see Service Broker
Errors.
All response bodies MUST be a valid JSON Object ({}). This is for future
compatibility; it will be easier to add fields in the future if JSON is
expected rather than to support the cases when a JSON body might or might not
be returned.
For success responses, the following fields are valid.
| Response field | Type | Description |
|---|---|---|
| state* | string | Valid values are in progress, succeeded, and failed. While "state": "in progress", the platform SHOULD continue polling. A response with "state": "succeeded" or "state": "failed" MUST cause the platform to cease polling. |
| description | string | A user-facing message displayed to the platform API client. Can be used to tell the user details about the status of the operation. If present, MUST be a non-empty string. |
* Fields with an asterisk are REQUIRED.
{
"state": "in progress",
"description": "Creating service (10% complete)."
}
The frequency and maximum duration of polling MAY vary by platform client. If
a platform has a max polling duration and this limit is reached, the platform
MUST cease polling and the operation state MUST be considered failed.
When the Service Broker receives a provision request from the platform, it MUST take whatever action is necessary to create a new resource. What provisioning represents varies by service and plan, although there are several common use cases. For a MySQL service, provisioning could result in an empty dedicated database server running on its own VM or an empty schema on a shared database server. For non-data services, provisioning could just mean an account on an multi-tenant SaaS application.
PUT /v2/service_instances/:instance_id
:instance_id MUST be a globally unique non-empty string.
This ID will be used for future requests (bind and deprovision), so the
Service Broker will use it to correlate the resource it creates.
| Parameter name | Type | Description |
|---|---|---|
| accepts_incomplete | boolean | A value of true indicates that the marketplace and its clients support asynchronous Service Broker operations. If this parameter is not included in the request, and the Service Broker can only provision a service instance of the requested plan asynchronously, the Service Broker MUST reject the request with a 422 Unprocessable Entity as described below. |
The following HTTP Headers are defined for this operation:
| Header | Type | Description |
|---|---|---|
| X-Broker-API-Version* | string | See API Version Header. |
| X-Broker-API-Originating-Identity | string | See Originating Identity. |
* Headers with an asterisk are REQUIRED.
| Request field | Type | Description |
|---|---|---|
| service_id* | string | MUST be the ID of a service from the catalog for this Service Broker. |
| plan_id* | string | MUST be the ID of a plan from the service that has been requested. |
| context | object | Platform specific contextual information under which the service instance is to be provisioned. Although most Service Brokers will not use this field, it could be helpful in determining data placement or applying custom business rules. context will replace organization_guid and space_guid in future versions of the specification - in the interim both SHOULD be used to ensure interoperability with old and new implementations. |
| organization_guid* | string | Deprecated in favor of context. The platform GUID for the organization under which the service instance is to be provisioned. Although most Service Brokers will not use this field, it might be helpful for executing operations on a user's behalf. MUST be a non-empty string. |
| space_guid* | string | Deprecated in favor of context. The identifier for the project space within the platform organization. Although most Service Brokers will not use this field, it might be helpful for executing operations on a user's behalf. MUST be a non-empty string. |
| parameters | object | Configuration options for the service instance. Service brokers SHOULD ensure that the client has provided valid configuration parameters and values for the operation. |
* Fields with an asterisk are REQUIRED.
{
"service_id": "service-id-here",
"plan_id": "plan-id-here",
"context": {
"platform": "cloudfoundry",
"some_field": "some-contextual-data"
},
"organization_guid": "org-guid-here",
"space_guid": "space-guid-here",
"parameters": {
"parameter1": 1,
"parameter2": "foo"
}
}
$ curl http://username:password@service-broker-url/v2/service_instances/:instance_id?accepts_incomplete=true -d '{
"service_id": "service-id-here",
"plan_id": "plan-id-here",
"context": {
"platform": "cloudfoundry",
"some_field": "some-contextual-data"
},
"organization_guid": "org-guid-here",
"space_guid": "space-guid-here",
"parameters": {
"parameter1": 1,
"parameter2": "foo"
}
}' -X PUT -H "X-Broker-API-Version: 2.13" -H "Content-Type: application/json"
| Status Code | Description |
|---|---|
| 200 OK | MUST be returned if the service instance already exists, is fully provisioned, and the requested parameters are identical to the existing service instance. The expected response body is below. |
| 201 Created | MUST be returned if the service instance was provisioned as a result of this request. The expected response body is below. |
| 202 Accepted | MUST be returned if the service instance provisioning is in progress. This triggers the platform marketplace to poll the Service Instance Last Operation Endpoint for operation status. Note that a re-sent PUT request MUST return a 202 Accepted, not a 200 OK, if the service instance is not yet fully provisioned. |
| 400 Bad Request | MUST be returned if the request is malformed or missing mandatory data. |
| 409 Conflict | MUST be returned if a service instance with the same id already exists but with different attributes. The expected response body is {}, though the description field MAY be used to return a user-facing error message, as described in Service Broker Errors. |
| 422 Unprocessable Entity | MUST be returned if the Service Broker only supports asynchronous provisioning for the requested plan and the request did not include ?accepts_incomplete=true. The expected response body is: { "error": "AsyncRequired", "description": "This service plan requires client support for asynchronous service operations." }, as described below (see Service Broker Errors. |
Responses with any other status code will be interpreted as a failure. Service brokers can include a user-facing message in the description field; for details see Service Broker Errors.
All response bodies MUST be a valid JSON Object ({}). This is for future
compatibility; it will be easier to add fields in the future if JSON is
expected rather than to support the cases when a JSON body might or might not
be returned.
For success responses, a Service Broker MUST return the following fields. For error responses, see Service Broker Errors.
| Response field | Type | Description |
|---|---|---|
| dashboard_url | string | The URL of a web-based management user interface for the service instance; we refer to this as a service dashboard. The URL MUST contain enough information for the dashboard to identify the resource being accessed (9189kdfsk0vfnku in the example below). Note: a Service Broker that wishes to return dashboard_url for a service instance MUST return it with the initial response to the provision request, even if the service is provisioned asynchronously. If present, MUST be a non-empty string. |
| operation | string | For asynchronous responses, Service Brokers MAY return an identifier representing the operation. The value of this field MUST be provided by the platform with requests to the Last Operation endpoint in a percent-encoded query parameter. If present, MUST be a non-empty string. |
* Fields with an asterisk are REQUIRED.
{
"dashboard_url": "http://example-dashboard.example.com/9189kdfsk0vfnku",
"operation": "task_10"
}
By implementing this endpoint, Service Broker authors can enable users to modify two attributes of an existing service instance: the service plan and parameters. By changing the service plan, users can upgrade or downgrade their service instance to other plans. By modifying parameters, users can change configuration options that are specific to a service or plan.
To enable support for the update of the plan, a Service Broker MUST declare
support per service by including plan_updateable: true in its catalog
endpoint.
Not all permutations of plan changes are expected to be supported. For example, a service might support upgrading from plan "shared small" to "shared large" but not to plan "dedicated". It is up to the Service Broker to validate whether a particular permutation of plan change is supported. If a particular plan change is not supported, the Service Broker SHOULD return a meaningful error message in response.
PATCH /v2/service_instances/:instance_id
:instance_id MUST be the ID a previously provisioned service instance.
| Parameter name | Type | Description |
|---|---|---|
| accepts_incomplete | boolean | A value of true indicates that the marketplace and its clients support asynchronous Service Broker operations. If this parameter is not included in the request, and the Service Broker can only provision a service instance of the requested plan asynchronously, the Service Broker SHOULD reject the request with a 422 Unprocessable Entity as described below. |
The following HTTP Headers are defined for this operation:
| Header | Type | Description |
|---|---|---|
| X-Broker-API-Version* | string | See API Version Header. |
| X-Broker-API-Originating-Identity | string | See Originating Identity. |
* Headers with an asterisk are REQUIRED.
| Request Field | Type | Description |
|---|---|---|
| context | object | Contextual data under which the service instance is created. |
| service_id* | string | MUST be the ID of a service from the catalog for this Service Broker. |
| plan_id | string | If present, MUST be the ID of a plan from the service that has been requested. If this field is not present in the request message, then the Service Broker MUST NOT change the plan of the instance as a result of this request. |
| parameters | object | Configuration options for the service instance. Service brokers SHOULD ensure that the client has provided valid configuration parameters and values for the operation. If this field is not present in the request message, then the Service Broker MUST NOT change the parameters of the instance as a result of this request. |
| previous_values | object | Information about the service instance prior to the update. |
| previous_values.service_id | string | Deprecated; determined to be unnecessary as the value is immutable. If present, it MUST be the ID of the service for the service instance. |
| previous_values.plan_id | string | If present, it MUST be the ID of the plan prior to the update. |
| previous_values.organization_id | string | Deprecated as it was redundant information. Organization for the service instance MUST be provided by platforms in the top-level field context. If present, it MUST be the ID of the organization specified for the service instance. |
| previous_values.space_id | string | Deprecated as it was redundant information. Space for the service instance MUST be provided by platforms in the top-level field context. If present, it MUST be the ID of the space specified for the service instance. |
* Fields with an asterisk are REQUIRED.
{
"context": {
"platform": "cloudfoundry",
"some_field": "some-contextual-data"
},
"service_id": "service-id-here",
"plan_id": "plan-id-here",
"parameters": {
"parameter1": 1,
"parameter2": "foo"
},
"previous_values": {
"plan_id": "old-plan-id-here",
"service_id": "service-id-here",
"organization_id": "org-guid-here",
"space_id": "space-guid-here"
}
}
$ curl http://username:password@service-broker-url/v2/service_instances/:instance_id?accepts_incomplete=true -d '{
"context": {
"platform": "cloudfoundry",
"some_field": "some-contextual-data"
},
"service_id": "service-id-here",
"plan_id": "plan-id-here",
"parameters": {
"parameter1": 1,
"parameter2": "foo"
},
"previous_values": {
"plan_id": "old-plan-id-here",
"service_id": "service-id-here",
"organization_id": "org-guid-here",
"space_id": "space-guid-here"
}
}' -X PATCH -H "X-Broker-API-Version: 2.13" -H "Content-Type: application/json"
| Status Code | Description |
|---|---|
| 200 OK | MUST be returned if the request's changes have been applied. The expected response body is {}. |
| 202 Accepted | MUST be returned if the service instance update is in progress. This triggers the platform marketplace to poll the Last Operation for operation status. Note that a re-sent PATCH request MUST return a 202 Accepted, not a 200 OK, if the requested update has not yet completed. |
| 400 Bad Request | MUST be returned if the request is malformed or missing mandatory data. |
| 422 Unprocessable entity | MUST be returned if the requested change is not supported or if the request cannot currently be fulfilled due to the state of the service instance (e.g. service instance utilization is over the quota of the requested plan). Service Brokers SHOULD include a user-facing message in the body; for details see Service Broker Errors. Additionally, a 422 Unprocessable Entity can also be returned if the Service Broker only supports asynchronous update for the requested plan and the request did not include ?accepts_incomplete=true; in this case the expected response body is: { "error": "AsyncRequired", "description": "This service plan requires client support for asynchronous service operations." } (see Service Broker Errors. |
Responses with any other status code will be interpreted as a failure. Service brokers can include a user-facing message in the description field; for details see Service Broker Errors.
All response bodies MUST be a valid JSON Object ({}). This is for future
compatibility; it will be easier to add fields in the future if JSON is
expected rather than to support the cases when a JSON body might or might not
be returned.
For success responses, a Service Broker MUST return the following field. Others will be ignored. For error responses, see Service Broker Errors.
| Response field | Type | Description |
|---|---|---|
| operation | string | For asynchronous responses, Service Brokers MAY return an identifier representing the operation. The value of this field MUST be provided by the platform with requests to the Last Operation endpoint in a percent-encoded query parameter. If present, MUST be a non-empty string. |
* Fields with an asterisk are REQUIRED.
{
"operation": "task_10"
}
If bindable:true is declared for a service or plan in the
Catalog endpoint, the platform MAY request generation
of a service binding.
Note: Not all services need to be bindable --- some deliver value just from
being provisioned. Service brokers that offer services that are bindable MUST
declare them as such using bindable: true in the
Catalog. Service brokers that do not offer any bindable
services do not need to implement the endpoint for bind requests.
Credentials are a set of information used by an application or a user to
utilize the service instance. If the Service Broker supports generation of
credentials it MUST return credentials in the response for a request to
create a service binding. Credentials SHOULD be unique whenever possible, so
access can be revoked for each binding without affecting consumers of other
bindings for the service instance.
There are a class of service offerings that provide aggregation, indexing, and
analysis of log data. To utilize these services an application that generates
logs needs information for the location to which it will stream logs. A create
binding response from a Service Broker that provides one of these services
MUST include a syslog_drain_url. The platform MUST use the
syslog_drain_url value when sending logs to the service.
Service brokers MUST NOT include a syslog_drain_url in a create binding
response if the associated Catalog entry for the
service did not include a "requires":["syslog_drain"] property.
There are a class of service offerings that intermediate requests to applications, performing functions such as rate limiting or authorization.
If a platform supports route services, it MUST send a routable address, or
endpoint, for the application along with the request to create a service
binding using "bind_resource":{"route":"some-address.com"}. A Service Broker
MAY support configuration specific to an address using parameters; exposing
this feature to users would require a platform to support binding multiple
routable addresses to the same service instance.
If a service is deployed in a configuration to support this behavior, the
Service Broker MUST return a route_service_url in the response for a request
to create a binding, so that the platform knows where to proxy the application
request. If the service is deployed such that the network configuration to
proxy application requests through instances of the service is managed
out-of-band, the Service Broker MUST NOT return route_service_url in the
response.
Service brokers MUST NOT include a route_service_url in a create binding
response if the associated Catalog entry for the
service did not include a "requires":["route_forwarding"] property.
There are a class of services that provide network storage to applications
via volume mounts in the application container. A create binding response
from one of these services MUST include volume_mounts.
Service brokers MUST NOT include volume_mounts in a create binding response
if the associated Catalog entry for the service
did not include a "requires":["volume_mount"] property.
PUT /v2/service_instances/:instance_id/service_bindings/:binding_id
:instance_id MUST be the ID of a previously provisioned service instance.
:binding_id MUST be a globally unique non-empty string.
This ID will be used for future unbind requests, so the Service Broker will use
it to correlate the resource it creates.
The following HTTP Headers are defined for this operation:
| Header | Type | Description |
|---|---|---|
| X-Broker-API-Version* | string | See API Version Header. |
| X-Broker-API-Originating-Identity | string | See Originating Identity. |
* Headers with an asterisk are REQUIRED.
| Request Field | Type | Description |
|---|---|---|
| context | object | Contextual data under which the service binding is created. |
| service_id* | string | MUST be the ID of the service that is being used. |
| plan_id* | string | MUST be the ID of the plan from the service that is being used. |
| app_guid | string | Deprecated in favor of bind_resource.app_guid. GUID of an application associated with the binding to be created. If present, MUST be a non-empty string. |
| bind_resource | object | A JSON object that contains data for platform resources associated with the binding to be created. See Bind Resource Object for more information. |
| parameters | object | Configuration options for the service binding. Service brokers SHOULD ensure that the client has provided valid configuration parameters and values for the operation. |
The bind_resource object contains platform specific information related to
the context in which the service will be used. In some cases the platform
might not be able to provide this information at the time of the binding
request, therefore the bind_resource and its fields are OPTIONAL.
Below are some common fields that MAY be used. Platforms MAY choose to add additional ones as needed.
| Request Field | Type | Description |
|---|---|---|
| app_guid | string | GUID of an application associated with the binding. For credentials bindings. MUST be unique within the scope of the platform. |
| route | string | URL of the application to be intermediated. For route services bindings. |
app_guid represents the scope to which the binding will apply within
the platform. For example, in Cloud Foundry it might map to an "application"
while in Kubernetes it might map to a "namespace". The scope of what a
platform maps the app_guid to is platform specific and MAY vary across
binding requests.
* Fields with an asterisk are REQUIRED.
{
"context": {
"platform": "cloudfoundry",
"some_field": "some-contextual-data"
},
"service_id": "service-id-here",
"plan_id": "plan-id-here",
"bind_resource": {
"app_guid": "app-guid-here"
},
"parameters": {
"parameter1-name-here": 1,
"parameter2-name-here": "parameter2-value-here"
}
}
$ curl http://username:password@service-broker-url/v2/service_instances/:instance_id/service_bindings/:binding_id -d '{
"context": {
"platform": "cloudfoundry",
"some_field": "some-contextual-data"
},
"service_id": "service-id-here",
"plan_id": "plan-id-here",
"bind_resource": {
"app_guid": "app-guid-here"
},
"parameters": {
"parameter1-name-here": 1,
"parameter2-name-here": "parameter2-value-here"
}
}' -X PUT -H "X-Broker-API-Version: 2.13" -H "Content-Type: application/json"
| Status Code | Description |
|---|---|
| 200 OK | MUST be returned if the binding already exists and the requested parameters are identical to the existing binding. The expected response body is below. |
| 201 Created | MUST be returned if the binding was created as a result of this request. The expected response body is below. |
| 400 Bad Request | MUST be returned if the request is malformed or missing mandatory data. |
| 409 Conflict | MUST be returned if a service binding with the same id, for the same service instance, already exists but with different parameters. The expected response body is {}, though the description field MAY be used to return a user-facing error message, as described in Service Broker Errors. Additionally, if the Service Broker rejects the request due to a concurrent request to create a binding for the same service instance, then this error MUST be returned (see Blocking Operations). |
| 422 Unprocessable Entity | MUST be returned if the Service Broker requires that app_guid be included in the request body. The expected response body is: { "error": "RequiresApp", "description": "This service supports generation of credentials through binding an application only." } (see Service Broker Errors. |
Responses with any other status code will be interpreted as a failure and an
unbind request will be sent to the Service Broker to prevent an orphan being
created on the Service Broker. Service brokers can include a user-facing
message in the description field; for details see Service Broker
Errors.
All response bodies MUST be a valid JSON Object ({}). This is for future
compatibility; it will be easier to add fields in the future if JSON is
expected rather than to support the cases when a JSON body might or might not
be returned.
For success responses, the following fields are supported. Others will be ignored. For error responses, see Service Broker Errors.
| Response Field | Type | Description |
|---|---|---|
| credentials | object | A free-form hash of credentials that can be used by applications or users to access the service. |
| syslog_drain_url | string | A URL to which logs MUST be streamed. "requires":["syslog_drain"] MUST be declared in the Catalog endpoint or the platform MUST consider the response invalid. |
| route_service_url | string | A URL to which the platform MUST proxy requests for the address sent with bind_resource.route in the request body. "requires":["route_forwarding"] MUST be declared in the Catalog endpoint or the platform can consider the response invalid. |
| volume_mounts | array-of-objects | An array of configuration for remote storage devices to be mounted into an application container filesystem. "requires":["volume_mount"] MUST be declared in the Catalog endpoint or the platform can consider the response invalid. |
| Response Field | Type | Description |
|---|---|---|
| driver* | string | Name of the volume driver plugin which manages the device. |
| container_dir* | string | The path in the application container onto which the volume will be mounted. This specification does not mandate what action the platform is to take if the path specified already exists in the container. |
| mode* | string | "r" to mount the volume read-only or "rw" to mount it read-write. |
| device_type* | string | A string specifying the type of device to mount. Currently the only supported value is "shared". |
| device* | device-object | Device object containing device_type specific details. Currently only shared devices are supported. |
Currently only shared devices are supported; a distributed file system which can be mounted on all app instances simultaneously.
| Field | Type | Description |
|---|---|---|
| volume_id* | string | ID of the shared volume to mount on every app instance. |
| mount_config | object | Configuration object to be passed to the driver when the volume is mounted. |
* Fields with an asterisk are REQUIRED.
{
"credentials": {
"uri": "mysql://mysqluser:pass@mysqlhost:3306/dbname",
"username": "mysqluser",
"password": "pass",
"host": "mysqlhost",
"port": 3306,
"database": "dbname"
}
}
{
"volume_mounts": [{
"driver": "cephdriver",
"container_dir": "/data/images",
"mode": "r",
"device_type": "shared",
"device": {
"volume_id": "bc2c1eab-05b9-482d-b0cf-750ee07de311",
"mount_config": {
"key": "value"
}
}
}]
}
Note: Service brokers that do not provide any bindable services or plans do not need to implement this endpoint.
When a Service Broker receives an unbind request from the marketplace, it MUST delete any resources associated with the binding. In the case where credentials were generated, this might result in requests to the service instance failing to authenticate.
DELETE /v2/service_instances/:instance_id/service_bindings/:binding_id
:instance_id MUST be the ID of a previously provisioned service instance.
:binding_id MUST be the the ID of a previously provisioned binding for that
service instance.
The request provides these query string parameters as useful hints for service brokers.
| Query-String Field | Type | Description |
|---|---|---|
| service_id* | string | MUST be the ID of the service associated with the binding being delete. |
| plan_id* | string | MUST be the ID of the plan associated with the binding being deleted. |
* Query parameters with an asterisk are REQUIRED.
The following HTTP Headers are defined for this operation:
| Header | Type | Description |
|---|---|---|
| X-Broker-API-Version* | string | See API Version Header. |
| X-Broker-API-Originating-Identity | string | See Originating Identity. |
* Headers with an asterisk are REQUIRED.
$ curl 'http://username:password@service-broker-url/v2/service_instances/:instance_id/
service_bindings/:binding_id?service_id=service-id-here&plan_id=plan-id-here' -X DELETE -H "X-Broker-API-Version: 2.13"
| Status Code | Description |
|---|---|
| 200 OK | MUST be returned if the binding was deleted as a result of this request. The expected response body is {}. |
| 400 Bad Request | MUST be returned if the request is malformed or missing mandatory data. |
| 410 Gone | MUST be returned if the binding does not exist. The expected response body is {}. |
Responses with any other status code will be interpreted as a failure and the
binding will remain in the marketplace database. Service brokers can include a
user-facing message in the description field; for details see Service
Broker Errors.
All response bodies MUST be a valid JSON Object ({}). This is for future
compatibility; it will be easier to add fields in the future if JSON is
expected rather than to support the cases when a JSON body might or might not
be returned.
For a success response, the expected response body is {}.
When a Service Broker receives a deprovision request from the marketplace, it MUST delete any resources it created during the provision. Usually this means that all resources are immediately reclaimed for future provisions.
Platforms MUST delete all bindings for a service prior to attempting to deprovision the service. This specification does not specify what a service broker is to do if it receives a deprovision request while there are still bindings associated with it.
DELETE /v2/service_instances/:instance_id
:instance_id MUST be the ID a previously provisioned service instance.
The request provides these query string parameters as useful hints for service brokers.
| Query-String Field | Type | Description |
|---|---|---|
| service_id* | string | MUST be the ID of the service instance being deleted. |
| plan_id* | string | MUST be the ID of the plan associated with the service instance being deleted. |
| accepts_incomplete | boolean | A value of true indicates that both the marketplace and the requesting client support asynchronous deprovisioning. If this parameter is not included in the request, and the Service Broker can only deprovision a service instance of the requested plan asynchronously, the Service Broker MUST reject the request with a 422 Unprocessable Entity as described below. |
* Query parameters with an asterisk are REQUIRED.
The following HTTP Headers are defined for this operation:
| Header | Type | Description |
|---|---|---|
| X-Broker-API-Version* | string | See API Version Header. |
| X-Broker-API-Originating-Identity | string | See Originating Identity. |
* Headers with an asterisk are REQUIRED.
$ curl 'http://username:password@service-broker-url/v2/service_instances/:instance_id?accepts_incomplete=true
&service_id=service-id-here&plan_id=plan-id-here' -X DELETE -H "X-Broker-API-Version: 2.13"
| Status Code | Description |
|---|---|
| 200 OK | MUST be returned if the service instance was deleted as a result of this request. The expected response body is {}. |
| 202 Accepted | MUST be returned if the service instance deletion is in progress. This triggers the marketplace to poll the Service Instance Last Operation Endpoint for operation status. Note that a re-sent DELETE request MUST return a 202 Accepted, not a 200 OK, if the delete request has not completed yet. |
| 400 Bad Request | MUST be returned if the request is malformed or missing mandatory data. |
| 410 Gone | MUST be returned if the service instance does not exist. The expected response body is {}. |
| 422 Unprocessable Entity | MUST be returned if the Service Broker only supports asynchronous deprovisioning for the requested plan and the request did not include ?accepts_incomplete=true. The expected response body is: { "error": "AsyncRequired", "description": "This service plan requires client support for asynchronous service operations." }, as described below (see Service Broker Errors. |
Responses with any other status code will be interpreted as a failure and the
service instance will remain in the marketplace database. Service brokers can
include a user-facing message in the description field; for details see
Service Broker Errors.
All response bodies MUST be a valid JSON Object ({}). This is for future
compatibility; it will be easier to add fields in the future if JSON is
expected rather than to support the cases when a JSON body might or might not
be returned.
For success responses, the following fields are supported. Others will be ignored. For error responses, see Service Broker Errors.
| Response field | Type | Description |
|---|---|---|
| operation | string | For asynchronous responses, Service Brokers MAY return an identifier representing the operation. The value of this field MUST be provided by the platform with requests to the Last Operation endpoint in a percent-encoded query parameter. If present, MUST be a non-empty string. |
* Fields with an asterisk are REQUIRED.
{
"operation": "task_10"
}
Service broker failures beyond the scope of the well-defined HTTP response
codes listed above (like 410 Gone on Deprovisioning) MUST
return an appropriate HTTP response code (chosen to accurately reflect the
nature of the failure) and a body containing a valid JSON Object (not an
array).
All response bodies MUST be a valid JSON Object ({}). This is for future
compatibility; it will be easier to add fields in the future if JSON is
expected rather than to support the cases when a JSON body might or might not
be returned.
For error responses, the following fields are valid; while other properties MAY appear, platforms MAY choose to ignore them:
| Response Field | Type | Description |
|---|---|---|
| error | string | A single word uniquely identifying the error condition. |
| description | string | A meaningful error message explaining why the request failed. |
{
"error": "QuotaExceeded",
"description": "Your account has exceeded its quota for service instances. Please contact support at http://support.example.com."
}
All errors defined in this specification include a corresponding error value
that SHOULD be used in the error response message. Each error definition will
also include a description property that is RECOMMENDED to be used. However,
the Service Broker MAY use a different description string if appropriate, for
example, to specify a description in a different language.
The platform marketplace is the source of truth for service instances and bindings. Service brokers are expected to have successfully provisioned all the service instances and bindings that the marketplace knows about, and none that it doesn't.
Orphans can result if the Service Broker does not return a response before a request from the marketplace times out (typically 60 seconds). For example, if a Service Broker does not return a response to a provision request before the request times out, the Service Broker might eventually succeed in provisioning a service instance after the marketplace considers the request a failure. This results in an orphan service instance on the Service Broker's side.
To mitigate orphan service instances and bindings, the marketplace SHOULD attempt to delete resources it cannot be sure were successfully created, and SHOULD keep trying to delete them until the Service Broker responds with a success.
Platforms SHOULD initiate orphan mitigation in the following scenarios:
| Status code of Service Broker response | Platform interpretation of response | Platform initiates orphan mitigation? |
|---|---|---|
| 200 | Success | No |
| 200 with malformed response | Failure | No |
| 201 | Success | No |
| 201 with malformed response | Failure | Yes |
| All other 2xx | Failure | Yes |
| 408 | Timeout failure | Yes |
| All other 4xx | Service broker rejected request | No |
| 5xx | Service broker error | Yes |
| Timeout | Failure | Yes |
If the platform marketplace encounters an internal error provisioning a service instance or binding (for example, saving to the database fails), then it MUST at least send a single delete or unbind request to the Service Broker to prevent creation of an orphan.