Enrollment Servers

PreviousBroker Promotion NextStatus

Last updated 10 months ago

Was this helpful?

List

Retrieve information about one or multiple Enrollment servers.

GET/api/EnrollmentServer

Query parameters

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

servernullable string

Server name.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

preferredBrokerIdinteger (int32)

ID of the preferred Connection Broker.

Request

const response = await fetch('/api/EnrollmentServer', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-02-05T03:55:08.059Z",
    "timeLastMod": "2025-02-05T03:55:08.059Z",
    "server": "text",
    "enabled": true,
    "description": "text",
    "siteId": 1,
    "preferredBrokerId": 1
  }
]

Create

Create a new Enrollment server.

POST/api/EnrollmentServer

Query parameters

Body

Enrollment server settings

enabledboolean

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

descriptionnullable string

The enrollment server description.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

servernullable string

Server name.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

preferredBrokerIdinteger (int32)

ID of the preferred Connection Broker.

Request

const response = await fetch('/api/EnrollmentServer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-05T03:55:08.059Z",
  "timeLastMod": "2025-02-05T03:55:08.059Z",
  "server": "text",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "preferredBrokerId": 1
}

Get

Retrieve information about one Enrollment server by ID.

GET/api/EnrollmentServer/{id}

Path parameters

id*integer (int32)

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

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

servernullable string

Server name.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

preferredBrokerIdinteger (int32)

ID of the preferred Connection Broker.

Request

const response = await fetch('/api/EnrollmentServer/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-05T03:55:08.059Z",
  "timeLastMod": "2025-02-05T03:55:08.059Z",
  "server": "text",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "preferredBrokerId": 1
}

Update

Modify properties of an Enrollment server.

PUT/api/EnrollmentServer/{id}

Path parameters

id*integer (int32)

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

Body

Enrollment server settings

servernullable string

The new server of the target enrollment server.

descriptionnullable string

The enrollment server description.

enablednullable boolean

Enable or disable the specified enrollment server in a site.

preferredBrokerIdnullable integer (int32)

ID of the preferred Connection Broker.

Response

No Content

Request

const response = await fetch('/api/EnrollmentServer/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Delete

Remove an Enrollment server from a site.

DELETE/api/EnrollmentServer/{id}

Path parameters

id*integer (int32)

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

Query parameters

Response

No Content

Request

const response = await fetch('/api/EnrollmentServer/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}