Home
Version 3
Service Brokers API

Service Brokers API

Update a Service Broker

PUT /v2/service_brokers/:guid

Request

Route

PUT /v2/service_brokers/2998e50a-f9bf-4ced-82e4-04f80e176e86

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

cURL

curl "https://api.[your-domain.com]/v2/service_brokers/2998e50a-f9bf-4ced-82e4-04f80e176e86" -d '{
  "auth_username": "admin-user",
  "auth_password": "some-secret",
  "broker_url": "https://mybroker.example.com"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2OCIsImVtYWlsIjoiZW1haWwtMTk2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzE2NDY2Mzl9.E-CFHfozUVcw37pWxv75SPZLZzHwApRGaZKvjXLD8z4" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "2998e50a-f9bf-4ced-82e4-04f80e176e86",
    "created_at": "2015-05-07T23:37:19Z",
    "updated_at": "2015-05-07T23:37:19Z",
    "url": "/v2/service_brokers/2998e50a-f9bf-4ced-82e4-04f80e176e86"
  },
  "entity": {
    "name": "name-1569",
    "broker_url": "https://mybroker.example.com",
    "auth_username": "admin-user"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: face2bb7-eef1-4564-a47e-471ab2c42f68
Content-Length: 357
X-Content-Type-Options: nosniff
X-Cf-Warnings: Warning%3A+Warning+message+may+go+here.