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`	бутун сан	Бале	ID-и нақшаи VPS
`os_id`	бутун сан	Бале	ID-и системаи оператсионӣ
`location`	ришта	Бале	Рамзи ҷойгиршавии маркази додаҳо
`hostname`	ришта	Не	Номи сервери мизбон (FQDN)
`ssh_key_id`	бутун сан	Не	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`	бутун сан	Бале	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-и серверҳо

Рӯйхати ҳамаи серверҳо

Параметрҳои дархост

Намунаи дархост

Намунаи посух

Рамзҳои ҳолати посух

Сервери нав эҷод кунед

Дархости параметрҳои бадан

Намунаи дархост

Намунаи посух

Рамзҳои ҳолати посух

Маълумоти серверро гиред

Параметрҳои роҳ

Намунаи дархост

Намунаи посух

Рамзҳои ҳолати посух

Сервери навсозӣ

Параметрҳои роҳ

Дархости параметрҳои бадан

Намунаи дархост

Рамзҳои ҳолати посух

Серверро қисман навсозӣ кунед

Намунаи дархост

Серверро нест кунед

Намунаи дархост

Рамзҳои ҳолати посух

Серверро оғоз кунед

Намунаи дархост

Намунаи посух

Рамзҳои ҳолати посух

Серверро қатъ кунед

Намунаи дархост

Намунаи посух

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

Намунаи дархост

Намунаи посух

Рамзҳои ҳолати посух