Home
Version 3
Service Instances API

Service Instances API

Update a Service Instance

PUT /v2/service_instances/:guid

Request

Route

PUT /v2/service_instances/b580f008-d0a8-4a2e-947c-9438e308d199?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.
  • true
  • false
accepts_incomplete: true

Body

Name Description Default Valid Values Example Values
name The new name for the service instance
  • my-new-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.
  • ["db"]
  • ["accounting", "mongodb"]
{"service_plan_guid":"45bb55e5-772d-402c-8107-5dd0e466d954","parameters":{"the_service_broker":"wants this object"}}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNCIsImVtYWlsIjoiZW1haWwtNzVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzNjgyOTc3OH0.FkMFbwwV5cqvXAgpeTGHHCgtlYbLFkak8RxW6DOSIa4
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/b580f008-d0a8-4a2e-947c-9438e308d199?accepts_incomplete=true" -d '{"service_plan_guid":"45bb55e5-772d-402c-8107-5dd0e466d954","parameters":{"the_service_broker":"wants this object"}}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNCIsImVtYWlsIjoiZW1haWwtNzVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzNjgyOTc3OH0.FkMFbwwV5cqvXAgpeTGHHCgtlYbLFkak8RxW6DOSIa4" \
	-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
  • create
  • update
  • delete
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": "b580f008-d0a8-4a2e-947c-9438e308d199",
    "url": "/v2/service_instances/b580f008-d0a8-4a2e-947c-9438e308d199",
    "created_at": "2015-07-06T23:22:58Z",
    "updated_at": "2015-07-06T23:22:58Z"
  },
  "entity": {
    "name": "name-342",
    "credentials": {
      "creds-key-158": "creds-val-158"
    },
    "service_plan_guid": "3a202c57-a184-4804-a25d-dc1bd3c5cf87",
    "space_guid": "eaaf5bc8-e09b-46d3-a283-e6f0c8bb0423",
    "gateway_data": null,
    "dashboard_url": null,
    "type": "managed_service_instance",
    "last_operation": {
      "type": "update",
      "state": "in progress",
      "description": "",
      "updated_at": "2015-07-06T23:22:58Z",
      "created_at": "2015-07-06T23:22:58Z"
    },
    "tags": [

    ],
    "space_url": "/v2/spaces/eaaf5bc8-e09b-46d3-a283-e6f0c8bb0423",
    "service_plan_url": "/v2/service_plans/3a202c57-a184-4804-a25d-dc1bd3c5cf87",
    "service_bindings_url": "/v2/service_instances/b580f008-d0a8-4a2e-947c-9438e308d199/service_bindings",
    "service_keys_url": "/v2/service_instances/b580f008-d0a8-4a2e-947c-9438e308d199/service_keys"
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/service_instances/b580f008-d0a8-4a2e-947c-9438e308d199
X-VCAP-Request-ID: 67802cb1-2556-4f30-96b4-26eb0cd34088
Content-Length: 1131
X-Content-Type-Options: nosniff