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 на сървъри

Списък на всички сървъри

Параметри на заявката

Примерна заявка

Примерен отговор

Кодове за състояние на отговора

Създаване на нов сървър

Заявка за параметри на тялото

Примерна заявка

Примерен отговор

Кодове за състояние на отговора

Получете подробности за сървъра

Параметри на пътя

Примерна заявка

Примерен отговор

Кодове за състояние на отговора

Сървър за актуализиране

Параметри на пътя

Заявка за параметри на тялото

Примерна заявка

Кодове за състояние на отговора

Частично актуализиране на сървъра

Примерна заявка

Изтриване на сървър

Примерна заявка

Кодове за състояние на отговора

Стартиране на сървъра

Примерна заявка

Примерен отговор

Кодове за състояние на отговора

Спрете сървъра

Примерна заявка

Примерен отговор

Рестартиране на сървъра

Примерна заявка

Примерен отговор

Кодове за състояние на отговора