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

Route

PUT /v2/service_brokers/dbcc0a7a-2680-4c62-a971-6f269d86ff4e

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/dbcc0a7a-2680-4c62-a971-6f269d86ff4e" -d '{
  "auth_username": "admin-user",
  "auth_password": "some-secret",
  "broker_url": "https://mybroker.example.com"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1MCIsImVtYWlsIjoiZW1haWwtMjUyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE3MDd9.F79djhb_eIhZSn_0tK29Kb1cmeFa8TLjKkQ4FMbTrvU" \
	-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: 3227be2c-764b-450c-aceb-f63207155f68
Content-Length: 357
X-Content-Type-Options: nosniff
X-Cf-Warnings: Warning%3A+Warning+message+may+go+here.

Status

200 OK

Body

{
  "metadata": {
    "guid": "dbcc0a7a-2680-4c62-a971-6f269d86ff4e",
    "created_at": "2015-02-13T22:35:07Z",
    "updated_at": "2015-02-13T22:35:07Z",
    "url": "/v2/service_brokers/dbcc0a7a-2680-4c62-a971-6f269d86ff4e"
  },
  "entity": {
    "name": "name-1942",
    "broker_url": "https://mybroker.example.com",
    "auth_username": "admin-user"
  }
}