Бэкапы и возврат к предыдущей версии

Длина комментариев (comment) при API-запросах ограничена 255 символами.

Получение настроек бэкапов

GET /backup/settings

Ответ на успешный запрос:

{
   "common": {
      "hour": "integer",
      "rotate": "weekly" | "monthly"
   },
   "ftp": {
      "enabled": "boolean",
      "server": "string",
      "login": "string",
      "password": "string",
      "remote_dir": "string"
   },
   "cifs": {
      "enabled": "boolean",
      "server": "string",
      "login": "string",
      "password": "string",
      "remote_dir": "string"
   }
}

• common - общие настройки бэкапов;

  • hour - час, в который делается автоматический бэкап, число от 0 до 23;

  • rotate - удалять бэкапы старше недели (weekly) или месяца (monthly).

• ftp - настройки выгрузки бэкапов на FTP:

  • enabled - если true, то выгрузка включена, false - выключена;

  • server - адрес сервера, валидный домен или IP-адрес;

  • login - логин, не пустая строка;

  • password - пароль, не пустая строка, до 42 символов;

  • remote_dir - удаленный каталог, не пустая строка.

• cifs - настройки выгрузки бэкапов в общую папку CIFS:

  • enabled - если true, то выгрузка включена, false - выключена;

  • server - адрес сервера, валидный домен или IP-адрес;

  • login - логин, не пустая строка;

  • password - пароль, не пустая строка, до 42 символов;

  • remote_dir - удаленный каталог, не пустая строка.

Изменение настроек бэкапов и настройка выгрузки на FTP-сервер или в общую папку CIFS

PATCH  /backup/settings

Json-тело запроса:

{
   "common": {
      "hour": "integer",
      "rotate": "weekly | monthly"
   },
   "ftp": {
      "enabled": "boolean",
      "server": "string",
      "login": "string",
      "password": "string",
      "remote_dir": "string"
   },
   "cifs": {
      "enabled": "boolean",
      "server": "string",
      "login": "string",
      "password": "string",
      "remote_dir": "string"
   }
}

• common - общие настройки бекапов:

  • hour - час, в который делается автоматический бекап, число от 0 до 23;

  • rotate - удалять бекапы старше недели (weekly) или месяца (monthly).

• ftp - настройки выгрузки бекапов на FTP:

  • enabled - если true, то выгрузка включена, false - выключена;

  • server - адрес сервера, валидный домен или IP-адрес;

  • login - логин, не пустая строка;

  • password - пароль, не пустая строка, до 42 символов;

  • remote_dir - удаленный каталог, не пустая строка.

• cifs - настройки выгрузки бекапов в общую папку CIFS:

  • enabled - если true, то выгрузка включена, false - выключена;

  • server - адрес сервера, валидный домен или IP-адрес;

  • login - логин, не пустая строка;

  • password - пароль, не пустая строка, до 42 символов;

  • remote_dir - удаленный каталог, не пустая строка.

Ответ на успешный запрос: 200 OK

Управление бэкапами

Создание бэкапа

POST /backup/backups

Json-тело запроса:

{
   "comment": "string"
}

• comment - комментарий, произвольный текст.

Ответ на успешный запрос:

{
    "id": "string"
}

• id - идентификатор бэкапа.

Получение списка бэкапов

GET /backup/backups

Ответ на успешный запрос:

[
   {
      "id": "string",
      "version": {
         "major": "integer",
         "minor": "integer",
         "build": "integer",
         "timestamp": "integer",
         "vendor": "Ideco",
         "product": "UTM" | "CC",
         "kind": "FSTEK" | "VPP" | "STANDARD" | "BPF",
         "release_type": "release" | "beta" | "devel"
      },
      "timestamp": "float",
      "comment": "string",
      "md5": "string",
      "size": "integer",
      "fast_restore_allowed": "boolean"
   }
...
]

• id - идентификатор бэкапа;

• version - версия системы:

  • major - мажорный номер версии;

  • minor - минорный номер версии;

  • build - номер сборки;

  • timestamp - время выхода версии;

  • vendor - вендор ("Ideco");

  • product - код продукта;

  • kind - вид продукта;

  • release_type - тип релиза;

• timestamp - дата/время создания бэкапа в формате UNIX timestamp;

• comment - комментарий, произвольный текст;

• md5 - контрольная сумма файла бэкапа (data.tar);

• size - размер бэкапа, байт;

• fast_restore_allowed - можно ли выполнить быстрое восстановление из данного бэкапа (версия идентична системной).

Скачивание бэкапа

GET /backup/download/<id бэкапа>

Ответ на успешный запрос: тело бэкапа.

Загрузка бэкапа на Ideco NGFW из файла

POST /backup/upload

Используйте стандартный POST-запрос на загрузку файла. Название поля в форме должно быть backup_file.

Ответ на успешный запрос:

{
   "id": "string"
}

• id - идентификатор бэкапа.

Восстановление из бэкапа

POST /backup/backups/<id бэкапа>/apply

Ответ на успешный запрос: 200 OK

Быстрое восстановление из бэкапа

POST /backup/backups/<id бэкапа>/apply/fast

Ответ на успешный запрос: 200 OK

Удаление бэкапа

DELETE /backup/backups/<id бэкапа>

Ответ на успешный запрос: 200 OK

Возврат к предыдущей версии Ideco NGFW

Получение информации о наличии предыдущей версии

GET /system_management/change_sys_root

Ответ на успешный запрос:

{
   "previous_version": {
      "major": "integer",
      "minor": "integer",
      "build": "integer",
      "timestamp": "integer",
      "vendor": "string",
      "product": "UTM" | "CC",
      "kind": "FSTEK" | "NGFW-FSTEK" | "VPP" | "STANDARD" | "BPF",
      "release_type": "release" | "beta" | "devel"
   }
}

• major - мажорный номер версии;

• minor - минорный номер версии;

• build - номер сборки;

• timestamp - время сборки версии в формате UNIX timestamp;

• vendor - вендор продукта. Значения могут быть произвольными;

• product - название продукта;

• kind - вид продукта;

• release_type - тип редакции.

Если предыдущей версии не было, то значение поля previous_version будет null.

Возврат к предыдущей версии

POST /system_management/change_sys_root

Json-тело запроса:

{
   "version": {
      "major": "integer",
      "minor": "integer",
      "build": "integer",
      "timestamp": "integer",
      "vendor": "string",
      "product": "UTM" | "CC",
      "kind": "FSTEK" | "NGFW-FSTEK" | "VPP" | "STANDARD" | "BPF",
      "release_type": "release" | "beta" | "devel"
   }
}

• major - мажорный номер версии;

• minor - минорный номер версии;

• build - номер сборки;

• timestamp - время сборки версии в формате UNIX timestamp;

• vendor - вендор продукта. Значения могут быть произвольными;

• product - название продукта;

• kind - вид продукта;

• release_type - тип редакции.

Ответ на успешный запрос: 200 OK