PUT api/DataNodes/Archive?id={id}&minimumLogsToArchive={minimumLogsToArchive}

Performs the Log Archival process on this object and all child objects

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

ID of DataNode to Archive

integer

Required

minimumLogsToArchive

Minimum number of logs to archive. Default is 1

integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

indicating success

GetBooleanResponse
NameDescriptionTypeAdditional information
Bool

The boolean result

boolean

None.

Messages

Array of messages

Collection of Message

None.

ServerInformation

Relevant information regarding the Server

ServerInformation

None.

VersionInformation

Relevant information regarding the API's version

VersionInformation

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2025-11-09T21:27:07.2914566+10:00",
    "BuildDateUTC": "2025-11-09T21:27:07.2914566+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  },
  "Bool": true
}