Enrollment Servers

List

get

Retrieve information about one or multiple Enrollment servers.

Query parameters
SiteIdinteger · int32Optional

Site ID from which to retrieve the Enrollment server (optional).

ServerstringOptional

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.

Responses
200
Success
application/json; api-version=1.0
get
GET /api/EnrollmentServer HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-06-24T07:19:06.021Z",
    "timeLastMod": "2025-06-24T07:19:06.021Z",
    "server": "text",
    "enabled": true,
    "description": "text",
    "siteId": 1,
    "preferredBrokerId": 1
  }
]

Create

post

Create a new Enrollment server.

Query parameters
noInstallbooleanOptional

Set it to true if Enrollment server should be initialized after being added. (optional)

usernamestringOptional

An administrator account for push installing the Enrollment 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.

noFireWallRulesbooleanOptional

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.

Body

Create a new enrollment server

enabledbooleanOptional

Enable or disable the enrollment server upon creation. If the parameter is omitted, the enrollment server is initialised as disabled.

descriptionstring | nullableOptional

The enrollment server description.

Responses
201
Created
application/json; api-version=1.0
post
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-06-24T07:19:06.021Z",
  "timeLastMod": "2025-06-24T07:19:06.021Z",
  "server": "text",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "preferredBrokerId": 1
}

Get

get

Retrieve information about one Enrollment server by ID.

Path parameters
idinteger · int32Required

The ID of an Enrollment server for which to retrieve the information.

Responses
200
Success
application/json; api-version=1.0
get
GET /api/EnrollmentServer/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-06-24T07:19:06.021Z",
  "timeLastMod": "2025-06-24T07:19:06.021Z",
  "server": "text",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "preferredBrokerId": 1
}

Update

put

Modify properties of an Enrollment server.

Path parameters
idinteger · int32Required

The ID from which to retrieve Enrollment server information. This must be the actual server name used in the RAS farm.

Body

Update an enrollment server settings

serverstring | nullableOptional

The new server of the target enrollment server.

descriptionstring | nullableOptional

The enrollment server description.

enabledboolean | nullableOptional

Enable or disable the specified enrollment server in a site.

preferredBrokerIdinteger · int32 | nullableOptional

ID of the preferred Connection Broker.

Responses
204
No Content
put
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

Delete

delete

Remove an Enrollment server from a site.

Path parameters
idinteger · int32Required

The ID of an Enrollment server for which to retrieve the information.

Query parameters
noUninstallbooleanOptional

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.

usernamestringOptional

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.

passwordstringOptional

The password of the account specified in the Username parameter.

Responses
204
No Content
delete
DELETE /api/EnrollmentServer/{id} HTTP/1.1
Host: 
Accept: */*

No content

Last updated

Was this helpful?