Servers API - VPS.org

ПОЛУЧАТЬ /api/v1/servers/

Список всех серверов

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

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

Параметр	Тип	Необходимый	Описание
`status`	нить	Нет	Фильтрация по статусу сервера: активный, остановленный, приостановленный
`location`	нить	Нет	Фильтрация по местоположению центра обработки данных

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

cURL

Python

JavaScript

PHP

curl -X GET "https://admin.vps.org/api/v1/servers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

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

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

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

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

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

{
  "count": 2,
  "results": [
    {
      "id": 12345,
      "name": "web-server-01",
      "hostname": "web01.example.com",
      "status": "active",
      "ip_address": "203.0.113.10",
      "location": "us-west",
      "plan": {
        "id": 1,
        "name": "Standard VPS",
        "vcpus": 2,
        "memory": 4096,
        "storage": 80
      },
      "os": {
        "id": 5,
        "name": "Ubuntu 22.04 LTS"
      },
      "created_at": "2025-01-10T14:30:00Z",
      "updated_at": "2025-01-15T10:20:00Z"
    },
    {
      "id": 12346,
      "name": "db-server-01",
      "hostname": "db01.example.com",
      "status": "active",
      "ip_address": "203.0.113.11",
      "location": "us-east",
      "plan": {
        "id": 2,
        "name": "Performance VPS",
        "vcpus": 4,
        "memory": 8192,
        "storage": 160
      },
      "os": {
        "id": 3,
        "name": "Debian 12"
      },
      "created_at": "2025-01-12T09:15:00Z",
      "updated_at": "2025-01-16T08:45:00Z"
    }
  ]
}

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

200	Список серверов успешно получен.
401	Несанкционированный доступ — недействительный или отсутствующий токен API.

ПОЧТА /api/v1/servers/

Создать новый сервер

Разверните новый VPS-сервер с указанной конфигурацией.

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

Параметр	Тип	Необходимый	Описание
`name`	нить	Да	Имя сервера (буквенно-цифровое, допускаются дефисы)
`plan_id`	целое число	Да	Идентификатор тарифного плана VPS
`os_id`	целое число	Да	Идентификатор операционной системы
`location`	нить	Да	код местоположения дата-центра
`hostname`	нить	Нет	Имя хоста сервера (полное доменное имя)
`ssh_key_id`	целое число	Нет	Идентификатор SSH-ключа для установки
`backups_enabled`	логический	Нет	Включить автоматическое резервное копирование (по умолчанию: false)

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

cURL

Python

JavaScript

PHP

curl -X POST "https://admin.vps.org/api/v1/servers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "web-server-02",
    "plan_id": 1,
    "os_id": 5,
    "location": "us-west",
    "hostname": "web02.example.com",
    "backups_enabled": true
  }'

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "name": "web-server-02",
    "plan_id": 1,
    "os_id": 5,
    "location": "us-west",
    "hostname": "web02.example.com",
    "backups_enabled": True
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'web-server-02',
    plan_id: 1,
    os_id: 5,
    location: 'us-west',
    hostname: 'web02.example.com',
    backups_enabled: true
  })
});

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

$data = [
    'name' => 'web-server-02',
    'plan_id' => 1,
    'os_id' => 5,
    'location' => 'us-west',
    'hostname' => 'web02.example.com',
    'backups_enabled' => true
];

$ch = curl_init('https://admin.vps.org/api/v1/servers/');
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);
$server = json_decode($response, true);
curl_close($ch);

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

{
  "id": 12347,
  "name": "web-server-02",
  "hostname": "web02.example.com",
  "status": "provisioning",
  "ip_address": null,
  "location": "us-west",
  "plan": {
    "id": 1,
    "name": "Standard VPS",
    "vcpus": 2,
    "memory": 4096,
    "storage": 80
  },
  "os": {
    "id": 5,
    "name": "Ubuntu 22.04 LTS"
  },
  "backups_enabled": true,
  "created_at": "2025-01-16T15:30:00Z",
  "updated_at": "2025-01-16T15:30:00Z",
  "message": "Server is being provisioned. This may take 2-5 minutes."
}

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

201	Сервер успешно создан
400	Неверный запрос - Недопустимые параметры
401	Несанкционированный доступ — недействительный или отсутствующий токен API.
402	Требуется оплата - Недостаточно средств

ПОЛУЧАТЬ /api/v1/servers/{server_id}/

Получить данные сервера

Получить подробную информацию о конкретном сервере.

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

Параметр	Тип	Необходимый	Описание
`server_id`	целое число	Да	Уникальный идентификатор сервера

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

cURL

Python

JavaScript

curl -X GET "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

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

response = requests.get(url, headers=headers)
print(response.json())

