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.eyJ1c2VyX2lkIjoidWFhLWlkLTU3IiwiZW1haWwiOiJlbWFpbC01MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzUzfQ.8TGWTroR5s68A_OJgz0hlGIczz0S1vC8MyFphqN3_TY
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

PUT /v2/user_provided_service_instances/92f8c193-73a6-41c1-847e-75e7d7082076

Body

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

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances/92f8c193-73a6-41c1-847e-75e7d7082076" -d '{
  "credentials": {
    "somekey": "somenewvalue"
  }
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTU3IiwiZW1haWwiOiJlbWFpbC01MEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE3NDYyMzUzfQ.8TGWTroR5s68A_OJgz0hlGIczz0S1vC8MyFphqN3_TY" \
	-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: aff39ba3-22c7-4e83-aca8-3ee9c82a639b
Content-Length: 700
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "92f8c193-73a6-41c1-847e-75e7d7082076",
    "url": "/v2/user_provided_service_instances/92f8c193-73a6-41c1-847e-75e7d7082076",
    "created_at": "2014-11-24T19:32:33+00:00",
    "updated_at": "2014-11-24T19:32:33+00:00"
  },
  "entity": {
    "name": "name-383",
    "credentials": {
      "somekey": "somenewvalue"
    },
    "space_guid": "29e1f2f9-f9be-4685-8b5b-7f1a88cbe389",
    "type": "user_provided_service_instance",
    "syslog_drain_url": "https://foo.com/url-16",
    "space_url": "/v2/spaces/29e1f2f9-f9be-4685-8b5b-7f1a88cbe389",
    "service_bindings_url": "/v2/user_provided_service_instances/92f8c193-73a6-41c1-847e-75e7d7082076/service_bindings"
  }
}