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

બધા સર્વરોની યાદી બનાવો

ક્વેરી પરિમાણો

ઉદાહરણ વિનંતી

ઉદાહરણ પ્રતિભાવ

પ્રતિભાવ સ્થિતિ કોડ્સ

નવું સર્વર બનાવો

બોડી પેરામીટર્સની વિનંતી કરો

ઉદાહરણ વિનંતી

ઉદાહરણ પ્રતિભાવ

પ્રતિભાવ સ્થિતિ કોડ્સ

સર્વર વિગતો મેળવો

પાથ પરિમાણો

ઉદાહરણ વિનંતી

ઉદાહરણ પ્રતિભાવ

પ્રતિભાવ સ્થિતિ કોડ્સ

સર્વર અપડેટ કરો

પાથ પરિમાણો

બોડી પેરામીટર્સની વિનંતી કરો

ઉદાહરણ વિનંતી

પ્રતિભાવ સ્થિતિ કોડ્સ

સર્વરને આંશિક રીતે અપડેટ કરો

ઉદાહરણ વિનંતી

સર્વર કાઢી નાખો

ઉદાહરણ વિનંતી

પ્રતિભાવ સ્થિતિ કોડ્સ

સર્વર શરૂ કરો

ઉદાહરણ વિનંતી

ઉદાહરણ પ્રતિભાવ

પ્રતિભાવ સ્થિતિ કોડ્સ

સર્વર રોકો

ઉદાહરણ વિનંતી

ઉદાહરણ પ્રતિભાવ

સર્વર રીબુટ કરો

ઉદાહરણ વિનંતી

ઉદાહરણ પ્રતિભાવ

પ્રતિભાવ સ્થિતિ કોડ્સ