Servers API - VPS.org

HEL /api/v1/servers/

Liis garee Dhammaan Adeegayaasha

Soo hel liiska dhammaan adeegayaasha akoonkaaga.

Cabbirrada Weydiinta

Halbeegga	Nooca	Loo baahan yahay	Sharaxaad
`status`	xarig	Maya	Shaandhee xaaladda server-ka: firfircoon, la joojiyay, la hakiyey
`location`	xarig	Maya	Ku shaandhee goobta xarunta xogta

Codsi Tusaale ah

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

Jawaabta Tusaale

{
  "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"
    }
  ]
}

Koodhadhka Xaaladda Jawaab celinta

200	Si guul leh ayaa loo soo ceshaday liiska server-ka
401	Aan la oggolayn - Calaamadda API-ga oo aan sax ahayn ama maqan

BOOSKA /api/v1/servers/

Samee Server Cusub

Adeegso server VPS cusub oo leh habayn gaar ah.

Codso Cabbirrada Jirka

Halbeegga	Nooca	Loo baahan yahay	Sharaxaad
`name`	xarig	Haa	Magaca server-ka (alphanumeric, xariiqyada waa la oggol yahay)
`plan_id`	tiro ahaan	Haa	Aqoonsiga qorshaha VPS
`os_id`	tiro ahaan	Haa	Aqoonsiga nidaamka hawlgalka
`location`	xarig	Haa	Koodhka goobta xarunta xogta
`hostname`	xarig	Maya	Magaca martigeliyaha server-ka (FQDN)
`ssh_key_id`	tiro ahaan	Maya	Aqoonsiga furaha SSH si loo rakibo
`backups_enabled`	Boolian	Maya	Daar kaydinta otomaatiga ah (sida caadiga ah: been)

Codsi Tusaale ah

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

Jawaabta Tusaale

{
  "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."
}

Koodhadhka Xaaladda Jawaab celinta

201	Server-ka si guul leh ayaa loo sameeyay
400	Codsi Xun - Xuduudo aan sax ahayn
401	Aan la oggolayn - Calaamadda API-ga oo aan sax ahayn ama maqan
402	Lacag bixintu way u baahan tahay - Deyn aan ku filnayn

HEL /api/v1/servers/{server_id}/

Hel Faahfaahinta Adeegaha

Soo hel macluumaad faahfaahsan oo ku saabsan server gaar ah.

Halbeegyada Wadada

Halbeegga	Nooca	Loo baahan yahay	Sharaxaad
`server_id`	tiro ahaan	Haa	Aqoonsiga server-ka gaarka ah

Codsi Tusaale ah

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

Jawaabta Tusaale

{
  "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"
}

Koodhadhka Xaaladda Jawaab celinta

200	Si guul leh ayaa loo soo ceshaday faahfaahinta server-ka
401	Aan la oggolayn - Calaamadda API-ga oo aan sax ahayn ama maqan
404	Lama helin - Server ma jiro

DHIG /api/v1/servers/{server_id}/

Cusboonaysii Server-ka

Cusboonaysii habaynta server-ka. Dhammaan meelaha waa loo baahan yahay.

Halbeegyada Wadada

Parameter	Type	Required	Description
`server_id`	integer	Yes	Aqoonsiga server-ka gaarka ah

Codso Cabbirrada Jirka

Halbeegga	Nooca	Loo baahan yahay	Sharaxaad
`name`	xarig	Haa	Magaca server-ka
`hostname`	xarig	Haa	Magaca martigeliyaha server-ka (FQDN)
`backups_enabled`	Boolian	Haa	Daar/dembi kaydinta otomaatiga ah

Codsi Tusaale ah

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())

Koodhadhka Xaaladda Jawaab celinta

200	Server-ka si guul leh ayaa loo cusbooneysiiyay
400	Codsi Xun - Xuduudo aan sax ahayn
404	Lama helin - Server ma jiro

BALAQ /api/v1/servers/{server_id}/

Qayb ahaan Cusboonaysii Server-ka

Cusbooneysii goobaha gaarka ah ee server-ka. Meelaha la bixiyay oo keliya ayaa la cusbooneysiin doonaa.

Codsi Tusaale ah

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())

TIRTIR /api/v1/servers/{server_id}/

Tirtir Server-ka

Si joogto ah u tirtir server. Tallaabadan lama celin karo.

Codsi Tusaale ah

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)

Koodhadhka Xaaladda Jawaab celinta

204	Server-ka si guul leh ayaa loo tirtiray
404	Lama helin - Server ma jiro

BOOSKA /api/v1/servers/{server_id}/start/

Bilow Server-ka

Ku shid server-ka la joojiyay.

Codsi Tusaale ah

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

Jawaabta Tusaale

{
  "status": "success",
  "message": "Server is starting",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "starting"
  }
}

Koodhadhka Xaaladda Jawaab celinta

200	Amarka bilowga server-ka ayaa si guul leh loo diray
400	Codsi Xun - Serverku wuu shaqeynayaa
404	Lama helin - Server ma jiro

BOOSKA /api/v1/servers/{server_id}/stop/

Jooji Server-ka

Si naxariis leh u xidh server shaqeynaya.

Codsi Tusaale ah

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())

Jawaabta Tusaale

{
  "status": "success",
  "message": "Server is stopping",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "stopping"
  }
}

BOOSKA /api/v1/servers/{server_id}/reboot/

Dib u bilow Server-ka

Si naxariis leh dib ugu bilow server shaqeynaya.

Codsi Tusaale ah

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())

Jawaabta Tusaale

{
  "status": "success",
  "message": "Server is rebooting",
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "rebooting"
  }
}

Koodhadhka Xaaladda Jawaab celinta

200	Amarka dib-u-bilaabista server-ka ayaa si guul leh loo diray
400	Codsi Xun - Serverku ma shaqeynayo
404	Lama helin - Server ma jiro

VPS.org API

Server-yada API

Liis garee Dhammaan Adeegayaasha

Cabbirrada Weydiinta

Codsi Tusaale ah

Jawaabta Tusaale

Koodhadhka Xaaladda Jawaab celinta

Samee Server Cusub

Codso Cabbirrada Jirka

Codsi Tusaale ah

Jawaabta Tusaale

Koodhadhka Xaaladda Jawaab celinta

Hel Faahfaahinta Adeegaha

Halbeegyada Wadada

Codsi Tusaale ah

Jawaabta Tusaale

Koodhadhka Xaaladda Jawaab celinta

Cusboonaysii Server-ka

Halbeegyada Wadada

Codso Cabbirrada Jirka

Codsi Tusaale ah

Koodhadhka Xaaladda Jawaab celinta

Qayb ahaan Cusboonaysii Server-ka

Codsi Tusaale ah

Tirtir Server-ka

Codsi Tusaale ah

Koodhadhka Xaaladda Jawaab celinta

Bilow Server-ka

Codsi Tusaale ah

Jawaabta Tusaale

Koodhadhka Xaaladda Jawaab celinta

Jooji Server-ka

Codsi Tusaale ah

Jawaabta Tusaale

Dib u bilow Server-ka

Codsi Tusaale ah

Jawaabta Tusaale

Koodhadhka Xaaladda Jawaab celinta