Jump to

• Request
• Response

Provision a service instance

put

/openservicebroker/v2/service_instances/{instance_id}

When the Service Broker receives a provision request from the Platform, it MUST take whatever action is necessary to create a new resource, according to the Service Plan specified.

Request

Supported Media Types

• application/json

Path Parameters

• instance_id: string
  Instance id of instance to provision.

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.

Body ()

What a Service Instance represents can vary by service and plan. This object represents a request to provision a Service Instance.

Root Schema : schema

Type: object

Show Source

• parameters(optional): object parameters
  Configuration parameters for the Service Instance. Service Brokers SHOULD ensure that the client has provided valid configuration parameters and values for the operation.
• plan_id: string
  The ID of a Service Plan from the Service Offering that has been requested.
• service_id: string
  The ID of a Service Offering from the catalog for this Service Broker.

{
    "type":"object",
    "required":[
        "service_id",
        "plan_id"
    ],
    "properties":{
        "service_id":{
            "type":"string",
            "description":"The ID of a Service Offering from the catalog for this Service Broker."
        },
        "plan_id":{
            "type":"string",
            "description":"The ID of a Service Plan from the Service Offering that has been requested."
        },
        "parameters":{
            "type":"object",
            "description":"Configuration parameters for the Service Instance. Service Brokers SHOULD ensure that the client has provided valid configuration parameters and values for the operation."
        }
    }
}

Nested Schema : parameters

Type: object

Configuration parameters for the Service Instance. Service Brokers SHOULD ensure that the client has provided valid configuration parameters and values for the operation.

Back to Top

Response

Supported Media Types

• application/json

201 Response

Confirmation that the corresponding Service Plan action was carried out.

Body ()

Root Schema : ServiceInstanceProvision

Type: object

The response for successfully provisioning a service instance will vary.

Back to Top