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`	радок	Не	Імя хаста сервера (FQDN)
`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`	радок	Так	Імя хаста сервера (FQDN)
`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 сервераў

Спіс усіх сервераў

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

Прыклад запыту

Прыклад адказу

Коды стану адказу

Стварыць новы сервер

Запытаць параметры цела

Прыклад запыту

Прыклад адказу

Коды стану адказу

Атрымаць падрабязную інфармацыю пра сервер

Параметры шляху

Прыклад запыту

Прыклад адказу

Коды стану адказу

Сервер абнаўленняў

Параметры шляху

Запытаць параметры цела

Прыклад запыту

Коды стану адказу

Частковае абнаўленне сервера

Прыклад запыту

Выдаліць сервер

Прыклад запыту

Коды стану адказу

Запусціць сервер

Прыклад запыту

Прыклад адказу

Коды стану адказу

Спыніць сервер

Прыклад запыту

Прыклад адказу

Перазагрузіць сервер

Прыклад запыту

Прыклад адказу

Коды стану адказу