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 төлөвлөгөөний ID
`os_id`	бүхэл тоо	Тийм	Үйлдлийн системийн 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`	бүхэл тоо	Тийм	Өвөрмөц серверийн 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	Өвөрмөц серверийн ID

Хүсэлтийн биеийн параметрүүд

Параметр	Төрөл	Шаардлагатай	Тайлбар
`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

Бүх серверүүдийг жагсаах

Асуулгын параметрүүд

Жишээ хүсэлт

Жишээ хариулт

Хариу үйлдлийн төлөвийн кодууд

Шинэ сервер үүсгэх

Хүсэлтийн биеийн параметрүүд

Жишээ хүсэлт

Жишээ хариулт

Хариу үйлдлийн төлөвийн кодууд

Серверийн дэлгэрэнгүй мэдээллийг авах

Замын параметрүүд

Жишээ хүсэлт

Жишээ хариулт

Хариу үйлдлийн төлөвийн кодууд

Серверийг шинэчлэх

Замын параметрүүд

Хүсэлтийн биеийн параметрүүд

Жишээ хүсэлт

Хариу үйлдлийн төлөвийн кодууд

Серверийг хэсэгчлэн шинэчлэх

Жишээ хүсэлт

Серверийг устгах

Жишээ хүсэлт

Хариу үйлдлийн төлөвийн кодууд

Серверийг эхлүүлэх

Жишээ хүсэлт

Жишээ хариулт

Хариу үйлдлийн төлөвийн кодууд

Серверийг зогсоох

Жишээ хүсэлт

Жишээ хариулт

Серверийг дахин ачаалах

Жишээ хүсэлт

Жишээ хариулт

Хариу үйлдлийн төлөвийн кодууд