Connection Brokers

PreviousEULA NextPriority

Was this helpful?

Get

get

Retrieve a specific Connection Broker by ID.

Path parameters

idinteger · int32required

RAS Connection Broker server ID

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Broker/{id}'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:34:35.881Z",
  "timeLastMod": "2025-04-06T01:34:35.881Z",
  "server": "text",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "priority": 1,
  "ip": "text",
  "alternativeIPs": "text",
  "standby": true,
  "markedForDeletion": true
}

Success

Delete

delete

Delete a RAS Connection Broker server from a site. The RAS Connection Broker server will be uninstalled from the server by default. You can optionally keep it by including the noUninstall parameter.

Path parameters

idinteger · int32required

RAS Connection Broker server ID

Query parameters

noUninstallbooleanoptional

Include this parameter if you wish to keep the RAS Connection Broker software on the server. To uninstall the agent software, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials by including the Username and Password parameters.

usernamestringoptional

A username that will be used to remotely uninstall the RAS Connection Broker software from the target server. If this parameter is omitted, your RAS admin username and password will be used by default.

passwordstringoptional

The password of the account specified in the Username parameter.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/Broker/{id}'

204

401

404

No Content

List

get

Retrieve information about a list of RAS Connection Broker servers.

Query parameters

SiteIdinteger · int32optional

Site ID for which to retrieve the RAS Connection Broker server information (optional)

Serverstringoptional

Filter the result by server name (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Broker'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-06T01:34:35.881Z",
    "timeLastMod": "2025-04-06T01:34:35.881Z",
    "server": "text",
    "enabled": true,
    "description": "text",
    "siteId": 1,
    "priority": 1,
    "ip": "text",
    "alternativeIPs": "text",
    "standby": true,
    "markedForDeletion": true
  }
]

Success

Create

post

Add a new RAS Connection Broker server to a site. The agent software will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.

Query parameters

noInstallbooleanoptional

Specifies not to install the agent software on the server. If you omit this parameter, the agent will be push installed on the server using your RAS admin credentials To specify different credentials, include the Username and Password parameters.

usernamestringoptional

An administrator account for push installing the agent on the server. If this parameter is omitted, your RAS admin username and password will be used.

passwordstringoptional

The password of the account specified in the Username parameter.

noRestartbooleanoptional

Specifies not to restart the server after the RAS Connection Broker is installed. If this parameter is omitted, the server will be restarted if required.

noFireWallRulesbooleanoptional

Specifies not to add firewall rules to allow the RD Session Host and the Connection Broker to communicate. If this parameter is omitted, the firewall rules will not be added.

Body

Create a new Connection Broker

serverstring | nullablerequired

FQDN or IP address of the server to add to a site as a RAS Connection Broker.

siteIdinteger · int32optional

Site ID to which to add the RAS Connection Broker server. If the parameter is omitted, the Licensing Server site ID will be used.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Broker' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "server": "text",
    "siteId": 1
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:34:35.881Z",
  "timeLastMod": "2025-04-06T01:34:35.881Z",
  "server": "text",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "priority": 1,
  "ip": "text",
  "alternativeIPs": "text",
  "standby": true,
  "markedForDeletion": true
}

Created

Update

put

Modify settings of a RAS Connection Broker server. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Path parameters

idinteger · int32required

RAS Connection Broker server ID

Body

Update a Connection Broker settings

enabledboolean | nullableoptional

Enable or disable the specified RAS Connection Broker.

descriptionstring | nullableoptional

A user-defined RAS Connection Broker description.

ipstring | nullableoptional

An IP address of the RAS Connection Broker server.

alternativeIPsstring | nullableoptional

A list of alternative IP addresses separated by a comma.

standbyboolean | nullableoptional

Set the specified RAS Secondary Connection Broker in Standby (or vice versa).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/Broker/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enabled": true,
    "description": "text",
    "ip": "text",
    "alternativeIPs": "text",
    "standby": true
  }'

204

401

404

No Content