VPS.org API

REST API ஆவணமாக்கல்

சேவையகங்கள் API

உருவாக்கு, பரிசோதிக்க, சக்தி, அளவு மாற்று மற்றும் நீக்கு உங்கள் VPS சேவையகங்களை. சேவையகங்கள் uuid மூலம் அடையாளம் காணப்படுகின்றன.

முனைப்புள்ளிகள் 15
அடிப்படை பாதை /api/v1/servers
பெறு /api/v1/servers/

அனைத்து சேவையகங்களையும் பட்டியலிடுங்கள்

உங்கள் கணக்கில் உள்ள சேவையகங்களை திரும்பத் தரும், புதியது முதலில், பக்கத்திற்கு 25. சேவையகங்கள் நீக்கப்படுகின்றன.

அனுமதி தேவை: servers:list

வினவல் அளவுருக்கள்

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
page integer இல்லை பக்க எண், 1ல் தொடங்குகிறது
page_size integer இல்லை ஒவ்வொரு பக்கத்திற்கும் முடிவுகள் (முன்னிருப்பு 25, அதிகபட்சம் 100)

மாதிரி கோரிக்கை

cURL
Python
JavaScript
PHP
curl -X GET "https://admin.vps.org/api/v1/servers/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for server in response.json()["results"]:
    print(server["uuid"], server["hostname"], server["status"])
const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);
$ch = curl_init('https://admin.vps.org/api/v1/servers/');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_API_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);

foreach ($data['results'] as $server) {
    echo $server['hostname'] . ' ' . $server['status'] . "\n";
}

எடுத்துக்காட்டு பதில்

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b",
      "hostname": "web-01",
      "status": "on",
      "error_description": null,
      "location_name": "New Jersey",
      "plan_name": "1 vCPU / 2 GB RAM / 10 GB",
      "os_name": "Ubuntu",
      "ipv4_addresses": ["203.0.113.10"],
      "ipv6_addresses": ["2001:db8:2:dd::f9:6b"],
      "created_at": "2026-07-30T03:54:14.914364Z",
      "deployed": true
    },
    {
      "uuid": "2d7e9b40-6c1a-4f3e-8b5d-9a0c1e2f3b4d",
      "hostname": "db-01",
      "status": "queue",
      "error_description": null,
      "location_name": "New Jersey",
      "os_name": "Debian",
      "ipv4_addresses": [],
      "ipv6_addresses": [],
      "created_at": "2026-09-14T19:33:49.426508Z",
      "deployed": false
    }
  ]
}

பதில் புலங்கள்

புலங்கள் வகை & விவரக்குறிப்புகள்
uuid string மற்ற சேவையக முடிவு புள்ளிகளில் பயன்படுத்தப்படும் சேவையக அடையாளம்
hostname string சேவையகத்தை உருவாக்கும்போது நீங்கள் தேர்ந்தெடுத்த புரவலன் பெயர்
status string தற்போதைய நிலை. சேவையக நிலை மதிப்புகளை கீழே பார்க்கவும்.
error_description string | null பிழையான நிலை இருந்தால் கடைசி தோல்வி விவரங்கள், இல்லையென்றால் நூல்
location_name string சேவையகம் இயங்கும் இடத்தின் பெயர்
os_name string இயக்க முறைமை பெயர், பதிப்பு இல்லாமல்
plan_name string படித்தல் திட்ட சுருக்கம், உ. த. 1 vCPU /2GB RAM / 10 GB
ipv4_addresses array IPv4 முகவரிகள் சரங்களாக. சேவையகம் செயல்படுத்தப்படும் வரை காலியாக இருக்கும், IPv4 இல்லாத திட்டங்களில்.
ipv6_addresses array IPv6 முகவரிகள் சரங்களாக. சேவையகம் செயல்படுத்தப்படும் வரை காலியாக இருக்கும்.
created_at datetime உருவாக்கும் நேரம் (ISO 8601, UTC)
deployed boolean நிர்ணயிக்குதல் முடிந்தவுடன் உண்மை

பதில் நிலை குறியீடுகள்

200 சேவையகப் பட்டியல் வெற்றிகரமாக மீட்டெடுக்கப்பட்டது.
403 காணாமல் போன அல்லது செல்லாத API டாக், அல்லது டாக் தேவையான அனுமதியைக் கொண்டிருக்கவில்லை
அஞ்சல் /api/v1/servers/

