Connection Brokers
Retrieve information about a list of RAS Connection Broker servers.
Site ID for which to retrieve the RAS Connection Broker server information (optional)
Filter the result by server name (optional)
GET /api/Broker HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-08T08:40:44.105Z",
"timeLastMod": "2025-07-08T08:40:44.105Z",
"server": "text",
"enabled": true,
"description": "text",
"siteId": 1,
"priority": 1,
"ip": "text",
"alternativeIPs": "text",
"standby": true,
"markedForDeletion": true
}
]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.
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.
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.
The password of the account specified in the Username parameter.
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.
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.
Create a new Connection Broker
FQDN or IP address of the server to add to a site as a RAS Connection Broker.
Site ID to which to add the RAS Connection Broker server. If the parameter is omitted, the Licensing Server site ID will be used.
POST /api/Broker HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 28
{
"server": "text",
"siteId": 1
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-08T08:40:44.105Z",
"timeLastMod": "2025-07-08T08:40:44.105Z",
"server": "text",
"enabled": true,
"description": "text",
"siteId": 1,
"priority": 1,
"ip": "text",
"alternativeIPs": "text",
"standby": true,
"markedForDeletion": true
}Retrieve a specific Connection Broker by ID.
RAS Connection Broker server ID
GET /api/Broker/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-08T08:40:44.105Z",
"timeLastMod": "2025-07-08T08:40:44.105Z",
"server": "text",
"enabled": true,
"description": "text",
"siteId": 1,
"priority": 1,
"ip": "text",
"alternativeIPs": "text",
"standby": true,
"markedForDeletion": true
}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.
RAS Connection Broker server ID
Update a Connection Broker settings
Enable or disable the specified RAS Connection Broker.
A user-defined RAS Connection Broker description.
An IP address of the RAS Connection Broker server.
A list of alternative IP addresses separated by a comma.
Set the specified RAS Secondary Connection Broker in Standby (or vice versa).
PUT /api/Broker/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 88
{
"enabled": true,
"description": "text",
"ip": "text",
"alternativeIPs": "text",
"standby": true
}No content
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.
RAS Connection Broker server ID
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.
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.
The password of the account specified in the Username parameter.
DELETE /api/Broker/{id} HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?