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 ID кључа за инсталацију
`backups_enabled`	логичка вредност	Не	Омогући аутоматске резервне копије (подразумевано: нетачно)

Пример захтева

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 сервера

Листа свих сервера

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

Пример захтева

Пример одговора

Кодови статуса одговора

Креирај нови сервер

Захтевајте параметре тела

Пример захтева

Пример одговора

Кодови статуса одговора

Преузмите детаље сервера

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

Пример захтева

Пример одговора

Кодови статуса одговора

Сервер за ажурирање

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

Захтевајте параметре тела

Пример захтева

Кодови статуса одговора

Делимично ажурирање сервера

Пример захтева

Обриши сервер

Пример захтева

Кодови статуса одговора

Покрени сервер

Пример захтева

Пример одговора

Кодови статуса одговора

Заустави сервер

Пример захтева

Пример одговора

Поново покрени сервер

Пример захтева

Пример одговора

Кодови статуса одговора