புதிய சேவையகத்தை உருவாக்கு

புதிய சேவையகத்தை நிறுவ வரிசையில் நிறுத்துகிறது மற்றும் உடனடியாக நிலை வரிசைகளுடன் திரும்பும். பின்னணியில் வழங்குதல் தொடரும்: நிறுவப்பட்ட நிலை முடிவு புள்ளி உண்மையான வரை நிலையை கேட்கவும். சேவையகம் தயாராக இருக்கும் போது, அதன் நுழைவு விவரங்கள் கணக்கு உரிமையாளர்களுக்கு மின்னஞ்சல் மூலம் அனுப்பப்படும்.

உங்கள் கணக்கிற்கு சேமிக்கப்பட்ட செலுத்தும் முறை தேவை. உங்கள் கணக்கின் வரலாற்றை பொறுத்து, சேவையகம் உருவாக்கப்படுவதற்கு முன், உங்கள் அட்டையில் ஒரு வாரத்திற்கு ஒரு திட்ட விலை (கொஞ்சம் கூடுதலாக 1 USD) தற்காலிக முன்- அனுமதி நிறுத்தம் வைக்கப்படலாம்.

அனுமதி தேவை: servers:create

கோரிக்கை உடல் அளவுருக்கள்

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
hostname string ஆம் குறைந்தது3எழுத்துக்கள். எழுத்துக்கள், எண்ணுகள், டைஃப்ன்கள் மற்றும் புள்ளிகள் மட்டுமே.
location_id integer ஆம் இடங்கள் API யிலிருந்து ஒரு செயலில் உள்ள இடத்தின் அடையாள எண்
plan_uuid string ஆம் திட்டம் API யிலிருந்து ஒரு செயல்படும் திட்டத்தின் uuid
operating_system_version_uuid string ஆம் இயக்க முறைமையின் பதிப்பு பட்டியலில் ஒரு செயலில் உள்ள நுழைவின் uuid
ssh_key_uuids array இல்லை சேவையகத்தில் நிறுவ வேண்டிய SSH விசை API யிலிருந்து SSH விசைகளின் UUID கள்
ssh_key_ids array இல்லை SSH விசையின் முழு எண் அடையாளம், ssh_key_uuids க்கு மாற்றாக. இரண்டும் அனுப்பப்பட்டால், ssh_key_ids பயன்படுத்தப்படும்.
ssh_key_uuid, ssh_key_id string, integer இல்லை ஒற்றை SSH விசைக்கான குறுக்குவழி
auth_method string இல்லை கடவுச்சொல், ssh_key அல்லது இரண்டும். முன்னிருப்பு கடவுச்சொல் அல்லது இரண்டும் SSH விசைகள் வழங்கப்பட்டால்.

மாதிரி கோரிக்கை

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 '{
    "hostname": "web-01",
    "location_id": 1,
    "plan_uuid": "3bc2faf6-8f8b-4978-b62d-b52ed3f858e9",
    "operating_system_version_uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
    "ssh_key_uuids": ["YOUR_SSH_KEY_UUID"]
  }'
import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
data = {
    "hostname": "web-01",
    "location_id": 1,
    "plan_uuid": "3bc2faf6-8f8b-4978-b62d-b52ed3f858e9",
    "operating_system_version_uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
    "ssh_key_uuids": ["YOUR_SSH_KEY_UUID"],
}

response = requests.post(url, headers=headers, json=data)
server = response.json()
print(response.status_code, server["uuid"], server["status"])
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({
    hostname: 'web-01',
    location_id: 1,
    plan_uuid: '3bc2faf6-8f8b-4978-b62d-b52ed3f858e9',
    operating_system_version_uuid: 'c3418f90-80a0-4e00-a7e1-d0ab1822b941',
    ssh_key_uuids: ['YOUR_SSH_KEY_UUID']
  })
});

const server = await response.json();
console.log(server.uuid, server.status);
$data = [
    'hostname' => 'web-01',
    'location_id' => 1,
    'plan_uuid' => '3bc2faf6-8f8b-4978-b62d-b52ed3f858e9',
    'operating_system_version_uuid' => 'c3418f90-80a0-4e00-a7e1-d0ab1822b941',
    'ssh_key_uuids' => ['YOUR_SSH_KEY_UUID']
];

