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/1af1629e-0c47-4b09-bedd-5174b9862b23

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
tags A list of tags for the service instance. NOTE: Updating the tags will overwrite any old tags. Max characters: 2048
  • ["db"]
  • ["accounting", "mongodb"]
 
{
  "credentials": {
    "somekey": "somenewvalue"
  },
  "tags": ["new-tag"]
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTN9.fu_vRQ0QoFrVrMUO8Z-TQPrnT2JwFPWklSgSZ5PYKeM
Host: example.org
Content-Type: application/json
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances/1af1629e-0c47-4b09-bedd-5174b9862b23" -d '{
  "credentials": {
    "somekey": "somenewvalue"
  },
  "tags": ["new-tag"]
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTN9.fu_vRQ0QoFrVrMUO8Z-TQPrnT2JwFPWklSgSZ5PYKeM" \
	-H "Host: example.org" \
	-H "Content-Type: application/json" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "1af1629e-0c47-4b09-bedd-5174b9862b23",
    "url": "/v2/user_provided_service_instances/1af1629e-0c47-4b09-bedd-5174b9862b23",
    "created_at": "2016-06-08T16:41:33Z",
    "updated_at": "2016-06-08T16:41:33Z"
  },
  "entity": {
    "name": "name-1692",
    "credentials": {
      "somekey": "somenewvalue"
    },
    "space_guid": "884c5c61-fbb8-4c89-91d2-a7a5ab27b004",
    "type": "user_provided_service_instance",
    "syslog_drain_url": "https://foo.com/url-102",
    "route_service_url": null,
    "tags": ["new-tag"],
    "space_url": "/v2/spaces/884c5c61-fbb8-4c89-91d2-a7a5ab27b004",
    "service_bindings_url": "/v2/user_provided_service_instances/1af1629e-0c47-4b09-bedd-5174b9862b23/service_bindings",
    "routes_url": "/v2/user_provided_service_instances/1af1629e-0c47-4b09-bedd-5174b9862b23/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 8af29ff9-dd0f-4e96-a7b2-7438ee90a244
Content-Length: 824
X-Content-Type-Options: nosniff