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

అన్ని సర్వర్‌లను జాబితా చేయండి

ప్రశ్న పారామితులు

ఉదాహరణ అభ్యర్థన

ఉదాహరణ ప్రతిస్పందన

ప్రతిస్పందన స్థితి కోడ్‌లు

కొత్త సర్వర్‌ను సృష్టించండి

బాడీ పారామితులను అభ్యర్థించండి

ఉదాహరణ అభ్యర్థన

ఉదాహరణ ప్రతిస్పందన

ప్రతిస్పందన స్థితి కోడ్‌లు

సర్వర్ వివరాలను పొందండి

పాత్ పారామితులు

ఉదాహరణ అభ్యర్థన

ఉదాహరణ ప్రతిస్పందన

ప్రతిస్పందన స్థితి కోడ్‌లు

సర్వర్‌ను నవీకరించు

పాత్ పారామితులు

బాడీ పారామితులను అభ్యర్థించండి

ఉదాహరణ అభ్యర్థన

ప్రతిస్పందన స్థితి కోడ్‌లు

సర్వర్‌ను పాక్షికంగా నవీకరించు

ఉదాహరణ అభ్యర్థన

సర్వర్‌ను తొలగించు

ఉదాహరణ అభ్యర్థన

ప్రతిస్పందన స్థితి కోడ్‌లు

సర్వర్‌ను ప్రారంభించండి

ఉదాహరణ అభ్యర్థన

ఉదాహరణ ప్రతిస్పందన

ప్రతిస్పందన స్థితి కోడ్‌లు

సర్వర్ ఆపు

ఉదాహరణ అభ్యర్థన

ఉదాహరణ ప్రతిస్పందన

సర్వర్‌ను రీబూట్ చేయండి

ఉదాహరణ అభ్యర్థన

ఉదాహరణ ప్రతిస్పందన

ప్రతిస్పందన స్థితి కోడ్‌లు