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
Path Parameters
-
instance_id(required): string
Instance id of instance to provision.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
parameters: 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(required): string
The ID of a Service Plan from the Service Offering that has been requested.
-
service_id(required): string
The ID of a Service Offering from the catalog for this Service Broker.
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.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
Confirmation that the corresponding Service Plan action was carried out.
Root Schema : ServiceInstanceProvision
Type:
object
The response for successfully provisioning a service instance will vary.