$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);

$server = json_decode(curl_exec($ch), true);
curl_close($ch);

எடுத்துக்காட்டு பதில்

201 சேவையக விவரங்களை பெறு என்ற பகுதியில் குறிப்பிடப்பட்டுள்ள முழு சேவையக பொருளுடன் உருவாக்கப்பட்டது. முகவரிகள் மற்றும் vmid கள் ஒருமுறை விநியோகம் முடிந்தவுடன் நிரப்பப்படும்.

{
  "uuid": "5f0c8e2a-6b1d-4c3e-9a7f-2d4b6c8e0a1f",
  "hostname": "web-01",
  "vmid": null,
  "status": "queue",
  "error_description": null,
  "location": {
    "id": 1,
    "name": "New Jersey",
    "country_name": "United States",
    "is_active": true
  },
  "plan": {
    "uuid": "3bc2faf6-8f8b-4978-b62d-b52ed3f858e9",
    "cpu": 1,
    "ram": 2,
    "ram_unit": "GB",
    "disk_space": 10,
    "disk_space_total": 10240,
    "transfer": 500,
    "price": "3.50",
    "cpu_type_name": "Shared",
    "is_active": true,
    "hourly_price": "0.005",
    "monthly_price": "3.50",
    "is_gpu": false,
    "gpu_count": 0,
    "gpu_model": ""
  },
  "operating_system": {
    "id": 1,
    "name": "Ubuntu",
    "svg_icon": "<svg ...>",
    "versions": [ ... ]
  },
  "operating_system_version": {
    "uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
    "name": "24.04 LTS x64",
    "os_name": "Ubuntu",
    "os_svg_icon": "<svg ...>",
    "is_active": true
  },
  "ipv4_addresses": [],
  "ipv6_addresses": [],
  "deployed": false,
  "created_at": "2026-09-14T21:02:11.402113Z",
  "recent_actions": []
}

பதில் நிலை குறியீடுகள்

201 சேவையகம் உருவாக்கப்பட்டு விநியோகத்திற்காக வரிசையில் வைக்கப்பட்டது
400 சரிபார்ப்பு பிழை, உதாரணமாக செயல்படாத இடம், திட்டம் அல்லது இயக்க முறைமை பதிப்பு
402 கோப்பில் எந்த செலுத்தும் முறையும் இல்லை, செலுத்தாத விலைப்பத்திரங்கள் அல்லது அட்டை முன் அனுமதி மறுக்கப்பட்டது
403 காணாமல் போன அல்லது செல்லாத API டாக், அல்லது டாக் தேவையான அனுமதியைக் கொண்டிருக்கவில்லை
429 உங்கள் கணக்கு சேவையக உருவாக்க வரம்புகளை அடைந்தது
பெறு /api/v1/servers/{uuid}/

சேவையக விவரங்களைப் பெறுங்கள்

ஒரு சேவையகத்தை அதன் இடம், திட்டம், இயக்க முறைமை, IP முகவரி மற்றும் ஐந்து சமீபத்திய செயல்களுடன் திரும்பும்.

அனுமதி தேவை: servers:list

curl -X GET "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

எடுத்துக்காட்டு பதில்

