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

Request

Route

PUT /v2/user_provided_service_instances/e0d1ac37-4f5f-4703-8985-87c37e1e514c

Body

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"}
{
  "credentials": {
    "somekey": "somenewvalue"
  }
}

Headers

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

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances/e0d1ac37-4f5f-4703-8985-87c37e1e514c" -d '{
  "credentials": {
    "somekey": "somenewvalue"
  }
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY3IiwiZW1haWwiOiJlbWFpbC02NkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDMyMzEzNjA4fQ.qXP2rlqMY5Te0bFmAjXgjuEixPSwwmxML4jeG6IVgWY" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "e0d1ac37-4f5f-4703-8985-87c37e1e514c",
    "url": "/v2/user_provided_service_instances/e0d1ac37-4f5f-4703-8985-87c37e1e514c",
    "created_at": "2015-05-15T16:53:28Z",
    "updated_at": "2015-05-15T16:53:28Z"
  },
  "entity": {
    "name": "name-328",
    "credentials": {
      "somekey": "somenewvalue"
    },
    "space_guid": "16f47246-57fe-49e0-b377-9030e80779a0",
    "type": "user_provided_service_instance",
    "syslog_drain_url": "https://foo.com/url-23",
    "space_url": "/v2/spaces/16f47246-57fe-49e0-b377-9030e80779a0",
    "service_bindings_url": "/v2/user_provided_service_instances/e0d1ac37-4f5f-4703-8985-87c37e1e514c/service_bindings"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e9aa4dbf-f825-4b89-ad5c-75638e5e40ab
Content-Length: 690
X-Content-Type-Options: nosniff