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`	булова вредност	Не	Овозможи автоматски резервни копии (стандардно: неточно)

Пример за барање

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

Листај ги сите сервери

Параметри на барањето

Пример за барање

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

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

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

Параметри на телото на барањето

Пример за барање

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

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

Добијте детали за серверот

Параметри на патеката

Пример за барање

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

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

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

Параметри на патеката

Параметри на телото на барањето

Пример за барање

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

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

Пример за барање

Избриши сервер

Пример за барање

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

Стартувај сервер

Пример за барање

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

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

Стоп сервер

Пример за барање

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

Рестартирај го серверот

Пример за барање

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

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