Enrollment Servers
Retrieve information about one or multiple Enrollment servers.
Site ID from which to retrieve the Enrollment server (optional).
The name of the Enrollment server for which to retrieve the information. This must be the actual Enrollment server name used in the RAS farm.
GET /api/EnrollmentServer HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-02T19:06:46.483Z",
"timeLastMod": "2025-07-02T19:06:46.483Z",
"server": "text",
"enabled": true,
"description": "text",
"siteId": 1,
"preferredBrokerId": 1
}
]Create a new Enrollment server.
Set it to true if Enrollment server should be initialized after being added. (optional)
An administrator account for push installing the Enrollment 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 add firewall rules to allow the Enrollment server to communicate. If this parameter is omitted, the firewall rules will not be added.
Create a new enrollment server
Enable or disable the enrollment server upon creation. If the parameter is omitted, the enrollment server is initialised as disabled.
The enrollment server description.
POST /api/EnrollmentServer HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 37
{
"enabled": true,
"description": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-02T19:06:46.483Z",
"timeLastMod": "2025-07-02T19:06:46.483Z",
"server": "text",
"enabled": true,
"description": "text",
"siteId": 1,
"preferredBrokerId": 1
}Retrieve information about one Enrollment server by ID.
The ID of an Enrollment server for which to retrieve the information.
GET /api/EnrollmentServer/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-02T19:06:46.483Z",
"timeLastMod": "2025-07-02T19:06:46.483Z",
"server": "text",
"enabled": true,
"description": "text",
"siteId": 1,
"preferredBrokerId": 1
}Modify properties of an Enrollment server.
The ID from which to retrieve Enrollment server information. This must be the actual server name used in the RAS farm.
Update an enrollment server settings
The new server of the target enrollment server.
The enrollment server description.
Enable or disable the specified enrollment server in a site.
ID of the preferred Connection Broker.
PUT /api/EnrollmentServer/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 75
{
"server": "text",
"description": "text",
"enabled": true,
"preferredBrokerId": 1
}No content
Remove an Enrollment server from a site.
The ID of an Enrollment server for which to retrieve the information.
If this parameter is included, the Enrollment server agent will not be uninstalled from the server. To uninstall the agent, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials if needed using the Username and Password parameters.
An administrator account to remotely uninstall the Enrollment server agent from the 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/EnrollmentServer/{id} HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?