>_ NicAPI Dokumentation

REST-API von LUMASERV: Domains, DNS, SSL, Cloud-Server, IP-Adressen, Abrechnung und mehr.

  1. Einführung
  2. Datacenter
  3. vServer

Datacenter / vServer

GET vServer abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers

Gibt alle zugewiesenen vServer zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST Vservers: Anlegen / Ausführen API v1

POST https://connect.nicapi.eu/api/v1/datacenter/vservers
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_ORDER

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
project_uuid Pflicht UUID
Objekt muss für den Account zugreifbar sein
title Optional Text
höchstens 150 Zeichen
cores Pflicht Ganzzahl
muss einer buchbaren Konfiguration entsprechen (siehe Preise)
muss für den Kunden buchbar sein
memory Pflicht Ganzzahl
muss einer buchbaren Konfiguration entsprechen (siehe Preise)
muss für den Kunden buchbar sein
template Pflicht Text
password Optional Text
mindestens 6 Zeichen
ssh_keys Optional Liste
ssh_keys[] Optional Text
networks Optional Liste
höchstens 20 Einträge
networks[].vlan_id Optional Ganzzahl
darf leer (null) sein
mindestens 1
networks[].primary_ipv4 Optional IP-Adresse
darf leer (null) sein
networks[].custom_address Optional Text
darf leer (null) sein
IPv4-Netz in CIDR-Schreibweise, z. B. 192.0.2.0/28
networks[].custom_gateway Optional IP-Adresse
darf leer (null) sein
storages Pflicht Liste
mindestens 1 Einträge
storages[].size Pflicht Ganzzahl
muss einer buchbaren Konfiguration entsprechen (siehe Preise)
muss für den Kunden buchbar sein
addresses_specific Optional Liste
commands Optional Liste
pxe Optional Boolean (true/false) 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "project_uuid": "2f1b6c3e-7d84-4a0b-9c1e-5f3a8b7d2c10",
         "cores": 1,
         "memory": 1,
         "template": "text",
         "storages": [
             {
                 "size": 1
             }
         ]
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/vservers", [
    'project_uuid' => '2f1b6c3e-7d84-4a0b-9c1e-5f3a8b7d2c10',
    'cores' => 1,
    'memory' => 1,
    'template' => 'text',
    'storages' => [
        [
            'size' => 1,
        ],
    ],
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST vServer-Backup erstellen API v1

POST https://connect.nicapi.eu/api/v1/datacenter/vservers/backups/create

