Sites
Retrieve the list of all the available Sites.
Filter the result by name (optional)
GET /api/Site HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-08T06:55:31.154Z",
"timeLastMod": "2025-07-08T06:55:31.154Z",
"name": "text",
"licensingSite": true,
"enableHttpHostAttackProtection": true
}
]Add a new site to the RAS farm.
If this parameter is included, the Connection Broker software will not be installed on the target server. You may use this option if the server already has the Connection Broker installed.
A username to log in to the target server and push install the Connection Broker on it. You must also specify the Password parameter. If you've included the NoInstall parameter, you don't have to include the Username and Password parameters.
The password for the user specified in the Username parameter.
Specifies not to add firewall rules to allow the RAS Agent to communicate. If this parameter is omitted, the firewall rules will not be added.
Specifies not to restart the server after the RAS agents are installed. If this parameter is omitted, the server will be restarted if required.
Create a new Site
The target server FQDN or IP address.
The name you want to use for the new site.
POST /api/Site HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31
{
"server": "text",
"name": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-08T06:55:31.154Z",
"timeLastMod": "2025-07-08T06:55:31.154Z",
"name": "text",
"licensingSite": true,
"enableHttpHostAttackProtection": true
}Retrieve a Site.
ID of the Site to be retrieved
GET /api/Site/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-08T06:55:31.154Z",
"timeLastMod": "2025-07-08T06:55:31.154Z",
"name": "text",
"licensingSite": true,
"enableHttpHostAttackProtection": true
}Modify the Site properties.
ID of the Site to be updated
Update Site settings
A new name to assign to the site.
Whether Http Host Attack protection is enabled for this site or not.
PUT /api/Site/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 53
{
"name": "text",
"enableHttpHostAttackProtection": true
}No content
Was this helpful?