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/0ace4c3c-6065-409f-a5ed-90a40a87e8ca

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"}
route_service_url URL to which requests for bound routes will be forwarded.
  • https://logger.example.com
{
  "credentials": {
    "somekey": "somenewvalue"
  }
}

Headers

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

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances/0ace4c3c-6065-409f-a5ed-90a40a87e8ca" -d '{
  "credentials": {
    "somekey": "somenewvalue"
  }
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzIiwiZW1haWwiOiJlbWFpbC0xM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU4NTk5NDIxfQ.cTwGv7jyhSo4qvv90Z87EQRYp5wGml5out8Ttx36id8" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "0ace4c3c-6065-409f-a5ed-90a40a87e8ca",
    "url": "/v2/user_provided_service_instances/0ace4c3c-6065-409f-a5ed-90a40a87e8ca",
    "created_at": "2016-03-14T22:30:21Z",
    "updated_at": "2016-03-14T22:30:21Z"
  },
  "entity": {
    "name": "name-27",
    "credentials": {
      "somekey": "somenewvalue"
    },
    "space_guid": "4be042a7-d7ac-4a7a-9969-d01a07bf30f1",
    "type": "user_provided_service_instance",
    "syslog_drain_url": "https://foo.com/url-13",
    "route_service_url": null,
    "space_url": "/v2/spaces/4be042a7-d7ac-4a7a-9969-d01a07bf30f1",
    "service_bindings_url": "/v2/user_provided_service_instances/0ace4c3c-6065-409f-a5ed-90a40a87e8ca/service_bindings",
    "routes_url": "/v2/user_provided_service_instances/0ace4c3c-6065-409f-a5ed-90a40a87e8ca/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 821
X-Content-Type-Options: nosniff