const serverId = 12345;
const response = await fetch(`https://admin.vps.org/api/v1/servers/${serverId}/`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

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

{
  "id": 12345,
  "name": "web-server-01",
  "hostname": "web01.example.com",
  "status": "active",
  "ip_address": "203.0.113.10",
  "ipv6_address": "2001:0db8::1",
  "location": "us-west",
  "plan": {
    "id": 1,
    "name": "Standard VPS",
    "vcpus": 2,
    "memory": 4096,
    "storage": 80,
    "bandwidth": 2048
  },
  "os": {
    "id": 5,
    "name": "Ubuntu 22.04 LTS"
  },
  "backups_enabled": true,
  "resource_usage": {
    "cpu_percent": 23.5,
    "memory_used": 2048,
    "disk_used": 35,
    "bandwidth_used": 450
  },
  "created_at": "2025-01-10T14:30:00Z",
  "updated_at": "2025-01-16T15:45:00Z"
}

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

200	Данные сервера успешно получены.
401	Несанкционированный доступ — недействительный или отсутствующий токен API.
404	Сервер не найден.

ПОМЕЩАТЬ /api/v1/servers/{server_id}/

Обновление сервера

Обновите конфигурацию сервера. Все поля обязательны для заполнения.

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

Parameter	Type	Required	Description
`server_id`	integer	Yes	Уникальный идентификатор сервера

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

Параметр	Тип	Необходимый	Описание
`name`	нить	Да	Имя сервера
`hostname`	нить	Да	Имя хоста сервера (полное доменное имя)
`backups_enabled`	логический	Да	Включить/отключить автоматическое резервное копирование

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

cURL

Python

curl -X PUT "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "web-server-updated",
    "hostname": "web-updated.example.com",
    "backups_enabled": true
  }'

import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "name": "web-server-updated",
    "hostname": "web-updated.example.com",
    "backups_enabled": True
}

response = requests.put(url, headers=headers, json=data)
print(response.json())

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

200	Сервер успешно обновился.
400	Неверный запрос - Недопустимые параметры
404	Сервер не найден.

ПЛАСТЫРЬ /api/v1/servers/{server_id}/

Частичное обновление сервера

Обновите определенные поля сервера. Будут обновлены только указанные поля.

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

cURL

Python

curl -X PATCH "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "new-server-name"
  }'

import requests

server_id = 12345
url = f"https://admin.vps.org/api/v1/servers/{server_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {"name": "new-server-name"}

response = requests.patch(url, headers=headers, json=data)
print(response.json())

УДАЛИТЬ /api/v1/servers/{server_id}/

Удалить сервер

Безвозвратно удалить сервер. Это действие необратимо.

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

cURL

Python

curl -X DELETE "https://admin.vps.org/api/v1/servers/12345/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

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

response = requests.delete(url, headers=headers)
print(response.status_code)

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

204	Сервер успешно удален
404	Сервер не найден.

ПОЧТА /api/v1/servers/{server_id}/start/

Запуск сервера

Включение остановленного сервера.

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

cURL

Python

JavaScript

curl -X POST "https://admin.vps.org/api/v1/servers/12345/start/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

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

response = requests.post(url, headers=headers)
print(response.json())

const serverId = 12345;
const response = await fetch(`https://admin.vps.org/api/v1/servers/${serverId}/start/`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

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

{
  "status": "success",
  "message": "Server is starting",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "starting"
  }
}

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

200	Команда запуска сервера успешно отправлена.
400	Неверный запрос - сервер уже запущен.
404	Сервер не найден.

ПОЧТА /api/v1/servers/{server_id}/stop/

Остановить сервер

Корректное завершение работы работающего сервера.

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

cURL

Python

curl -X POST "https://admin.vps.org/api/v1/servers/12345/stop/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

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

response = requests.post(url, headers=headers)
print(response.json())

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

{
  "status": "success",
  "message": "Server is stopping",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "stopping"
  }
}

ПОЧТА /api/v1/servers/{server_id}/reboot/

Перезагрузка сервера

Корректный перезапуск работающего сервера.

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

cURL

Python

curl -X POST "https://admin.vps.org/api/v1/servers/12345/reboot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

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

response = requests.post(url, headers=headers)
print(response.json())

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

{
  "status": "success",
  "message": "Server is rebooting",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "rebooting"
  }
}

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

200	Команда перезагрузки сервера успешно отправлена.
400	Неверный запрос - Сервер не запущен
404	Сервер не найден.

VPS.org API

API серверов

Список всех серверов

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

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

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

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

Создать новый сервер

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

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

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

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

Получить данные сервера

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

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

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

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

Обновление сервера

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

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

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

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

Частичное обновление сервера

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

Удалить сервер

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

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

Запуск сервера

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

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

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

Остановить сервер

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

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

Перезагрузка сервера

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

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

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