Erstellt ein Backup zum übergebenen vServer.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVER_BACKUPS_CRUD

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
title Optional Text
höchstens 255 Zeichen
mode Optional Auswahl
snapshot suspend stop
vserver_id Pflicht Text
project_uuid Optional Identifikator: Projekt
darf leer (null) sein 		Identifikator (uuid) des Objekts „Project“. 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "vserver_id": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/backups/create"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/vservers/backups/create", [
    'vserver_id' => 'text',
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Vservers: Backups Statistics API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/backups/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVER_BACKUPS_LIST

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/backups/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/backups/statistics");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

DELETE vServer-Backup löschen API v1

DELETE https://connect.nicapi.eu/api/v1/datacenter/vservers/backups/{cloud_server_backup}/delete

Diese Funktion löscht das übergebene Backup.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVER_BACKUPS_CRUD

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_backup Pflicht Identifikator: Cloud-Server-Backup Identifikator (id) des Objekts „Cloud Server Backup“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X DELETE \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/backups/{cloud_server_backup}/delete"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::delete("datacenter/vservers/backups/{cloud_server_backup}/delete");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST vServer aus Backup wiederherstellen API v1

POST https://connect.nicapi.eu/api/v1/datacenter/vservers/backups/{cloud_server_backup}/restore

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVER_BACKUPS_CRUD

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_backup Pflicht Identifikator: Cloud-Server-Backup Identifikator (id) des Objekts „Cloud Server Backup“, Teil des Pfads.

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
vserver_id Pflicht Text 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "vserver_id": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/backups/{cloud_server_backup}/restore"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/vservers/backups/{cloud_server_backup}/restore", [
    'vserver_id' => 'text',
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST generated::iP5mtIR4arsoxlS2 API v1

POST https://connect.nicapi.eu/api/v1/datacenter/vservers/create
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_ORDER

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
project_uuid Pflicht UUID
Objekt muss für den Account zugreifbar sein
title Optional Text
höchstens 150 Zeichen
cores Pflicht Ganzzahl
muss einer buchbaren Konfiguration entsprechen (siehe Preise)
muss für den Kunden buchbar sein
memory Pflicht Ganzzahl
muss einer buchbaren Konfiguration entsprechen (siehe Preise)
muss für den Kunden buchbar sein
template Pflicht Text
password Optional Text
mindestens 6 Zeichen
ssh_keys Optional Liste
ssh_keys[] Optional Text
networks Optional Liste
höchstens 20 Einträge
networks[].vlan_id Optional Ganzzahl
darf leer (null) sein
mindestens 1
networks[].primary_ipv4 Optional IP-Adresse
darf leer (null) sein
networks[].custom_address Optional Text
darf leer (null) sein
IPv4-Netz in CIDR-Schreibweise, z. B. 192.0.2.0/28
networks[].custom_gateway Optional IP-Adresse
darf leer (null) sein
storages Pflicht Liste
mindestens 1 Einträge
storages[].size Pflicht Ganzzahl
muss einer buchbaren Konfiguration entsprechen (siehe Preise)
muss für den Kunden buchbar sein
addresses_specific Optional Liste
commands Optional Liste
pxe Optional Boolean (true/false) 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "project_uuid": "2f1b6c3e-7d84-4a0b-9c1e-5f3a8b7d2c10",
         "cores": 1,
         "memory": 1,
         "template": "text",
         "storages": [
             {
                 "size": 1
             }
         ]
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/create"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/vservers/create", [
    'project_uuid' => '2f1b6c3e-7d84-4a0b-9c1e-5f3a8b7d2c10',
    'cores' => 1,
    'memory' => 1,
    'template' => 'text',
    'storages' => [
        [
            'size' => 1,
        ],
    ],
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Geplante Aufgaben abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/scheduled-tasks
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVER_SCHEDULED_TASKS_LIST

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/scheduled-tasks"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/scheduled-tasks");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST Geplante Aufgabe erstellen API v1

POST https://connect.nicapi.eu/api/v1/datacenter/vservers/scheduled-tasks/create

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVER_SCHEDULED_TASKS_CRUD

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
first_execution Optional Datum (YYYY-MM-DD)
nach now
vserver_id Pflicht Text
action Pflicht Auswahl
createBackup backup restart shutdown start
interval Pflicht Text
Intervall: hour, day, week, month oder year
 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "vserver_id": "text",
         "action": "createBackup",
         "interval": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/scheduled-tasks/create"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/vservers/scheduled-tasks/create", [
    'vserver_id' => 'text',
    'action' => 'createBackup',
    'interval' => 'text',
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Vservers: Scheduled Tasks Statistics API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/scheduled-tasks/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVER_SCHEDULED_TASKS_LIST

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/scheduled-tasks/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/scheduled-tasks/statistics");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

DELETE Geplante Aufgabe löschen API v1

DELETE https://connect.nicapi.eu/api/v1/datacenter/vservers/scheduled-tasks/{cloud_server_scheduled_task}/delete

Diese Funktion löscht die übergebene geplante Aufgabe.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVER_SCHEDULED_TASKS_CRUD

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_scheduled_task Pflicht Identifikator: Geplanter Task Identifikator (id) des Objekts „Cloud Server Scheduled Task“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X DELETE \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/scheduled-tasks/{cloud_server_scheduled_task}/delete"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::delete("datacenter/vservers/scheduled-tasks/{cloud_server_scheduled_task}/delete");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Vservers: Statistics API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/statistics");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Vservers: Tasks API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/tasks
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVER_TASKS_LIST

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/tasks"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/tasks");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Vservers: Tasks Statistics API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/tasks/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVER_TASKS_LIST

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/tasks/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/tasks/statistics");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Einzelnen vServer abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}

Gibt Informationen über einen einzelnen vServer zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/{cloud_server_id}");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET IP-Adressen zu einzelnem vServer abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/addresses

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/addresses"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/{cloud_server_id}/addresses");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Backups zu einzelnem vServer abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/backups

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/backups"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/{cloud_server_id}/backups");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST Backup erstellen API v1

POST https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/createBackup

Diese Funktion erstellt ein neues Backup zum übergebenen vServer.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST · VSERVERS_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/createBackup"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/vservers/{cloud_server_id}/createBackup");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

