Home
Version 3
Service Instances API

Service Instances API

Updating a service instance

PUT /v2/service_instances/:guid

Fields

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

Request

Headers

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

Route

PUT /v2/service_instances/0c5db472-db64-44be-8842-87177fdb2aec

Body

{"service_plan_guid":"9e9a98ae-d147-434d-ae81-6402865ebf8f"}

cURL

curl "https://api.[your-domain.com]/v2/service_instances/0c5db472-db64-44be-8842-87177fdb2aec" -d '{"service_plan_guid":"9e9a98ae-d147-434d-ae81-6402865ebf8f"}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxMyIsImVtYWlsIjoiZW1haWwtMTQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE2OTZ9.m0AiZ6H3ZOGc3G04IMYm18tOKAHEmkyxRyXtkXZRFZU" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 71cec3c7-1cdf-479f-817c-f385dcb513fd
Content-Length: 965
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "0c5db472-db64-44be-8842-87177fdb2aec",
    "url": "/v2/service_instances/0c5db472-db64-44be-8842-87177fdb2aec",
    "created_at": "2015-02-13T22:34:56Z",
    "updated_at": "2015-02-13T22:34:56Z"
  },
  "entity": {
    "name": "name-1294",
    "credentials": {
      "creds-key-322": "creds-val-322"
    },
    "service_plan_guid": "9e9a98ae-d147-434d-ae81-6402865ebf8f",
    "space_guid": "b5ac4acb-cb99-4b5a-9afa-f7ff56d011d7",
    "gateway_data": null,
    "dashboard_url": null,
    "type": "managed_service_instance",
    "last_operation": {
      "type": "update",
      "state": "succeeded",
      "description": "",
      "updated_at": "2015-02-13T22:34:56Z"
    },
    "space_url": "/v2/spaces/b5ac4acb-cb99-4b5a-9afa-f7ff56d011d7",
    "service_plan_url": "/v2/service_plans/9e9a98ae-d147-434d-ae81-6402865ebf8f",
    "service_bindings_url": "/v2/service_instances/0c5db472-db64-44be-8842-87177fdb2aec/service_bindings"
  }
}