Update a Service Instance
PUT /v2/service_instances/:guid
Request
Route
PUT /v2/service_instances/2db3668d-ff73-433e-842f-0db6ddef1488?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"]
|
{"service_plan_guid":"55a3161b-a6f9-4e21-8904-fc789643fa4e","parameters":{"the_service_broker":"wants this object"}}
Headers
cURL
curl "https://api.[your-domain.com]/v2/service_instances/2db3668d-ff73-433e-842f-0db6ddef1488?accepts_incomplete=true" -d '{"service_plan_guid":"55a3161b-a6f9-4e21-8904-fc789643fa4e","parameters":{"the_service_broker":"wants this object"}}' -X PUT \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3NiIsImVtYWlsIjoiZW1haWwtMTQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2MTl9.KeThs_X_hzLU12PvbZGcQN7sfuHc9cZrmpzc5BDB1pg" \
-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.
|
|
|
routes_url
|
Routes bound to the service instance. Requests to these routes will be forwarded to the service instance.
|
|
|
tags
|
A list of tags for the service instance
|
|
{
"metadata": {
"guid": "2db3668d-ff73-433e-842f-0db6ddef1488",
"url": "/v2/service_instances/2db3668d-ff73-433e-842f-0db6ddef1488",
"created_at": "2016-01-26T22:20:19Z",
"updated_at": null
},
"entity": {
"name": "name-798",
"credentials": {
"creds-key-47": "creds-val-47"
},
"service_plan_guid": "39a70149-9fd7-4a78-9a94-c741e57b5d47",
"space_guid": "06ba3077-fa52-4ff2-8be5-9215b19e45b5",
"gateway_data": null,
"dashboard_url": null,
"type": "managed_service_instance",
"last_operation": {
"type": "update",
"state": "in progress",
"description": "",
"updated_at": "2016-01-26T22:20:19Z",
"created_at": "2016-01-26T22:20:19Z"
},
"tags": [
],
"space_url": "/v2/spaces/06ba3077-fa52-4ff2-8be5-9215b19e45b5",
"service_plan_url": "/v2/service_plans/39a70149-9fd7-4a78-9a94-c741e57b5d47",
"service_bindings_url": "/v2/service_instances/2db3668d-ff73-433e-842f-0db6ddef1488/service_bindings",
"service_keys_url": "/v2/service_instances/2db3668d-ff73-433e-842f-0db6ddef1488/service_keys",
"routes_url": "/v2/service_instances/2db3668d-ff73-433e-842f-0db6ddef1488/routes"
}
}
Headers