VPS.org API

Документация по REST API

API резервного копирования

Управляйте резервными копиями серверов программным способом. Создавайте, восстанавливайте и удаляйте резервные копии ваших серверов.

Конечные точки 3 endpoints
Базовый путь /api/v1/backups
ПОЛУЧАТЬ /api/v1/backups/

Список всех резервных копий

Получите список всех резервных копий на ваших серверах.

Параметры запроса

Параметр Тип Необходимый Описание
server_id integer Нет Фильтрация резервных копий по идентификатору сервера
backup_type string Нет Фильтр по типу: manual , automatic

Пример запроса

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/?server_id=12345" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
params = {"server_id": 12345}

response = requests.get(url, headers=headers, params=params)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/backups/?server_id=12345', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const backups = await response.json();
console.log(backups);

Пример ответа

{
  "count": 3,
  "results": [
    {
      "id": 501,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4523,
      "created_at": "2025-01-16T03:00:00Z",
      "expires_at": "2025-02-16T03:00:00Z",
      "description": "Automatic daily backup"
    },
    {
      "id": 499,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "manual",
      "status": "completed",
      "size_mb": 4456,
      "created_at": "2025-01-14T10:30:00Z",
      "expires_at": null,
      "description": "Pre-update backup"
    },
    {
      "id": 495,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4389,
      "created_at": "2025-01-15T03:00:00Z",
      "expires_at": "2025-02-15T03:00:00Z",
      "description": "Automatic daily backup"
    }
  ]
}

Коды состояния ответа

200 Список резервных копий успешно получен.
401 Несанкционированный доступ — недействительный или отсутствующий токен аутентификации.
ПОЧТА /api/v1/backups/

Создать резервную копию вручную

Создайте резервную копию сервера вручную. Резервные копии, созданные вручную, не удаляются автоматически.

Параметры тела запроса

Параметр Тип Необходимый Описание
server_id integer Да Идентификатор сервера для резервного копирования
description string Нет Дополнительное описание для резервной копии

Пример запроса

cURL
Python
JavaScript
PHP
curl -X POST "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": 12345,
    "description": "Pre-deployment backup"
  }'
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "server_id": 12345,
    "description": "Pre-deployment backup"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    server_id: 12345,
    description: 'Pre-deployment backup'
  })
});

const backup = await response.json();
console.log(backup);
$data = [
    'server_id' => 12345,
    'description' => 'Pre-deployment backup'
];

$ch = curl_init('https://admin.vps.org/api/v1/backups/');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$backup = json_decode($response, true);
curl_close($ch);

Пример ответа

{
  "id": 502,
  "server": {
    "id": 12345,
    "name": "web-server-01"
  },
  "backup_type": "manual",
  "status": "in_progress",
  "size_mb": null,
  "created_at": "2025-01-16T15:45:00Z",
  "expires_at": null,
  "description": "Pre-deployment backup",
  "message": "Backup is being created. This may take several minutes depending on server size."
}

Коды состояния ответа

201 Создание резервной копии успешно инициировано.
400 Неверный запрос — недопустимые параметры или некорректный формат запроса.
401 Несанкционированный доступ — недействительный или отсутствующий токен аутентификации.
404 Сервер не найден.
Примечание: На каждом сервере можно создать максимум 10 резервных копий вручную. Автоматические резервные копии сохраняются в соответствии с политикой хранения резервных копий вашего тарифного плана (обычно от 7 до 30 дней).
УДАЛИТЬ /api/v1/backups/{backup_id}/

Удалить резервную копию

Удалить резервную копию безвозвратно. Это действие необратимо.

Параметры пути

Параметр Тип Необходимый Описание
backup_id integer Да Уникальный идентификатор резервной копии

Пример запроса

cURL
Python
JavaScript
curl -X DELETE "https://admin.vps.org/api/v1/backups/501/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

backup_id = 501
url = f"https://admin.vps.org/api/v1/backups/{backup_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code)
const backupId = 501;
const response = await fetch(`https://admin.vps.org/api/v1/backups/${backupId}/`, {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

console.log(response.status);

Коды состояния ответа

204 Резервная копия успешно удалена.
401 Несанкционированный доступ — недействительный или отсутствующий токен аутентификации.
404 Не найдено - Резервная копия отсутствует
Предупреждение: Удаление резервной копии является необратимым и не подлежит отмене. Перед удалением убедитесь, что эта резервная копия вам больше не нужна.

Восстановление из резервных копий

Для восстановления сервера из резервной копии используйте конечную точку восстановления API серверов :

POST /api/v1/servers/{server_id}/restore/
{
  "backup_id": 501
}

Подробную информацию о восстановлении сервера см. в разделе Документация по API серверов.

Рекомендации по резервному копированию