Servers API - VPS.org

IKSEB /api/v1/servers/

Elenka s-Servers Kollha

Ikseb lista tas-servers kollha fil-kont tiegħek.

Parametri tal-Mistoqsija

Parametru	Tip	Meħtieġ	Deskrizzjoni
`status`	spag	Le	Iffiltra skont l-istatus tas-server: attiv, waqaf, sospiż
`location`	spag	Le	Iffiltra skont il-post taċ-ċentru tad-dejta

Eżempju ta' Talba

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

Eżempju ta' Rispons

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

Kodiċijiet tal-Istatus tar-Rispons

200	Lista tas-servers irkuprata b'suċċess
401	Mhux Awtorizzat - Token tal-API mhux validu jew nieqes

POST /api/v1/servers/

Oħloq Server Ġdid

Implimenta server VPS ġdid b'konfigurazzjoni speċifikata.

Parametri tal-Korp tat-Talba

Parametru	Tip	Meħtieġ	Deskrizzjoni
`name`	spag	Iva	Isem tas-server (alfabetiku, singijiet permessi)
`plan_id`	numru sħiħ	Iva	ID tal-pjan VPS
`os_id`	numru sħiħ	Iva	ID tas-sistema operattiva
`location`	spag	Iva	Kodiċi tal-post taċ-ċentru tad-dejta
`hostname`	spag	Le	Isem tal-host tas-server (FQDN)
`ssh_key_id`	numru sħiħ	Le	ID taċ-ċavetta SSH biex tinstalla
`backups_enabled`	Boolean	Le	Ippermetti backups awtomatiċi (default: falz)

Eżempju ta' Talba

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

Eżempju ta' Rispons

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

Kodiċijiet tal-Istatus tar-Rispons

201	Is-server inħoloq b'suċċess
400	Talba Ħażina - Parametri mhux validi
401	Mhux Awtorizzat - Token tal-API mhux validu jew nieqes
402	Ħlas Meħtieġ - Krediti insuffiċjenti

IKSEB /api/v1/servers/{server_id}/

Ikseb id-Dettalji tas-Server

Ikseb informazzjoni dettaljata dwar server speċifiku.

Parametri tal-Mogħdija

Parametru	Tip	Meħtieġ	Deskrizzjoni
`server_id`	numru sħiħ	Iva	ID uniku tas-server

Eżempju ta' Talba

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

Eżempju ta' Rispons

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

Kodiċijiet tal-Istatus tar-Rispons

200	Id-dettalji tas-server inġabru b'suċċess
401	Mhux Awtorizzat - Token tal-API mhux validu jew nieqes
404	Ma nstabx - Is-server ma jeżistix

POĠĠI /api/v1/servers/{server_id}/

Aġġornament tas-Server

Aġġorna l-konfigurazzjoni tas-server. L-oqsma kollha huma meħtieġa.

Parametri tal-Mogħdija

Parameter	Type	Required	Description
`server_id`	integer	Yes	ID uniku tas-server

Parametri tal-Korp tat-Talba

Parametru	Tip	Meħtieġ	Deskrizzjoni
`name`	spag	Iva	Isem tas-server
`hostname`	spag	Iva	Isem tal-host tas-server (FQDN)
`backups_enabled`	Boolean	Iva	Ippermetti/iddiżattiva backups awtomatiċi

Eżempju ta' Talba

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

Kodiċijiet tal-Istatus tar-Rispons

200	Is-server ġie aġġornat b'suċċess
400	Talba Ħażina - Parametri mhux validi
404	Ma nstabx - Is-server ma jeżistix

GARŻA /api/v1/servers/{server_id}/

Aġġorna Parzjalment is-Server

Aġġorna l-oqsma speċifiċi tas-server. L-oqsma pprovduti biss se jiġu aġġornati.

Eżempju ta' Talba

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

ĦASSAR /api/v1/servers/{server_id}/

Ħassar is-Server

Ħassar server b'mod permanenti. Din l-azzjoni ma tistax titneħħa.

Eżempju ta' Talba

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)

Kodiċijiet tal-Istatus tar-Rispons

204	Is-server tħassar b'suċċess
404	Ma nstabx - Is-server ma jeżistix

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

Ibda s-Server

Ixgħel server li jkun waqaf.

Eżempju ta' Talba

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

Eżempju ta' Rispons

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

Kodiċijiet tal-Istatus tar-Rispons

200	Il-kmand tal-bidu tas-server intbagħat b'suċċess
400	Talba Ħażina - Is-Server diġà qed jaħdem
404	Ma nstabx - Is-server ma jeżistix

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

Waqqaf is-Server

Itfi server li jkun qed jaħdem b'mod grazzjuż.

Eżempju ta' Talba

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

Eżempju ta' Rispons

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

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

Erġa' ibda s-Server

Irristartja server li jkun qed jaħdem b'mod grazzjuż.

Eżempju ta' Talba

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

Eżempju ta' Rispons

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

Kodiċijiet tal-Istatus tar-Rispons

200	Il-kmand tar-reboot tas-server intbagħat b'suċċess
400	Talba Ħażina - Is-Server mhux qed jaħdem
404	Ma nstabx - Is-server ma jeżistix

VPS.org API

API tas-Servers

Elenka s-Servers Kollha

Parametri tal-Mistoqsija

Eżempju ta' Talba

Eżempju ta' Rispons

Kodiċijiet tal-Istatus tar-Rispons

Oħloq Server Ġdid

Parametri tal-Korp tat-Talba

Eżempju ta' Talba

Eżempju ta' Rispons

Kodiċijiet tal-Istatus tar-Rispons

Ikseb id-Dettalji tas-Server

Parametri tal-Mogħdija

Eżempju ta' Talba

Eżempju ta' Rispons

Kodiċijiet tal-Istatus tar-Rispons

Aġġornament tas-Server

Parametri tal-Mogħdija

Parametri tal-Korp tat-Talba

Eżempju ta' Talba

Kodiċijiet tal-Istatus tar-Rispons

Aġġorna Parzjalment is-Server

Eżempju ta' Talba

Ħassar is-Server

Eżempju ta' Talba

Kodiċijiet tal-Istatus tar-Rispons

Ibda s-Server

Eżempju ta' Talba

Eżempju ta' Rispons

Kodiċijiet tal-Istatus tar-Rispons

Waqqaf is-Server

Eżempju ta' Talba

Eżempju ta' Rispons

Erġa' ibda s-Server

Eżempju ta' Talba

Eżempju ta' Rispons

Kodiċijiet tal-Istatus tar-Rispons