{
  "uuid": "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b",
  "hostname": "web-01",
  "vmid": 1042,
  "status": "on",
  "error_description": null,
  "location": {
    "id": 1,
    "name": "New Jersey",
    "country_name": "United States",
    "is_active": true
  },
  "plan": {
    "uuid": "14186969-fbaf-43e1-9ab2-b1f1aeb66674",
    "cpu": 1,
    "ram": 2,
    "ram_unit": "GB",
    "disk_space": 25,
    "disk_space_total": 25600,
    "transfer": 1,
    "price": "5.00",
    "cpu_type_name": "Shared",
    "is_active": true,
    "hourly_price": "0.007",
    "monthly_price": "5.00",
    "is_gpu": false,
    "gpu_count": 0,
    "gpu_model": ""
  },
  "operating_system": {
    "id": 1,
    "name": "Ubuntu",
    "svg_icon": "<svg ...>",
    "versions": [ ... ]
  },
  "operating_system_version": {
    "uuid": "c3418f90-80a0-4e00-a7e1-d0ab1822b941",
    "name": "24.04 LTS x64",
    "os_name": "Ubuntu",
    "os_svg_icon": "<svg ...>",
    "is_active": true
  },
  "ipv4_addresses": [
    {
      "ip": "203.0.113.10",
      "gateway": "203.0.113.1",
      "subnet": "203.0.113.0",
      "rdns": "web-01.example.com"
    }
  ],
  "ipv6_addresses": [
    {
      "ip": "2001:db8:2:dd::f9:6b",
      "gateway": "2001:db8:2:dd::f9:1",
      "subnet": "2001:db8:2:dd::f9:0",
      "rdns": "web-01.example.com"
    }
  ],
  "deployed": true,
  "created_at": "2026-07-30T03:54:14.914364Z",
  "recent_actions": [
    {
      "id": 17028,
      "action": "create",
      "action_display": "Create",
      "description": "Server deployed with VMID 1042",
      "user_email": "you@example.com",
      "created_at": "2026-07-30T03:54:32.860854Z"
    }
  ]
}

SVG சின்னம் குறி மற்றும் பதிப்பு பட்டியல் இங்கே குறுக்கிடப்பட்டுள்ளது.

பதில் புலங்கள்

புலங்கள் வகை & விவரக்குறிப்புகள்
vmid integer | null மெய்நிகர் இயந்திர எண், அமைக்கும்போது அமைக்கப்படுகிறது
location object இடம் பொருள், இடங்கள் API திரும்பியது
plan object திட்டம் பொருள், திட்டம் API திரும்பியது
operating_system, operating_system_version object இயக்க முறைமை மற்றும் நிறுவப்பட்ட பதிப்பு, இயக்க முறைமை API திரும்பியது போல்
ipv4_addresses, ipv6_addresses array IP, நுழைவாயில், துணைப்பிணைய மற்றும் rdns (திசைமாற்ற DNS கணினி பெயர்) உடன் ஒவ்வொரு முகவரிக்கும் ஒரு பொருள்
recent_actions array ஐந்து வரையான சமீபத்திய செயல்கள்: id, action, action_ display, description, user_ email, created_ at

பதில் நிலை குறியீடுகள்

200 சேவையக விவரங்கள் வெற்றிகரமாக மீட்டெடுக்கப்பட்டன.
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது
பெறு /api/v1/servers/{uuid}/status/

சேவையக நிலையை பெறு

நீங்கள் சேவையகத்தை உருவாக்கிய பின், இயக்கிய பின் அல்லது மாற்றிய பின், ஒரு இலகுவான குரல் கேட்கப்படுகிறது.

curl -X GET "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/status/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "status": "on",
  "deployed": true,
  "resizing": false
}

சேவையக நிலை மதிப்புகள்

மதிப்பு & விவரக்குறிப்புகள்
queue An action (deploy, power, resize, restore) is queued or in progress
deploying வழங்கப்படுகிறது. கட்டுப்பாட்டு பலகத்தின் மூலம் உருவாக்கப்பட்ட சேவையகங்கள் இந்த நிலையை பயன்படுத்துகின்றன; API மூலம் உருவாக்கப்பட்ட சேவையகங்கள் தயார் செய்யும் வரை வரிசையில் இருக்கும்.
on இயக்கு
off மின்சாரம் துண்டிக்கப்பட்டது
error கடைசி செயல் தோல்வியடைந்தது. error_ description பார்க்கவும்.
suspended_payment செலுத்தப்படாத விண்ணப்பங்கள் காரணமாக நிறுத்தப்பட்டது
அஞ்சல் /api/v1/servers/{uuid}/power/

சேவையகத்தின் மின்சாரத்தை கட்டுப்படுத்து

ஒரு மின் செயல் வரிசைப்படுத்துகிறது. செயல் முடிக்கும் வரை சேவையக நிலை வரிசைப்படுத்தப்படுகிறது.

அனுமதி தேவை: servers:power

கோரிக்கை உடல் அளவுருக்கள்

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
action string ஆம் start: மின்சாரம்
shutdown: அழகான நிறுத்தம், விருந்தாளி நிறுத்தவில்லை என்றால் கட்டாயப்படுத்தி நிறுத்தப்படும்
restart: கடுமையான மின்சுழற்சி (நிறுத்தவும், பின்னர் துவக்கவும்)
stop: தற்போது மறுநிறுவல் போன்ற அதே மின் சுழற்சியை செயல்படுத்துகிறது. சேவையகத்தை நிறுத்த பயன்படுத்து.

