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

Route

PUT /v2/service_brokers/f5914a06-ec6f-4556-a850-1e16cfae2799

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/f5914a06-ec6f-4556-a850-1e16cfae2799" -d '{
  "auth_username": "admin-user",
  "auth_password": "some-secret",
  "broker_url": "https://mybroker.example.com"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwMCIsImVtYWlsIjoiZW1haWwtNzBAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjMyMzUzNX0.FI8Z2Ha7WZeurOU4iCR34l2mZai0WU-r1ukxw76Zcvc" \
	-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: 52975159-8f73-4295-9032-cba5500b2739
Content-Length: 366
X-Content-Type-Options: nosniff
X-Cf-Warnings: Warning%3A+Warning+message+may+go+here.

Status

200 OK

Body

{
  "metadata": {
    "guid": "f5914a06-ec6f-4556-a850-1e16cfae2799",
    "created_at": "2015-01-20T01:52:15+00:00",
    "updated_at": "2015-01-20T01:52:15+00:00",
    "url": "/v2/service_brokers/f5914a06-ec6f-4556-a850-1e16cfae2799"
  },
  "entity": {
    "name": "name-380",
    "broker_url": "https://mybroker.example.com",
    "auth_username": "admin-user"
  }
}