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.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNSIsImVtYWlsIjoiZW1haWwtMTQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDN9.UU6V4Q4Mjd2VG4xaeQ2t3-0G_Rae2jUBBbptRdAqELw
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

PUT /v2/service_instances/04237333-fd3b-4a7c-9468-8d2626ef4b34

Body

{"service_plan_guid":"82498186-112e-4ef1-a8a2-65b539149120"}

cURL

curl "https://api.[your-domain.com]/v2/service_instances/04237333-fd3b-4a7c-9468-8d2626ef4b34" -d '{"service_plan_guid":"82498186-112e-4ef1-a8a2-65b539149120"}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIwNSIsImVtYWlsIjoiZW1haWwtMTQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NDN9.UU6V4Q4Mjd2VG4xaeQ2t3-0G_Rae2jUBBbptRdAqELw" \
	-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: 6061587c-f4be-4f64-8f40-4c326e94b71e
Content-Length: 874
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "04237333-fd3b-4a7c-9468-8d2626ef4b34",
    "url": "/v2/service_instances/04237333-fd3b-4a7c-9468-8d2626ef4b34",
    "created_at": "2015-01-20T01:52:23+00:00",
    "updated_at": "2015-01-20T01:52:23+00:00"
  },
  "entity": {
    "name": "name-1419",
    "credentials": {
      "creds-key-323": "creds-val-323"
    },
    "service_plan_guid": "82498186-112e-4ef1-a8a2-65b539149120",
    "space_guid": "c2e7172f-2846-4b2f-bbc8-01b025969c7b",
    "gateway_data": null,
    "dashboard_url": null,
    "type": "managed_service_instance",
    "state": null,
    "state_description": null,
    "space_url": "/v2/spaces/c2e7172f-2846-4b2f-bbc8-01b025969c7b",
    "service_plan_url": "/v2/service_plans/82498186-112e-4ef1-a8a2-65b539149120",
    "service_bindings_url": "/v2/service_instances/04237333-fd3b-4a7c-9468-8d2626ef4b34/service_bindings"
  }
}