மாதிரி கோரிக்கை

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/power/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "restart"}'
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/power/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers, json={"action": "restart"})
print(response.json())

எடுத்துக்காட்டு பதில்

{
  "message": "Server restart queued"
}

பதில் நிலை குறியீடுகள்

200 செயல் வரிசைப்படுத்தப்பட்டது
400 காணாத அல்லது ஆதரவில்லா செயல்
402 கணக்கில் செலுத்தப்படாத கட்டணங்கள் இருப்பதால் துவக்க மறுக்கப்பட்டது
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது
அஞ்சல் /api/v1/servers/{uuid}/resize/

சேவையகத்தின் அளவை மாற்று

சேவையகத்தை மற்ற ஒரு செயலில் உள்ள திட்டத்திற்கு நகர்த்தும். புதிய திட்டம் தற்போதையதை விட குறைவான வட்டு இடத்தைக் கொண்டிருக்க முடியாது, மற்றும் கோரிக்கை உடல் அளவை மாற்ற செயல் அமைப்புகளை உள்ளடக்க வேண்டும். புதிய திட்டத்திற்கான ஹைபர்விசார் திறன் ஏதாவது வரிசைப்படுத்துவதற்கு முன் சரிபார்க்கப்படுகிறது, எனவே மறுக்கப்படும் கோரிக்கை சேவையகத்தை மாற்றப்படாமல் விட்டுவிடும்.

சேவையகம் நிறுத்தப்படும் போது அது அளவு மாற்றப்படும் மற்றும் அதன் பிறகு மீண்டும் தொடங்கப்படும். அளவு மாற்றம் தோல்வியடைந்தால், சேவையகம் அதன் முந்தைய திட்டத்தில் மீண்டும் வைக்கப்படும் மற்றும் அது இயங்கினால் மீண்டும் தொடங்கப்படும். வட்டு வளர்ச்சியை திரும்ப பெற முடியாது.

அனுமதி தேவை: servers:resize

கோரிக்கை உடல் அளவுருக்கள்

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
action string ஆம் மறு அளவிடப்பட வேண்டும்
new_plan_uuid string ஆம் நகர்த்த வேண்டிய திட்டத்தின் uuid
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/resize/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "resize", "new_plan_uuid": "5e26a4a6-bd0c-467c-abca-da036c811c3f"}'
{
  "message": "Resize queued successfully"
}

மறுக்கப்பட்ட மறு அளவுக்கான உதாரணம் (409):

{
  "error": "Not enough hypervisor capacity for the selected plan; the server was not changed"
}

பதில் நிலை குறியீடுகள்

200 செயல் வரிசைப்படுத்தப்பட்டது
400 காணாத செயல் அல்லது new_plan_uuid, செல்லாத அல்லது செயல்படாத திட்டம், குறைந்த வட்டு இடம் கொண்ட திட்டம், அல்லது GPU திட்டம் (GPU திட்டங்களை API மூலம் அளவு மாற்ற இயலாது)
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது
409 ஒரு அளவு மாற்றம் அல்லது சேமிப்பு மாற்றம் ஏற்கனவே நடைபெற்று வருகிறது, அல்லது புதிய திட்டத்திற்கு தேவையான ஹைபர்விசார் திறன் இல்லை
503 திறன் இப்போது சரிபார்க்க முடியவில்லை. சேவையகம் மாற்றப்படவில்லை; பின்னர் மீண்டும் முயற்சி செய்யவும்.
அஞ்சல் /api/v1/servers/{uuid}/reset-password/

ரூட் கடவுச்சொல்லை மீளமை

புதிய root கடவுச்சொல்லை உருவாக்குகிறது, பதில்களில் திரும்பும் மற்றும் சேவையகத்தில் மாற்றத்தை வரிசைப்படுத்துகிறது. புதிய கடவுச்சொல்லை உங்களுக்கு மின்னஞ்சலிலும் அனுப்பப்படும். சேவையகம் நிறுவப்பட வேண்டும். கோரிக்கை உடல் தேவையில்லை.

curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/reset-password/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Password reset queued. New password will also be emailed to you.",
  "password": "generated-password",
  "job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}

பதில் நிலை குறியீடுகள்

200 செயல் வரிசைப்படுத்தப்பட்டது
400 சேவையகம் இன்னும் செயல்படுத்தப்படவில்லை
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது
பெறு அஞ்சல் /api/v1/servers/{uuid}/rdns/

எதிர் DNS (PTR)

GET சேவையகத்தில் உள்ள ஒவ்வொரு IPv4 மற்றும் IPv6 முகவரிக்கும் எதிர் DNS கணினிப் பெயரை பட்டியலிடுகிறது. POST ஒரு முகவரிக்கு அமைக்கிறது. வெற்று கணினிப் பெயரை அனுப்புவது முகவரியை அதன் முன்னிருப்பு எதிர் DNS பெயரிற்கு மாற்றுகிறது.

அனுமதி தேவை: servers:update

கோரிக்கை உடல் அளவுருக்கள் (POST)

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
ip string ஆம் இந்த சேவையகத்திற்கு வழங்கப்பட்ட IPv4 அல்லது IPv6 முகவரி
hostname string இல்லை PTR கணினி பெயர். முன்னிருப்பு நிலைக்கு மாற்றுவதற்கு காலி செய்யவும்.
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/rdns/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ip": "203.0.113.10", "hostname": "mail.example.com"}'
{
  "message": "Reverse DNS for 203.0.113.10 set to mail.example.com",
  "ip": "203.0.113.10",
  "hostname": "mail.example.com"
}

GET பதில்:

{
  "rdns": [
    {"ip": "203.0.113.10", "hostname": "mail.example.com"},
    {"ip": "2001:db8:2:dd::f9:6b", "hostname": "mail.example.com"}
  ]
}

பதில் நிலை குறியீடுகள்

400 IP காணவில்லை, அல்லது கணினிப் பெயர் அமைக்க முடியவில்லை
404 IP முகவரி இந்த சேவையகத்திற்கு ஒதுக்கப்படவில்லை
அஞ்சல் /api/v1/servers/{uuid}/exec/

சேவையகத்தில் கட்டளையை இயக்கு

QEMU விருந்தினர் செயலி மூலம் சேவையகத்தில் உள்ள ஓடு கட்டளைகளை இயக்குகிறது மற்றும் முடிவிற்கு காத்திருக்கிறது. சேவையகம் செயல்பட வேண்டும் மற்றும் செயல்பட வேண்டும், qemu- guest- agent நிறுவப்பட்டு விருந்தினருடன் செயல்பட வேண்டும்.

அனுமதி தேவை: servers:exec

கோரிக்கை உடல் அளவுருக்கள்

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
command string ஆம் கட்டளை வரி /bin/sh -c உடன் இயங்கும், 2000 எழுத்துக்கள் வரை
timeout integer இல்லை கட்டளையை எதிர்பார்க்க வேண்டிய நொடிகள், 1 முதல் 300 வரை (முன்னிருப்பு 30)
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/exec/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"command": "uptime", "timeout": 30}'
{
  "stdout": " 21:14:03 up 46 days,  2:10,  0 users,  load average: 0.08, 0.03, 0.01\n",
  "stderr": "",
  "exit_code": 0,
  "timed_out": false
}

நேரம் முடிந்த பிறகு கட்டளை இன்னும் இயங்கினால், பதில் timed_out உண்மை எனவும் exit_code நூல் எனவும் அமைக்கப்படும்.

பதில் நிலை குறியீடுகள்

200 கட்டளை முடிந்தது அல்லது நேரம் முடிந்தது
400 சேவையகம் செயல்படவில்லை அல்லது செயல்படவில்லை அல்லது செல்லாத அளவுருக்கள்
409 QEMU விருந்தினர் செயலி சேவையகத்தில் இயங்கவில்லை
503 தற்காலிக இணைப்பு பிரச்சனை. Retry- After தலைப்புக்கு பிறகு மீண்டும் முயற்சி செய்.
நீக்கு /api/v1/servers/{uuid}/

சேவையகத்தை நீக்கு

