v2

latestOpenAPI 3.1.0CC-BY-SA 2.02026-07-2617789528.6 KB
System

Restore an archive

Restore an archive of the given kind for the given moment

post/system/archives/{archiveKind}/restore/{archiveRestoreKind}

Path parameters

archiveKind'full' | 'groups' | 'rules' | 'directives' | 'parameters' required
Example:full

Type of archive to make

archiveRestoreKind'latestArchive' | 'latestCommit' | 'archive ID' required

What archive to restore (latest archive, latest commit in configuration repository, or archive with ID as given by listArchive)

Example:latestCommit

Response

Success

result'success' | 'error' required

Result of the request

action'restoreFullLatestArchive' | 'restoreGroupLatestArchive' | 'restoreRulesLatestArchive' | 'restoreDirectivesLatestArchive' | 'restoreParametersLatestArchive' | 'restoreFullLatestCommit' | 'restoreGroupLatestCommit' | 'restoreRulesLatestCommit' | 'restoreDirectivesLatestCommit' | 'restoreParametersLatestCommit' | 'archiveFullDateRestore' | 'archiveGroupDateRestore' | 'archiveRulesDateRestore' | 'archiveDirectivesDateRestore' | 'archiveParametersDateRestore' required

The kind of the archive

Example response

{
  "action": "restoreFullLatestArchive",
  "data": {
    "full": "Started",
    "groups": "Started",
    "rules": "Started",
    "directive": "Started",
    "parameters": "Started"
  }
}