В этом разделе

Стратегии

1. Получение списка стратегий (GET `/backup_strategies`)

200 OK: Получен список стратегий.

2. Получение информации о стратегии (GET `/backup_strategies/{strategy_id}`)

Тела запроса нет. В query-параметрах передается id стратегии, информацию о правилах репликации которой необходимо получить.

200 OK: Получена информация о репликации стратегии.

3. Создание стратегии (POST `/backup_strategies`)

{
  "name": "my_backup_strategy", (1)
  "status": "wait",
  "pool_id": "Default",
  "crypto": "nocrypt",
  "storage_capacity": 50,
  "description": "",
  "validity_start_period": "2025-01-13T16:54:45.541246",
  "validity_end_period": "2026-01-13T16:54:45.541261",
  "verify_flag": true,
  "verify_interval": "1 day",
  "auto_delete_obsoleted_copy_flag": false,
  "inform_when_obsoleted_copy": "Nobody",
  "client_delete_flag": true,
  "full_archive_enabled": false,
  "full_periodic_launch": "1 min",
  "full_storage_duration": "1 day",
  "full_min": 0,
  "full_hour": 0,
  "full_dom": 1,
  "full_mon": 1,
  "full_dow": 1,
  "full_move_copy_flag": false,
  "full_move_copy_while": "1 day",
  "full_move_copy_pool": "Default",
  "inc_archive_enabled": false,
  "inc_periodic_launch": "1 min",
  "inc_storage_duration": "1 day",
  "inc_min": 0,
  "inc_hour": 0,
  "inc_dom": 1,
  "inc_mon": 1,
  "inc_dow": 1,
  "inc_move_copy_flag": false,
  "inc_move_copy_pool": "Default",
  "inc_move_copy_while": "1 day",
  "diff_archive_enabled": false,
  "diff_periodic_launch": "1 min",
  "diff_storage_duration": "1 day",
  "diff_min": 0,
  "diff_hour": 0,
  "diff_dom": 1,
  "diff_mon": 1,
  "diff_dow": 1,
  "diff_move_copy_flag": false,
  "diff_move_copy_pool": "Default",
  "diff_move_copy_while": "1 day",
  "notify_normal": "Nobody",
  "notify_normal_cc": "email@http://domain.ru/[domain.ru]",
  "notify_exception": "Nobody",
  "notify_exception_cc": "email@http://domain.ru/[domain.ru]",
  "notify_verify": "Nobody",
  "notify_verify_cc": "email@http://domain.ru/[domain.ru]",
  "notify_strategy_validity": "Nobody",
  "notify_strategy_validity_cc": "email@http://domain.ru/[domain.ru]",
  "notify_end_storage_capacity": "Nobody",
  "notify_end_storage_capacity_cc": "email@http://domain.ru/[domain.ru]"
}

1	Обязательное поле

201 CREATED: Стратегия создана.

4. Изменение параметров стратегии (PATCH `/backup_strategies/{strategy_id}`)

Также в query-параметрах передается id стратегии, информацию о которой необходимо изменить.

{
  "name": "my_backup_strategy",
  "status": "wait",
  "pool_id": "Default",
  "crypto": "nocrypt",
  "storage_capacity": 50,
  "description": "",
  "validity_start_period": "2025-01-13T16:54:45.541246",
  "validity_end_period": "2026-01-13T16:54:45.541261",
  "verify_flag": true,
  "verify_interval": "1 day",
  "auto_delete_obsoleted_copy_flag": false,
  "inform_when_obsoleted_copy": "Nobody",
  "client_delete_flag": true,
  "full_archive_enabled": false,
  "full_periodic_launch": "1 min",
  "full_storage_duration": "1 day",
  "full_min": 0,
  "full_hour": 0,
  "full_dom": 1,
  "full_mon": 1,
  "full_dow": 1,
  "full_move_copy_flag": false,
  "full_move_copy_while": "1 day",
  "full_move_copy_pool": "Default",
  "inc_archive_enabled": false,
  "inc_periodic_launch": "1 min",
  "inc_storage_duration": "1 day",
  "inc_min": 0,
  "inc_hour": 0,
  "inc_dom": 1,
  "inc_mon": 1,
  "inc_dow": 1,
  "inc_move_copy_flag": false,
  "inc_move_copy_pool": "Default",
  "inc_move_copy_while": "1 day",
  "diff_archive_enabled": false,
  "diff_periodic_launch": "1 min",
  "diff_storage_duration": "1 day",
  "diff_min": 0,
  "diff_hour": 0,
  "diff_dom": 1,
  "diff_mon": 1,
  "diff_dow": 1,
  "diff_move_copy_flag": false,
  "diff_move_copy_pool": "Default",
  "diff_move_copy_while": "1 day",
  "notify_normal": "Nobody",
  "notify_normal_cc": "email@http://domain.ru/[domain.ru]",
  "notify_exception": "Nobody",
  "notify_exception_cc": "email@http://domain.ru/[domain.ru]",
  "notify_verify": "Nobody",
  "notify_verify_cc": "email@http://domain.ru/[domain.ru]",
  "notify_strategy_validity": "Nobody",
  "notify_strategy_validity_cc": "email@http://domain.ru/[domain.ru]",
  "notify_end_storage_capacity": "Nobody",
  "notify_end_storage_capacity_cc": "email@http://domain.ru/[domain.ru]"
}

