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

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

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

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

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

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

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

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

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

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

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

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

பாதை அளவுருக்கள்

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

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

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

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

பாதை அளவுருக்கள்

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

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

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

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

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

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

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

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

சேவையகத்தைத் தொடங்கு

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

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

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

சேவையகத்தை நிறுத்து

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

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

சேவையகத்தை மீண்டும் துவக்கவும்

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

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

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