Home
Version 3
User Provided Service Instances API

User Provided Service Instances API

Updating a User Provided Service Instance

PUT /v2/user_provided_service_instances/:guid

Fields

Name Description Default Valid Values Example Values
name A name for the service instance
  • my-user-provided-instance
syslog_drain_url The url for the syslog_drain to direct to
  • syslog://example.com
credentials A hash that can be used to store credentials
  • {:somekey=>"somevalue"}

Request

Headers

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

Route

PUT /v2/user_provided_service_instances/1997142e-9d8e-4263-9f73-94a81ebe0791

Body

{
  "credentials": {
    "somekey": "somenewvalue"
  }
}

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances/1997142e-9d8e-4263-9f73-94a81ebe0791" -d '{
  "credentials": {
    "somekey": "somenewvalue"
  }
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2NCIsImVtYWlsIjoiZW1haWwtMTg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxNDR9.CPNId02lO5TYkMWlX6oJaZEk76GT5mFD5uSc8Lu_H6Y" \
	-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: a3df347d-4737-4de2-92e6-9fee7a52e68d
Content-Length: 700
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "1997142e-9d8e-4263-9f73-94a81ebe0791",
    "url": "/v2/user_provided_service_instances/1997142e-9d8e-4263-9f73-94a81ebe0791",
    "created_at": "2014-11-05T01:02:24+00:00",
    "updated_at": "2014-11-05T01:02:24+00:00"
  },
  "entity": {
    "name": "name-882",
    "credentials": {
      "somekey": "somenewvalue"
    },
    "space_guid": "61c6618a-a907-4044-9d13-45f81c01b1d6",
    "type": "user_provided_service_instance",
    "syslog_drain_url": "https://foo.com/url-64",
    "space_url": "/v2/spaces/61c6618a-a907-4044-9d13-45f81c01b1d6",
    "service_bindings_url": "/v2/user_provided_service_instances/1997142e-9d8e-4263-9f73-94a81ebe0791/service_bindings"
  }
}