200 OK: Стратегия изменена.
400 BAD_REQUEST: Некорректное тело запроса.
404 NOT_FOUND: Стратегия не найдена.

5. Изменение статуса стратегии (PATCH `/backup_strategies`)

{
  "strategies": [
    {
      "strategy_id": 1, (1)
      "status": "wait" (1)
    }
  ]
}

1	Обязательное поле

200 OK: Статус стратегии изменен.
400 BAD_REQUEST: Некорректное тело запроса.
404 NOT_FOUND: Стратегия не найдена.

6. Удаление списка стратегий (DELETE `/backup_strategies`)

{
  "ids": [ (1)
    1
  ]
}

1	Обязательное поле

200 OK: Стратегии удалены.
404 NOT_FOUND: Стратегия не найдена.

7. Получение списка правил стратегий (GET `/backup_strategies/rules`)

200 OK: Получен список правил стратегии.

8. Получение информации о правиле стратегии (GET `/backup_strategies/rules/{rule_id}`)

Тело запроса отсутствует. В query-параметрах передается id правила, информацию о котором необходимо получить.

200 OK: Правило стратегии удалено.
404 NOT_FOUND: Правило стратегии не найдено.

9. Добавление правила в стратегию (POST `/backup_strategies/rules`)

{
  "strategy_rule": {
    "client_id": "rubackup-client (525a99154f3505a2)", (1)
    "strategy_id": "Default", (1)
    "resource_type": "File system", (1)
    "resource": "/home/", (1)
    "normal_execution_script": "",
    "exception_execution_script": "",
    "priority": 100,
    "restore_script": ""
  },
  "module_extensions": {
    "parameters": {
      "file_list": true,
      "numeric_owner": false,
      "use_snapshot": false,
      "ignore_errors_snapshot": true,
      "snapshot_type": "",
      "snapshot_size": 10,
      "script_before_snapshot": "",
      "script_after_snapshot": "",
      "script_error_snapshot": ""
    }
  },
  "common_modules_extensions": {
    "parameters": {
      "worker_parallelism": 8,
      "enable_multithreading": false,
      "enable_flexible_dedup": false,
      "network_parallelism": 8,
      "memory_threshold": 0,
      "deny_memory_exceed": false,
      "restore_corrupted_blocks": "full_analysis",
      "deduplication": true
    }
  }
}

1	Обязательное поле

201 CREATED: Правило добавлено в стратегию.

10. Изменение правила стратегии (PATCH `/backup_strategies/rules/{rule_id}`)

Также в query-параметрах передается id правила, информацию о котором необходимо изменить.

{
  "strategy_rule": {
    "client_id": "rubackup-client (525a99154f3505a2)",
    "strategy_id": "Default",
    "resource_type": "File system",
    "resource": "/home/",
    "normal_execution_script": "",
    "exception_execution_script": "",
    "priority": 100,
    "restore_script": ""
  },
  "module_extensions": {
    "parameters": {
      "file_list": true,
      "numeric_owner": false,
      "use_snapshot": false,
      "ignore_errors_snapshot": true,
      "snapshot_type": "",
      "snapshot_size": 10,
      "script_before_snapshot": "",
      "script_after_snapshot": "",
      "script_error_snapshot": ""
    }
  },
  "common_modules_extensions": {
    "parameters": {
      "worker_parallelism": 8,
      "enable_multithreading": false,
      "enable_flexible_dedup": false,
      "network_parallelism": 8,
      "memory_threshold": 0,
      "deny_memory_exceed": false,
      "restore_corrupted_blocks": "full_analysis",
      "deduplication": true
    }
  }
}

200 OK: Параметры правила стратегии изменены.
400 BAD_REQUEST: Некорректное тело запроса.
404 NOT_FOUND: Правило стратегии не найдено.

11. Удаление списка правил стратегии (DELETE `/backup_strategies/rules`)

{
  "ids": [ (1)
    1
  ]
}

1	Обязательное поле

204 NO_CONTENT: Список правил стратегии удален.
404 NOT_FOUND: Правило стратегии не найдено.

12. Получение дополнительных параметров правила стратегии (GET `/backup_strategies/extension`)

Тело запроса отсутствует. В query-параметрах передается название ресурса (resource_type) или название ресурса и id правила, информацию о дополнительных параметрах которых необходимо получить.

200 OK: Информация о дополнительных параметрах получена.

13. Получение списка администраторов стратегии (GET `/backup_strategies/{strategy_id}/administrators`)

Тела запроса нет. В query-параметрах передается id стратегии, информацию об администраторе которой необходимо получить.

200 OK: Получен список администраторов для стратегии.

14. Назначение администраторов стратегии (POST `/backup_strategies/{strategy_id}/administrators`)

Также в query-параметрах передается id стратегии, которой должен быть назначен администратор.

{
    "administrator": "Nobody" (1)
}

1	Обязательное поле

201 CREATED: Администратор для стратегии назначен.

15. Удаление списка администраторов стратегии (DELETE `/backup_strategies/administrators`)

{
  "ids": [ (1)
    1
  ]
}

1	Обязательное поле

200 OK: Список администраторов стратегии удален.
404 NOT_FOUND: Администратор стратегии не найден.