Home
Version 3
Service Brokers API

Service Brokers API

Update a Service Broker

PUT /v2/service_brokers/:guid

Fields

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

Parameters

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyMiIsImVtYWlsIjoiZW1haWwtMTYzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzV9.m-CUIl_cG5YcdqVC6dVojEJpva3EZ-3q4pyyYjnRWhM
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

PUT /v2/service_brokers/f7a83309-68b9-4615-bcea-9c07f2ae6230

Body

{
  "auth_username": "admin-user",
  "auth_password": "some-secret",
  "broker_url": "https://mybroker.example.com"
}

cURL

curl "https://api.[your-domain.com]/v2/service_brokers/f7a83309-68b9-4615-bcea-9c07f2ae6230" -d '{
  "auth_username": "admin-user",
  "auth_password": "some-secret",
  "broker_url": "https://mybroker.example.com"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyMiIsImVtYWlsIjoiZW1haWwtMTYzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjI5OTA4NzV9.m-CUIl_cG5YcdqVC6dVojEJpva3EZ-3q4pyyYjnRWhM" \
	-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: e5df5f7d-07e0-4d82-8051-d5155540faa4
Content-Length: 357
X-Content-Type-Options: nosniff
X-Cf-Warnings: Warning%3A+Warning+message+may+go+here.

Status

200 OK

Body

{
  "metadata": {
    "guid": "f7a83309-68b9-4615-bcea-9c07f2ae6230",
    "created_at": "2015-01-27T19:14:35Z",
    "updated_at": "2015-01-27T19:14:35Z",
    "url": "/v2/service_brokers/f7a83309-68b9-4615-bcea-9c07f2ae6230"
  },
  "entity": {
    "name": "name-1412",
    "broker_url": "https://mybroker.example.com",
    "auth_username": "admin-user"
  }
}