Update a Service Instance
PUT /v2/service_instances/:guid
Request
Route
PUT /v2/service_instances/a34f1423-4b84-4727-ab49-3f1522c4cb16?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
|
The new name for the service instance
|
|
|
|
|
service_plan_guid
|
The new plan guid for the service instance
|
|
|
- 6c4bd80f-4593-41d1-a2c9-b20cb65ec76e
|
|
parameters
|
Arbitrary parameters to pass along to the service broker. Must be a JSON object
|
|
|
|
|
tags
|
A list of tags for the service instance. NOTE: Updating the tags will overwrite any old tags. Max characters: 2048.
|
|
|
- ["db"]
- ["accounting", "mongodb"]
|
|
maintenance_info
|
A maintenance information for the service instance to pass along to the service broker.
NOTE: The maintenance_info object provided in the request must be supported by the service instance's plan. Must be a JSON object.
|
|
|
|
{"service_plan_guid":"992de8b9-30c7-4a1b-84e7-c9900f2df1cf","parameters":{"the_service_broker":"wants this object"}}
Headers
cURL
curl "https://api.[your-domain.com]/v2/service_instances/a34f1423-4b84-4727-ab49-3f1522c4cb16?accepts_incomplete=true" -d '{"service_plan_guid":"992de8b9-30c7-4a1b-84e7-c9900f2df1cf","parameters":{"the_service_broker":"wants this object"}}' -X PUT \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1MyIsImVtYWlsIjoiZW1haWwtMTA4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTB9.a479ELQ0lPfd_bPiU-E-R0bk6wTCggj8w9PwqTSl19M" \
-H "Host: example.org" \
-H "Content-Type: application/json" \
-H "Cookie: "
Response
Status
If accepts_incomplete is set to false, or if the service is synchronous, the successful response status code will be 201. Otherwise the success response is a 202
201 Created, 202 Accepted
Body
| Name |
Description |
Valid Values |
Example 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.
|
|
|
|
routes_url
|
Routes bound to the service instance. Requests to these routes will be forwarded to the service instance.
|
|
|
|
shared_from_url
|
Source information for a shared service instance. Users of a shared service instance can find out its space and org information.
|
|
|
|
shared_to_url
|
Information about where the service instance instance has been shared to.
|
|
|
|
tags
|
A list of tags for the service instance
|
|
|
|
maintenance_info
|
A maintenance information for the service instance.
|
|
- {"version": "2.0.0", "description": "OS image update."}
|
{
"metadata": {
"guid": "a34f1423-4b84-4727-ab49-3f1522c4cb16",
"url": "/v2/service_instances/a34f1423-4b84-4727-ab49-3f1522c4cb16",
"created_at": "2016-06-08T16:41:30Z",
"updated_at": "2016-06-08T16:41:26Z"
},
"entity": {
"name": "name-1529",
"credentials": {
"creds-key-41": "creds-val-41"
},
"service_plan_guid": "4ec73bf4-9f3a-44c7-bbac-61ee9cb5a511",
"space_guid": "da37b4b7-2439-4b30-9eb3-bded0dbf690f",
"gateway_data": null,
"dashboard_url": null,
"type": "managed_service_instance",
"last_operation": {
"type": "update",
"state": "in progress",
"description": "",
"updated_at": "2016-06-08T16:41:30Z",
"created_at": "2016-06-08T16:41:30Z"
},
"tags": [
],
"maintenance_info": {
"version": "2.1.0",
"description": "OS image update.\nExpect downtime."
},
"space_url": "/v2/spaces/da37b4b7-2439-4b30-9eb3-bded0dbf690f",
"service_plan_url": "/v2/service_plans/4ec73bf4-9f3a-44c7-bbac-61ee9cb5a511",
"service_bindings_url": "/v2/service_instances/a34f1423-4b84-4727-ab49-3f1522c4cb16/service_bindings",
"service_keys_url": "/v2/service_instances/a34f1423-4b84-4727-ab49-3f1522c4cb16/service_keys",
"routes_url": "/v2/service_instances/a34f1423-4b84-4727-ab49-3f1522c4cb16/routes",
"shared_from_url": "/v2/service_instances/0d632575-bb06-4ea5-bb19-a451a9644d92/shared_from",
"shared_to_url": "/v2/service_instances/0d632575-bb06-4ea5-bb19-a451a9644d92/shared_to"
}
}
Headers