Servers API - VPS.org

ERHALTEN /api/v1/servers/

Alle Server auflisten

Ruft eine Liste aller Server in Ihrem Konto ab.

Abfrageparameter

Parameter	Typ	Erforderlich	Beschreibung
`status`	Zeichenkette	NEIN	Nach Serverstatus filtern: aktiv, gestoppt, angehalten
`location`	Zeichenkette	NEIN	Nach Rechenzentrumsstandort filtern

Beispielanfrage

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

Beispielantwort

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

Antwortstatuscodes

200	Serverliste erfolgreich abgerufen
401	Nicht autorisiert – Ungültiges oder fehlendes API-Token

POST /api/v1/servers/

Neuen Server erstellen

Einen neuen VPS-Server mit der angegebenen Konfiguration bereitstellen.

Anfragekörperparameter

Parameter	Typ	Erforderlich	Beschreibung
`name`	Zeichenkette	Ja	Servername (alphanumerisch, Bindestriche erlaubt)
`plan_id`	ganze Zahl	Ja	ID des VPS-Plans
`os_id`	ganze Zahl	Ja	ID des Betriebssystems
`location`	Zeichenkette	Ja	Standortcode des Rechenzentrums
`hostname`	Zeichenkette	NEIN	Server-Hostname (FQDN)
`ssh_key_id`	ganze Zahl	NEIN	SSH-Schlüssel-ID zur Installation
`backups_enabled`	boolescher Wert	NEIN	Automatische Datensicherung aktivieren (Standard: false)

Beispielanfrage

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

Beispielantwort

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

Antwortstatuscodes

201	Server erfolgreich erstellt
400	Fehlerhafte Anfrage – Ungültige Parameter
401	Nicht autorisiert – Ungültiges oder fehlendes API-Token
402	Zahlung erforderlich – Nicht ausreichend Guthaben

ERHALTEN /api/v1/servers/{server_id}/

Serverdetails abrufen

Detaillierte Informationen über einen bestimmten Server abrufen.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`server_id`	ganze Zahl	Ja	Eindeutige Server-ID

Beispielanfrage

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

Beispielantwort

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

Antwortstatuscodes

200	Serverdetails erfolgreich abgerufen
401	Nicht autorisiert – Ungültiges oder fehlendes API-Token
404	Nicht gefunden – Server existiert nicht

SETZEN /api/v1/servers/{server_id}/

Update-Server

Serverkonfiguration aktualisieren. Alle Felder sind Pflichtfelder.

Pfadparameter

Parameter	Type	Required	Description
`server_id`	integer	Yes	Eindeutige Server-ID

Anfragekörperparameter

Parameter	Typ	Erforderlich	Beschreibung
`name`	Zeichenkette	Ja	Servername
`hostname`	Zeichenkette	Ja	Server-Hostname (FQDN)
`backups_enabled`	boolescher Wert	Ja	Automatische Datensicherungen aktivieren/deaktivieren

Beispielanfrage

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

Antwortstatuscodes

200	Server erfolgreich aktualisiert
400	Fehlerhafte Anfrage – Ungültige Parameter
404	Nicht gefunden – Server existiert nicht

Patch /api/v1/servers/{server_id}/

Server teilweise aktualisieren

Aktualisieren Sie bestimmte Serverfelder. Nur die angegebenen Felder werden aktualisiert.

Beispielanfrage

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

LÖSCHEN /api/v1/servers/{server_id}/

Server löschen

Einen Server endgültig löschen. Diese Aktion kann nicht rückgängig gemacht werden.

Beispielanfrage

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)

Antwortstatuscodes

204	Server erfolgreich gelöscht
404	Nicht gefunden – Server existiert nicht

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

Server starten

Einschalten eines gestoppten Servers.

Beispielanfrage

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

Beispielantwort

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

Antwortstatuscodes

200	Serverstartbefehl erfolgreich gesendet
400	Fehlerhafte Anfrage – der Server läuft bereits.
404	Nicht gefunden – Server existiert nicht

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

Server stoppen

Einen laufenden Server ordnungsgemäß herunterfahren.

Beispielanfrage

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

Beispielantwort

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

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

Server neu starten

Einen laufenden Server ordnungsgemäß neu starten.

Beispielanfrage

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

Beispielantwort

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

Antwortstatuscodes

200	Serverneustartbefehl erfolgreich gesendet
400	Fehlerhafte Anfrage – Server ist nicht aktiv.
404	Nicht gefunden – Server existiert nicht

VPS.org API

Server-API

Alle Server auflisten

Abfrageparameter

Beispielanfrage

Beispielantwort

Antwortstatuscodes

Neuen Server erstellen

Anfragekörperparameter

Beispielanfrage

Beispielantwort

Antwortstatuscodes

Serverdetails abrufen

Pfadparameter

Beispielanfrage

Beispielantwort

Antwortstatuscodes

Update-Server

Pfadparameter

Anfragekörperparameter

Beispielanfrage

Antwortstatuscodes

Server teilweise aktualisieren

Beispielanfrage

Server löschen

Beispielanfrage

Antwortstatuscodes

Server starten

Beispielanfrage

Beispielantwort

Antwortstatuscodes

Server stoppen

Beispielanfrage

Beispielantwort

Server neu starten

Beispielanfrage

Beispielantwort

Antwortstatuscodes