சேவையகத்தை நிரந்தரமாக நீக்க வரிசையில் வைக்கிறது. சேவையகம் பட்டியலிலிருந்து உடனடியாக மறைந்துவிடும் மற்றும் மீட்டெடுக்க முடியாது.

அனுமதி தேவை: servers:delete

curl -X DELETE "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Server deletion queued"
}

பதில் நிலை குறியீடுகள்

202 ஏற்றுக்கொள்ளப்பட்டது: கோரிக்கை வரிசையில் வைக்கப்பட்டது
404 காணவில்லை, அல்லது இது வேறு கணக்கிற்கு சொந்தமானது
பெறு அஞ்சல் /api/v1/ssh-keys/

SSH விசைகள்

பொது SSH விசைகளை உங்கள் கணக்கில் சேமிக்கவும், பின்னர் சேவையகத்தை உருவாக்கும்போது ssh_key_uuids ஆக அவற்றின் uuids களை அனுப்பவும். GET உங்கள் விசைகளை பட்டியலிடுகிறது (பக்கத்திற்கு 25); POST ஒன்று சேர்க்கிறது.

அனுமதி தேவை: ssh-keys:list (GET), ssh-keys:create (POST)

கோரிக்கை உடல் அளவுருக்கள் (POST)

அளபுரு வகை அவசியம் & விவரக்குறிப்புகள்
name string ஆம் விசை அறிய ஒரு பெயர், 100 எழுத்துக்கள் வரை
public_key string ஆம் திறந்த SSH வடிவமைப்பில் பொது விசையை, உதாரணமாக id_ed25519.pub இன் உள்ளடக்கத்தை

மாதிரி கோரிக்கை

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/ssh-keys/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "laptop", "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI... you@laptop"}'
import requests

url = "https://admin.vps.org/api/v1/ssh-keys/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

with open("/home/you/.ssh/id_ed25519.pub") as f:
    data = {"name": "laptop", "public_key": f.read().strip()}

response = requests.post(url, headers=headers, json=data)
print(response.status_code, response.json()["uuid"])

எடுத்துக்காட்டு பதில்

{
  "id": 19,
  "uuid": "6e1b9c52-3f8a-4d7e-a2c4-5b9d0e1f2a3c",
  "name": "laptop",
  "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI... you@laptop",
  "fingerprint": "0b:4c:9b:48:76:e7:1d:07:b9:ac:71:90:70:f7:9a:69",
  "created_at": "2026-08-23T19:16:11.547183Z",
  "last_used_at": null
}

பதில் புலங்கள்

புலங்கள் வகை & விவரக்குறிப்புகள்
id, uuid integer, string விசை அடையாளங்கள். ssh_key_uuids மற்றும் கீழ்வரும் URL-ல் uuid பயன்படுத்தவும்; id ssh_key_ids-ல் வேலை செய்கிறது.
fingerprint string விசை MD5 கைரேகை, தளத்தால் கணக்கிடப்பட்டது
last_used_at datetime | null புதிய சேவையகத்தில் விசை கடைசியாக நிறுவப்பட்டது எப்போது

பதில் நிலை குறியீடுகள்

201 விசை சேர்க்கப்பட்டது
400 பெயர் காணவில்லை, அல்லது பொது விசையை சரியான SSH பொது விசையாக இல்லை
பெறு நீக்கு /api/v1/ssh-keys/{uuid}/

SSH விசை பெறுக அல்லது நீக்கு

GET ஒரு விசையை மேலே உள்ள புலங்களுடன் திரும்பத் தரும். DELETE உங்கள் கணக்கிலிருந்து அதை நீக்கும் மற்றும் உடல் இல்லாத 204 ஐ திரும்பத் தரும். ஒரு விசையை நீக்குதல் ஏற்கனவே நிறுவப்பட்ட சேவையகங்களில் இருந்து அதை நீக்காது. விசைகளை திருத்த முடியாது: நீக்கவும் மீண்டும் சேர்க்கவும்.

அனுமதி தேவை: ssh-keys:list (GET), ssh-keys:delete (DELETE)

curl -X DELETE "https://admin.vps.org/api/v1/ssh-keys/6e1b9c52-3f8a-4d7e-a2c4-5b9d0e1f2a3c/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

காப்புக்கோப்புகள் மற்றும் காட்சிகள்

காப்பு அல்லது காட்சியை உருவாக்குவது சேவையக செயல்: