VPS.org API

REST API Documentation

VPS.org API Documentation

Vollständige REST-API-Dokumentation zur Verwaltung von VPS-Servern, Domains, DNS, Backups und mehr.

Basis-URL https://admin.vps.org/api/v1
Authentifizierung Inhaber-Token
Version v1
Format JSON

Erste Schritte

Mit der VPS.org-API können Sie alle Aspekte Ihrer VPS-Hosting-Infrastruktur programmatisch verwalten, einschließlich Server, Domains, DNS-Einträge, Backups und Snapshots.

Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung mittels eines Bearer-Tokens. Sie können Ihren API-Token in Ihren Kontoeinstellungen generieren unter admin.vps.org/account/developers/.

cURL
Python
JavaScript
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 data = await response.json();
console.log(data);

Jedes Token hat seine eigenen Berechtigungen, wie Server:list oder dns:*. Eine Anfrage, die eine Berechtigung benötigt, die das Token nicht hat, wird mit 403 und einem erforderlichen_permission-Feld mit der Angabe der fehlenden Berechtigung abgelehnt. Bezugnahme auf Berechtigungen

Ratenbegrenzung

Authentifizierungsanfragen sind auf 1.000 pro Stunde pro Konto begrenzt. Unauthentifizierte Anfragen sind auf 100 pro Stunde pro IP-Adresse begrenzt. Eine Anfrage über das Limit erhält 429 mit einem Retry-After-Header, der die Anzahl der Sekunden zum Warten gibt. Bei erfolgreichen Antworten werden keine Ratelimit-Header gesendet.

Paginierung

Listenendpunkte geben ein Objekt mit Zählung, nächste, vorherige und Ergebnisse, 25 Elemente pro Seite zurück. Übergeben Sie die Seite, um zwischen den Seiten zu bewegen, oder folgen Sie der nächsten URL, bis sie null ist. Die Serverliste akzeptiert auch page_size, bis zu 100.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

Fehlerbehandlung

Die API verwendet standardmäßige HTTP-Statuscodes, um Erfolg oder Misserfolg anzuzeigen:

Statuscode Description
200 Erfolg – Anfrage erfolgreich abgeschlossen
201 Ressource erfolgreich erstellt – Ressource wurde erfolgreich erstellt
400 Fehlerhafte Anfrage – Ungültige Parameter oder fehlerhafte Anfrage
202, 204 Akzeptiert und in der Warteschlange (202) oder ohne Antwortstelle (204) gelöscht
402 Zahlung erforderlich: keine Zahlungsmethode auf Datei, unbezahlte Rechnungen oder eine abgelehnte Karte Vorautorisierung
403 Verboten: Das Token fehlt, ist ungültig oder abgelaufen oder fehlt die erforderliche Berechtigung. Fehlerhafte Authentifizierung gibt auch 403 zurück, nicht 401.
404 Nicht gefunden – Ressource existiert nicht.
409 Konflikt: z.B. eine bereits laufende Größe, nicht genügend Kapazität oder eine bereits laufende Bereitstellung
429 Zu viele Anfragen – Ratenlimit überschritten
500 Interner Serverfehler – Auf unserer Seite ist ein Fehler aufgetreten.
503 Service Nicht verfügbar: ein temporäres Problem. Retry, Ehrung Retry-After, wenn es gesendet wird.

Fehler-Körper sind JSON. Die meisten haben ein Detail-Feld oder ein Fehler-Feld, manchmal mit einer Nachricht; Validierungsfehler listen die Probleme nach Feldnamen auf.

API-Kategorien

Durchsuchen Sie unsere API-Dokumentation nach Kategorien:

Server-API 15 Endpunkte

Erstellen, inspizieren, Strom erzeugen, size und löschen von Servern, das Root-Passwort zurücksetzen, Reverse DNS setzen, Befehle ausführen und SSH-Schlüssel verwalten.

Dokumentation ansehen
Backups-API 4 Endpunkte

Liste deine Server-Backups auf, starte eine neue Sicherung und wiederherstellen einen Server von einem Backup.

Dokumentation ansehen
Snapshots-API 4 Endpunkte

Nehmen Sie beschriftete Snapshots eines Servers, listen Sie sie auf und löschen Sie sie.

Dokumentation ansehen
Pläne-API 2 Endpunkte

Rufen Sie verfügbare VPS-Pakete und Preisinformationen ab. Erhalten Sie Details zu Ressourcen, Preisen und Verfügbarkeit.

Dokumentation ansehen
Betriebssystem-API 2 Endpunkte

Liste die Betriebssysteme und Versionen auf, die du installieren kannst, wie Ubuntu, Debian, Rocky Linux, CentOS Stream, Fedora und Alpine.

Dokumentation ansehen
Domains API 7 Endpunkte

Überprüfen Sie die Verfügbarkeit, registrieren und erneuern Sie Domains, und setzen Sie Nameserver und Auto-Erneuerung.

Dokumentation ansehen
DNS API 13 Endpunkte

DNS-Zonen erstellen und ihre A, A, CNAME, MX, TXT, SRV, CAA und andere Datensätze erstellen, aktualisieren und löschen.

Dokumentation ansehen
Standort-API 2 Endpunkte

Liste die verfügbaren Standorte für die Server-Bereitstellung auf.

Dokumentation ansehen
Konto 1 Endpunkte

Abrufen von Kontoprofilen und API-Token-Informationen. Identifizieren Sie, zu welchem Konto ein Token gehört und überprüfen Sie dessen Berechtigungen.

Dokumentation ansehen
Partner 7 Endpunkte

Ziehen Sie Ihre Affiliate-Balance, Empfehlungen, Provisionen und Auszahlungen in Ihre eigenen Berichtswesen, ändern Auszahlungseinstellungen und fordern Auszahlungen.

Dokumentation ansehen

Weitere Endpunkte

Die API hat auch Endpunkte für App-Deployments (/api/v1/deploy-configs/ und /api/v1/deployments/). Sie sind auf diesen Seiten noch nicht beschrieben; die interaktive Referenz listet jeden Endpunkt auf, der aus der Live-API generiert wird.

Öffnen Sie die interaktive API-Referenz

Brauchen Sie Hilfe?

Bei Fragen oder wenn Sie Hilfe mit der API benötigen, zögern Sie bitte nicht, uns zu kontaktieren: