Home
Version 3
Service Brokers API

Service Brokers API

Update a Service Broker

PUT /v2/service_brokers/:guid

Request

Route

PUT /v2/service_brokers/9a62287f-31f4-420d-8403-ca36dba131fd

Parameters

Name Description Valid Values Example Values
guid The guid of the Service Broker

Body

Name Description Default Valid Values Example Values
name The name of the service broker.
  • service-broker-name
broker_url The URL of the service broker.
  • https://broker.example.com
auth_username The username with which to authenticate against the service broker.
  • admin
auth_password The password with which to authenticate against the service broker.
  • secretpassw0rd
{
  "auth_username": "admin-user",
  "auth_password": "some-secret",
  "broker_url": "https://mybroker.example.com"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0OCIsImVtYWlsIjoiZW1haWwtMjUwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDF9.8MZXScBL7YkoOm4pm1JCHDJri2pcBwxeX8S4BZhgl5g
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_brokers/9a62287f-31f4-420d-8403-ca36dba131fd" -d '{
  "auth_username": "admin-user",
  "auth_password": "some-secret",
  "broker_url": "https://mybroker.example.com"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0OCIsImVtYWlsIjoiZW1haWwtMjUwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjEzNzQ2NDF9.8MZXScBL7YkoOm4pm1JCHDJri2pcBwxeX8S4BZhgl5g" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "9a62287f-31f4-420d-8403-ca36dba131fd",
    "created_at": "2016-04-16T01:24:01Z",
    "updated_at": "2016-04-16T01:24:02Z",
    "url": "/v2/service_brokers/9a62287f-31f4-420d-8403-ca36dba131fd"
  },
  "entity": {
    "name": "name-1148",
    "broker_url": "https://mybroker.example.com",
    "auth_username": "admin-user",
    "space_guid": "81dbf372-9840-46ee-89a8-c026ade62535"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 45123a17-e8e1-40d8-bbc9-a87373c0eb43
Content-Length: 415
X-Content-Type-Options: nosniff
X-Cf-Warnings: Warning%3A+Warning+message+may+go+here.