Creating a Service Instance
POST /v2/service_instances/
Request
Route
POST /v2/service_instances?accepts_incomplete=true
Parameters
| Name |
Description |
Valid Values |
Example Values |
|
accepts_incomplete
|
Set to `true` if the client allows asynchronous provisioning. The cloud controller may respond before the service is ready for use.
|
|
|
accepts_incomplete: true
Body
| Name |
Description |
Default |
Valid Values |
Example Values |
|
name
|
A name for the service instance
|
|
|
|
|
service_plan_guid
|
The guid of the service plan to associate with the instance
|
|
|
|
|
space_guid
|
The guid of the space in which the instance will be created
|
|
|
|
|
parameters
|
Arbitrary parameters to pass along to the service broker. Must be a JSON object
|
|
|
|
|
gateway_data
|
Configuration information for the broker gateway in v1 services
|
|
|
|
|
tags
|
A list of tags for the service instance
|
[]
|
|
- ["db"]
- ["accounting_mongodb"]
|
{
"space_guid": "343c099e-f93d-4bda-a6e6-1732b48ce9c2",
"name": "my-service-instance",
"service_plan_guid": "e8ab9cf9-e0c1-40cb-ae25-595301ae9150",
"parameters": {
"the_service_broker": "wants this object"
},
"tags": [
"accounting_mongodb"
]
}
Headers
cURL
curl "https://api.[your-domain.com]/v2/service_instances?accepts_incomplete=true" -d '{
"space_guid": "343c099e-f93d-4bda-a6e6-1732b48ce9c2",
"name": "my-service-instance",
"service_plan_guid": "e8ab9cf9-e0c1-40cb-ae25-595301ae9150",
"parameters": {
"the_service_broker": "wants this object"
},
"tags": [
"accounting_mongodb"
]
}' -X POST \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTYwIiwiZW1haWwiOiJlbWFpbC0zMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMzOTgxMDk4fQ.HM89fcWHqW1FLVr-fR_p-4bSiJqq-5eXR8yI4Lx3JJc" \
-H "Host: example.org" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Cookie: "
Response
Status
202 Accepted
Body
| Name |
Description |
Valid Values |
|
name
|
The human-readable name of the service instance.
|
|
|
credentials
|
The service broker-provided credentials to use this service.
|
|
|
service_plan_guid
|
The service plan GUID that this service instance is utilizing.
|
|
|
space_guid
|
The space GUID that this service instance belongs to.
|
|
|
gateway_data
|
|
|
|
dashboard_url
|
The service broker-provided URL to access administrative features of the service instance. May be null.
|
|
|
type
|
The type of service instance.
|
- managed_service_instance
- user_provided_service_instance
|
|
last_operation
|
The status of the last operation requested on the service instance. May be null.
|
|
|
last_operation.type
|
The type of operation that was last performed or currently being performed on the service instance
|
|
|
last_operation.state
|
The status of the last operation or current operation being performed on the service instance.
|
- in progress
- succeeded
- failed
|
|
last_operation.description
|
The service broker-provided description of the operation. May be null.
|
|
|
last_operation.updated_at
|
The timestamp that the Cloud Controller last checked the service instance state from the broker.
|
|
|
space_url
|
The relative path to the space resource that this service instance belongs to.
|
|
|
service_plan_url
|
The relative path to the service plan resource that this service instance belongs to.
|
|
|
service_binding_url
|
The relative path to the service bindings that this service instance is bound to.
|
|
|
tags
|
A list of tags for the service instance
|
|
{
"metadata": {
"guid": "6e043df5-271e-4ea8-9500-98c243cc62c0",
"url": "/v2/service_instances/6e043df5-271e-4ea8-9500-98c243cc62c0",
"created_at": "2015-06-04T00:04:58Z",
"updated_at": null
},
"entity": {
"name": "my-service-instance",
"credentials": {
},
"service_plan_guid": "e8ab9cf9-e0c1-40cb-ae25-595301ae9150",
"space_guid": "343c099e-f93d-4bda-a6e6-1732b48ce9c2",
"gateway_data": null,
"dashboard_url": null,
"type": "managed_service_instance",
"last_operation": {
"type": "create",
"state": "in progress",
"description": "",
"updated_at": "2015-06-04T00:04:58Z",
"created_at": "2015-06-04T00:04:58Z"
},
"tags": [
"accounting_mongodb"
],
"space_url": "/v2/spaces/343c099e-f93d-4bda-a6e6-1732b48ce9c2",
"service_plan_url": "/v2/service_plans/e8ab9cf9-e0c1-40cb-ae25-595301ae9150",
"service_bindings_url": "/v2/service_instances/6e043df5-271e-4ea8-9500-98c243cc62c0/service_bindings",
"service_keys_url": "/v2/service_instances/6e043df5-271e-4ea8-9500-98c243cc62c0/service_keys"
}
}
Headers