>_ NicAPI Dokumentation:

GET: vServer abrufen

/datacenter/vservers

$res = NicAPI::get("/datacenter/vservers", [
]);

Gibt alle zugewiesenen vServer zurück.

Rechte: VSERVERS_LIST

POST: vServer-Backup erstellen

/datacenter/vservers/backups/create

$res = NicAPI::post("/datacenter/vservers/backups/create", [
    "title" => "value",
    "mode" => "value",
]);

Erstellt ein Backup zum übergebenen vServer.

Parameters:

Name Benötigt Typ Beschreibung
title string
mode string
Rechte: VSERVER_BACKUPS_CRUD

DELETE: vServer-Backup löschen

/datacenter/vservers/backups/{vserver_backup}/delete

$res = NicAPI::delete("/datacenter/vservers/backups/{vserver_backup}/delete", [
]);

Diese Funktion löscht das übergebene Backup.

Rechte: VSERVER_BACKUPS_CRUD

POST: vServer aus Backup wiederherstellen

/datacenter/vservers/backups/{vserver_backup}/restore

$res = NicAPI::post("/datacenter/vservers/backups/{vserver_backup}/restore", [
    "vserver_id" => "value",
]);

Diese Funktion stellt den vServer aus dem übergebenen Backup wieder her.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id string
Rechte: VSERVER_BACKUPS_CRUD

POST: vServer erstellen

/datacenter/vservers/create

$res = NicAPI::post("/datacenter/vservers/create", [
    "runtime" => "value",
    "password" => "value",
]);

Diese Funktion erstellt einen neuen vServer.

Parameters:

Name Benötigt Typ Beschreibung
runtime integer
password string
Rechte: VSERVERS_ORDER

POST: Geplante Aufgabe erstellen

/datacenter/vservers/scheduled-tasks/create

$res = NicAPI::post("/datacenter/vservers/scheduled-tasks/create", [
    "first_execution" => "value",
    "vserver_id" => "value",
]);

Diese Funktion erstellt eine geplante (wiederkehrende) Funktion zum übergebenen vServer.

Parameters:

Name Benötigt Typ Beschreibung
first_execution date
vserver_id string
Rechte: VSERVER_SCHEDULED_TASKS_CRUD

DELETE: Geplante Aufgabe löschen

/datacenter/vservers/scheduled-tasks/{scheduled_task}/delete

$res = NicAPI::delete("/datacenter/vservers/scheduled-tasks/{scheduled_task}/delete", [
]);

Diese Funktion löscht die übergebene geplante Aufgabe.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVER_SCHEDULED_TASKS_CRUD

GET: Einzelnes Netzwerk abrufen

/datacenter/vservers/vserver-network/{vserver_network}

$res = NicAPI::get("/datacenter/vservers/vserver-network/{vserver_network}", [
]);

Gibt Informationen über ein einzelnes vServer-Netzwerk zurück.

Rechte: VSERVER_NETWORKS_LIST

GET: Einzelnen vServer abrufen

/datacenter/vservers/{vserver_id}

$res = NicAPI::get("/datacenter/vservers/{vserver_id}", [
]);

Gibt Informationen über einen einzelnen vServer zurück.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_LIST

GET: IP-Adressen zu einzelnem vServer abrufen

/datacenter/vservers/{vserver_id}/addresses

$res = NicAPI::get("/datacenter/vservers/{vserver_id}/addresses", [
]);

Diese Funktion gibt die dem vServer zugewiesenen IP-Adressen zurück.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_LIST

GET: Backups zu einzelnem vServer abrufen

/datacenter/vservers/{vserver_id}/backups

$res = NicAPI::get("/datacenter/vservers/{vserver_id}/backups", [
]);

Diese Funktion gibt die dem vServer zugewiesenen Backups zurück.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_LIST
$res = NicAPI::post("/datacenter/vservers/{vserver_id}/createBackup", [
]);

Diese Funktion erstellt ein neues Backup zum übergebenen vServer.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_ACTIONS

DELETE: vServer löschen

/datacenter/vservers/{vserver_id}/delete

$res = NicAPI::delete("/datacenter/vservers/{vserver_id}/delete", [
]);

Diese Funktion löscht den übergebenen vServer.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_CRUD

GET: Graph zu einzelnem vServer abrufen

/datacenter/vservers/{vserver_id}/graph

$res = NicAPI::get("/datacenter/vservers/{vserver_id}/graph", [
    "timeframe" => "value",
    "cf" => "value",
]);

Diese Funktion gibt die aktuellen RRD-Werte zurück.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
timeframe string
cf string
Rechte: VSERVERS_LIST

GET: Netzwerke zu einzelnem vServer abrufen

/datacenter/vservers/{vserver_id}/networks

$res = NicAPI::get("/datacenter/vservers/{vserver_id}/networks", [
]);

Diese Funktion gibt die dem vServer zugewiesenen Netzwerke zurück.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_LIST

POST: vServer neuinstallieren

/datacenter/vservers/{vserver_id}/reinstall

$res = NicAPI::post("/datacenter/vservers/{vserver_id}/reinstall", [
    "password" => "value",
    "support_ssh_key" => "value",
]);

Diese Funktion startet eine Neuinstallation des vServers.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
password string
support_ssh_key boolean
Rechte: VSERVERS_ACTIONS

POST: vServer neustarten

/datacenter/vservers/{vserver_id}/restart

$res = NicAPI::post("/datacenter/vservers/{vserver_id}/restart", [
]);

Diese Funktion startet den vServer neu (Soft-Reboot).

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_ACTIONS

GET: Geplante Aufgabe zu einzelnem vServer abrufen

/datacenter/vservers/{vserver_id}/scheduledTasks

$res = NicAPI::get("/datacenter/vservers/{vserver_id}/scheduledTasks", [
]);

Diese Funktion gibt die dem vServer zugewiesenen geplanten Aufgaben zurück.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_LIST

POST: vServer herunterfahren

/datacenter/vservers/{vserver_id}/shutdown

$res = NicAPI::post("/datacenter/vservers/{vserver_id}/shutdown", [
]);

Diese Funktion fährt den vServer herunter (Soft-Shutdown).

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_ACTIONS

POST: vServer starten

/datacenter/vservers/{vserver_id}/start

$res = NicAPI::post("/datacenter/vservers/{vserver_id}/start", [
]);

Diese Funktion startet den vServer.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_ACTIONS

GET: vServer-Status abrufen

/datacenter/vservers/{vserver_id}/status

$res = NicAPI::get("/datacenter/vservers/{vserver_id}/status", [
]);

Diese Funktion gibt die aktuellen Status-Informationen, u.a. die aktuelle Auslastung, des vServers zurück.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_LIST

POST: vServer stoppen

/datacenter/vservers/{vserver_id}/stop

$res = NicAPI::post("/datacenter/vservers/{vserver_id}/stop", [
]);

Diese Funktion stoppt den Server (Hard-Shutdown).

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_ACTIONS

GET: Tasks zu einzelnem vServer abrufen

/datacenter/vservers/{vserver_id}/tasks

$res = NicAPI::get("/datacenter/vservers/{vserver_id}/tasks", [
]);

Diese Funktion gibt die dem vServer zugewiesenen Tasks zurück.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_LIST

PUT: vServer upgraden

/datacenter/vservers/{vserver_id}/upgrade

$res = NicAPI::put("/datacenter/vservers/{vserver_id}/upgrade", [
]);

Diese Funktion führt ein Up- oder Downgrade des vServers aus.

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_UPGRADE
$res = NicAPI::get("/datacenter/vservers/{vserver_id}/vnc", [
]);

Diese Funktion gibt eine HTML-Seite mit der VNC-Konsole zurück

Parameters:

Name Benötigt Typ Beschreibung
vserver_id routeparameter
Rechte: VSERVERS_LIST