Home
Version 3
Service Brokers API

Service Brokers API

Update a Service Broker

PUT /v2/service_brokers/:guid

Request

Route

PUT /v2/service_brokers/21e6f198-e5e3-40b6-8612-0e0bbaec5fc5

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

cURL

curl "https://api.[your-domain.com]/v2/service_brokers/21e6f198-e5e3-40b6-8612-0e0bbaec5fc5" -d '{
  "auth_username": "admin-user",
  "auth_password": "some-secret",
  "broker_url": "https://mybroker.example.com"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ2IiwiZW1haWwiOiJlbWFpbC00NUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU2NDUyMjIyfQ.6huLCmoRzhyqOyErBoXLosusgFVRXW7EduXDCTUVmF0" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "21e6f198-e5e3-40b6-8612-0e0bbaec5fc5",
    "created_at": "2016-02-19T02:03:42Z",
    "updated_at": "2016-02-19T02:03:42Z",
    "url": "/v2/service_brokers/21e6f198-e5e3-40b6-8612-0e0bbaec5fc5"
  },
  "entity": {
    "name": "name-174",
    "broker_url": "https://mybroker.example.com",
    "auth_username": "admin-user",
    "space_guid": "45dacb6e-41e5-45dd-ba01-d12c76193407"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 414
X-Content-Type-Options: nosniff
X-Cf-Warnings: Warning%3A+Warning+message+may+go+here.