DELETE vServer löschen API v1

DELETE https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/delete

Diese Funktion löscht den übergebenen vServer.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST · VSERVERS_CRUD

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X DELETE \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/delete"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::delete("datacenter/vservers/{cloud_server_id}/delete");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Graph zu einzelnem vServer abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/graph

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Request-Parameter Werden als Query-Parameter übergeben.

Name Pflicht Typ Einschränkungen Beschreibung
timeframe Pflicht Auswahl
hour day week month year
cf Optional Auswahl
AVERAGE MAX 
curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/graph?timeframe=hour"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/{cloud_server_id}/graph", [
    'timeframe' => 'hour',
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Netzwerke zu einzelnem vServer abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/networks

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/networks"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/{cloud_server_id}/networks");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST vServer neuinstallieren API v1

POST https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/reinstall

Diese Funktion startet eine Neuinstallation des vServers.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST · VSERVERS_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
password Optional Text
mindestens 6 Zeichen
support_ssh_key Optional Boolean (true/false)
vserver_template Pflicht Identifikator: Cloud-Server-Template Identifikator (key) des Objekts „Cloud Server Template“.
project_uuid Optional Identifikator: Projekt
darf leer (null) sein 		Identifikator (uuid) des Objekts „Project“. 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "vserver_template": "{vserver_template}"
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/reinstall"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/vservers/{cloud_server_id}/reinstall", [
    'vserver_template' => '{vserver_template}',
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST vServer neustarten API v1

POST https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/restart

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST · VSERVERS_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/restart"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/vservers/{cloud_server_id}/restart");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Geplante Aufgabe zu einzelnem vServer abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/scheduledTasks

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/scheduledTasks"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/{cloud_server_id}/scheduledTasks");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST vServer herunterfahren API v1

POST https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/shutdown

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST · VSERVERS_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/shutdown"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/vservers/{cloud_server_id}/shutdown");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST vServer starten API v1

POST https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/start

Diese Funktion startet den vServer.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST · VSERVERS_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/start"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/vservers/{cloud_server_id}/start");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET vServer-Status abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/status

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/status"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/{cloud_server_id}/status");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

POST vServer stoppen API v1

POST https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/stop

Diese Funktion stoppt den Server (Hard-Shutdown).

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST · VSERVERS_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/stop"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/vservers/{cloud_server_id}/stop");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Tasks zu einzelnem vServer abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/tasks

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/tasks"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/{cloud_server_id}/tasks");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

PUT vServer upgraden API v1

PUT https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/upgrade

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST · VSERVERS_UPGRADE

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Request-Parameter Werden im Request-Body übergeben (JSON oder Formular-Felder).

Name Pflicht Typ Einschränkungen Beschreibung
cores Pflicht Ganzzahl
muss einer buchbaren Konfiguration entsprechen (siehe Preise)
muss für den Kunden buchbar sein
memory Pflicht Ganzzahl
muss einer buchbaren Konfiguration entsprechen (siehe Preise)
muss für den Kunden buchbar sein
ssh_keys Optional Liste
ssh_keys[] Optional Text
disk Pflicht Ganzzahl
muss einer buchbaren Konfiguration entsprechen (siehe Preise)
muss für den Kunden buchbar sein
addresses_v4 Pflicht Ganzzahl
muss einer buchbaren Konfiguration entsprechen (siehe Preise)
muss für den Kunden buchbar sein
backups Pflicht Ganzzahl
muss einer buchbaren Konfiguration entsprechen (siehe Preise)
muss für den Kunden buchbar sein
project_uuid Optional Text
Objekt muss für den Account zugreifbar sein
 
curl \
  -X PUT \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "cores": 1,
         "memory": 1,
         "disk": 1,
         "addresses_v4": 1,
         "backups": 1
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/upgrade"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::put("datacenter/vservers/{cloud_server_id}/upgrade", [
    'cores' => 1,
    'memory' => 1,
    'disk' => 1,
    'addresses_v4' => 1,
    'backups' => 1,
]);

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET VNC-Konsole API v1

GET https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/vnc

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

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
VSERVERS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
cloud_server_id Pflicht Identifikator: Cloud-Server Identifikator (id) des Objekts „Cloud Server“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/vservers/{cloud_server_id}/vnc"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/vservers/{cloud_server_id}/vnc");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}