>_ NicAPI Dokumentation

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

  1. Einführung
  2. Datacenter

Datacenter / IP-Netzwerke

GET IP-Netze abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/address-networks

Gibt alle zugewiesenen IP-Netze zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESS_NETWORKS_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/address-networks"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/address-networks");

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

GET Einzelnes IP-Netz API v1

GET https://connect.nicapi.eu/api/v1/datacenter/address-networks/{address_network}

Gibt Informationen über ein einzelnes IP-Netz zurück.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
address_network Pflicht Identifikator: IP-Netzwerk Identifikator (id) des Objekts „Address Network“, 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/address-networks/{address_network}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/address-networks/{address_network}");

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

GET Graph abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/address-networks/{address_network}/graph
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESS_NETWORKS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
address_network Pflicht Identifikator: IP-Netzwerk Identifikator (id) des Objekts „Address Network“, Teil des Pfads.

Request-Parameter Werden als Query-Parameter übergeben.

Name Pflicht Typ Einschränkungen Beschreibung
start Pflicht Datum (YYYY-MM-DD)
end Pflicht Datum (YYYY-MM-DD) 
curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/address-networks/{address_network}/graph?start=2026-01-31&end=2026-01-31"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/address-networks/{address_network}/graph", [
    'start' => '2026-01-31',
    'end' => '2026-01-31',
]);

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

Datacenter / IP-Adressen

GET Addresses: Auflisten API v1

GET https://connect.nicapi.eu/api/v1/datacenter/addresses
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_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/addresses"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

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

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

POST Addresses: Anlegen / Ausführen API v1

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

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

Name Pflicht Typ Einschränkungen Beschreibung
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 '{
         "project_uuid": "{project_uuid}"
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/addresses"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/addresses", [
    'project_uuid' => '{project_uuid}',
]);

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

GET Addresses: Statistics API v1

GET https://connect.nicapi.eu/api/v1/datacenter/addresses/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_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/addresses/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

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

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

GET Addresses: Traffic API v1

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

Request-Parameter Werden als Query-Parameter übergeben.

Name Pflicht Typ Einschränkungen Beschreibung
addresses[] Optional IP-Adresse
interval Pflicht Auswahl
daily monthly
start Pflicht Datum (YYYY-MM-DD)
end Pflicht Datum (YYYY-MM-DD)
result_type Pflicht Auswahl
single sum 
curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/addresses/traffic?interval=daily&start=2026-01-31&end=2026-01-31&result_type=single"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/addresses/traffic", [
    'interval' => 'daily',
    'start' => '2026-01-31',
    'end' => '2026-01-31',
    'result_type' => 'single',
]);

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

GET Addresses: Einzeln abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ip_address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“, 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/addresses/{ip_address}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

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

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

PUT Addresses: Ändern API v1

PUT https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_LIST · ADDRESSES_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ip_address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“, Teil des Pfads.

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

Name Pflicht Typ Einschränkungen Beschreibung
rdns Optional Text
darf leer (null) sein
Format: /^([A-Za-z0-9-]{1,63}\.){0,10}[A-Za-z0-9]{2,63}$/
reserved Optional Text
darf leer (null) sein
höchstens 255 Zeichen
 
curl \
  -X PUT \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "rdns": "text",
         "reserved": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::put("datacenter/addresses/{ip_address}", [
    'rdns' => 'text',
    'reserved' => 'text',
]);

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

DELETE Addresses: Löschen API v1

DELETE https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_LIST · ADDRESSES_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ip_address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“, 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/addresses/{ip_address}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::delete("datacenter/addresses/{ip_address}");

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

POST Addresses: Blackhole API v1

POST https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}/blackhole
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_LIST · ADDRESSES_BLACKHOLES

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ip_address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“, 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/addresses/{ip_address}/blackhole"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/addresses/{ip_address}/blackhole");

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

DELETE Addresses: Blackhole API v1

DELETE https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}/blackhole
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_LIST · ADDRESSES_BLACKHOLES

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ip_address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“, 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/addresses/{ip_address}/blackhole"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::delete("datacenter/addresses/{ip_address}/blackhole");

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

GET Addresses: Graph API v1

GET https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}/graph
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ip_address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“, Teil des Pfads.

Request-Parameter Werden als Query-Parameter übergeben.

Name Pflicht Typ Einschränkungen Beschreibung
start Pflicht Datum (YYYY-MM-DD)
end Pflicht Datum (YYYY-MM-DD) 
curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}/graph?start=2026-01-31&end=2026-01-31"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/addresses/{ip_address}/graph", [
    'start' => '2026-01-31',
    'end' => '2026-01-31',
]);

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

POST Addresses: Rdns Create API v1

POST https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}/rdns/create
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_LIST · ADDRESSES_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ip_address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“, Teil des Pfads.

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

Name Pflicht Typ Einschränkungen Beschreibung
rdns Optional Text
Format: /^([A-Za-z0-9-]{1,63}\.){0,10}[A-Za-z0-9]{2,63}$/
 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "rdns": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}/rdns/create"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/addresses/{ip_address}/rdns/create", [
    'rdns' => 'text',
]);

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

DELETE Addresses: Rdns Delete API v1

DELETE https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}/rdns/delete
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_LIST · ADDRESSES_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ip_address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“, 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/addresses/{ip_address}/rdns/delete"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::delete("datacenter/addresses/{ip_address}/rdns/delete");

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

POST Addresses: Reserve API v1

POST https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}/reserve
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_LIST · ADDRESSES_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ip_address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“, Teil des Pfads.

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

Name Pflicht Typ Einschränkungen Beschreibung
reason Pflicht Text
höchstens 255 Zeichen
 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "reason": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}/reserve"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/addresses/{ip_address}/reserve", [
    'reason' => 'text',
]);

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

GET Addresses: Traffic API v1

GET https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}/traffic
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ip_address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“, 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/addresses/{ip_address}/traffic"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/addresses/{ip_address}/traffic");

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

POST Addresses: Unreserve API v1

POST https://connect.nicapi.eu/api/v1/datacenter/addresses/{ip_address}/unreserve
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
ADDRESSES_LIST · ADDRESSES_ACTIONS

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ip_address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“, 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/addresses/{ip_address}/unreserve"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/addresses/{ip_address}/unreserve");

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

Datacenter / DDoS-Alerts

GET DDoS-Angriffe abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/ddos-alerts

Gibt Informationen über empfangene DDoS-Angriffe zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
DDOS_ALERTS_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/ddos-alerts"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/ddos-alerts");

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

GET Ddos Alerts: Statistics API v1

GET https://connect.nicapi.eu/api/v1/datacenter/ddos-alerts/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
DDOS_ALERTS_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/ddos-alerts/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/ddos-alerts/statistics");

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

GET Einzelnen DDoS-Angriff abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/ddos-alerts/{ddos_alert}

Gibt Informationen über einen einzelnen DDoS-Angriff zurück.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
ddos_alert Pflicht Identifikator: DDoS-Alarm Identifikator (id) des Objekts „Ddos Alert“, 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/ddos-alerts/{ddos_alert}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/ddos-alerts/{ddos_alert}");

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

Datacenter / Dedizierte Server

GET Dedizierte Server abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/dedicated-servers

Gibt alle zugewiesenen dedizierten Server zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
DEDICATED_SERVERS_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/dedicated-servers"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/dedicated-servers");

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

GET Dedicated Servers: Statistics API v1

GET https://connect.nicapi.eu/api/v1/datacenter/dedicated-servers/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
DEDICATED_SERVERS_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/dedicated-servers/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/dedicated-servers/statistics");

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

GET Einzelnen dedizierten Server abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/dedicated-servers/{dedicated_server_id}

Gibt Informationen über einzelnen dedizierten Server zurück.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
dedicated_server_id Pflicht Identifikator: Dedizierter Server Identifikator (title) des Objekts „Supermicro 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/dedicated-servers/{dedicated_server_id}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/dedicated-servers/{dedicated_server_id}");

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

GET KVM-Download API v1

GET https://connect.nicapi.eu/api/v1/datacenter/dedicated-servers/{dedicated_server_id}/kvm-download

Gibt einen Download der KVM-Konsole zurück (JNLP-Datei).

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
dedicated_server_id Pflicht Identifikator: Dedizierter Server Identifikator (title) des Objekts „Supermicro 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/dedicated-servers/{dedicated_server_id}/kvm-download"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/dedicated-servers/{dedicated_server_id}/kvm-download");

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

POST KVM-Reset API v1

POST https://connect.nicapi.eu/api/v1/datacenter/dedicated-servers/{dedicated_server_id}/kvm-reset

Setzt die KVM-Konsole zurück. Wird benötigt, wenn das Verbinden mit der KVM-Konsole nicht möglich ist.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
dedicated_server_id Pflicht Identifikator: Dedizierter Server Identifikator (title) des Objekts „Supermicro 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/dedicated-servers/{dedicated_server_id}/kvm-reset"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/dedicated-servers/{dedicated_server_id}/kvm-reset");

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

POST Dedizierten Server zurücksetzen API v1

POST https://connect.nicapi.eu/api/v1/datacenter/dedicated-servers/{dedicated_server_id}/reset

Setzt den Server zurück (Power-Reset).

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
dedicated_server_id Pflicht Identifikator: Dedizierter Server Identifikator (title) des Objekts „Supermicro 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/dedicated-servers/{dedicated_server_id}/reset"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/dedicated-servers/{dedicated_server_id}/reset");

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

POST Dedizierten Server starten API v1

POST https://connect.nicapi.eu/api/v1/datacenter/dedicated-servers/{dedicated_server_id}/start

Startet den dedizierten Server.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
dedicated_server_id Pflicht Identifikator: Dedizierter Server Identifikator (title) des Objekts „Supermicro 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/dedicated-servers/{dedicated_server_id}/start"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/dedicated-servers/{dedicated_server_id}/start");

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

GET Status zum Server abfragen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/dedicated-servers/{dedicated_server_id}/status

Fragt den Status des dedizierten Servers ab.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
dedicated_server_id Pflicht Identifikator: Dedizierter Server Identifikator (title) des Objekts „Supermicro 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/dedicated-servers/{dedicated_server_id}/status"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/dedicated-servers/{dedicated_server_id}/status");

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

POST Dedizierten Server herunterfahren API v1

POST https://connect.nicapi.eu/api/v1/datacenter/dedicated-servers/{dedicated_server_id}/stop

Fährt einen dedizierten Server herunter.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
dedicated_server_id Pflicht Identifikator: Dedizierter Server Identifikator (title) des Objekts „Supermicro 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/dedicated-servers/{dedicated_server_id}/stop"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/dedicated-servers/{dedicated_server_id}/stop");

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

Datacenter / PXE-Installationen

GET PXE-Installationen abrufen API v1

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

Gibt die zugewiesenen PXE-Installationen zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
PXE_INSTALLATIONS_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/pxeinstallations"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

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

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

POST PXE-Installation erstellen API v1

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

Erstellt eine neue PXE-Installation.

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

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

Name Pflicht Typ Einschränkungen Beschreibung
user Optional Identifikator: Benutzer Identifikator (username) des Objekts „User“.
vserver_template Pflicht Text
address Pflicht Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“.
mac_address Pflicht Text
hostname Pflicht Text
password Pflicht Text
support_ssh_key Optional Boolean (true/false)
raid_level Optional Auswahl
darf leer (null) sein
RAID0 RAID1 RAID5
raid_disk_count Bedingt Ganzzahl
darf leer (null) sein
Pflicht, wenn raid_level angegeben wird
mindestens 1
network_name Optional Text
nur Buchstaben und Ziffern
commands Optional Liste Befehle, die nach der Installation auf dem neu installierten Server ausgeführt werden sollen.
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": "text",
         "address": "{address}",
         "mac_address": "text",
         "hostname": "text",
         "password": "text",
         "raid_disk_count": 1
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/pxeinstallations/create"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/pxeinstallations/create", [
    'vserver_template' => 'text',
    'address' => '{address}',
    'mac_address' => 'text',
    'hostname' => 'text',
    'password' => 'text',
    'raid_disk_count' => 1,
]);

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

GET Templates abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/pxeinstallations/templates

Gibt alle möglichen Templates für PXE-Installationen zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
PXE_INSTALLATIONS_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/pxeinstallations/templates"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

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

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

GET Einzelne Installation abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/pxeinstallations/{pxe_installation_id}

Gibt Informationen zu einer einzelnen PXE-Installation zurück.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
pxe_installation_id Pflicht Identifikator: PXE-Installation Identifikator (id) des Objekts „Pxe Installation“, 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/pxeinstallations/{pxe_installation_id}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/pxeinstallations/{pxe_installation_id}");

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

POST PXE-Installation abbrechen API v1

POST https://connect.nicapi.eu/api/v1/datacenter/pxeinstallations/{pxe_installation_id}/cancel

Bricht eine einzelne PXE-Installation ab.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
pxe_installation_id Pflicht Identifikator: PXE-Installation Identifikator (id) des Objekts „Pxe Installation“, 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/pxeinstallations/{pxe_installation_id}/cancel"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/pxeinstallations/{pxe_installation_id}/cancel");

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

Datacenter / PXE-Operationen

GET PXE-Operationen abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/pxeoperations
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
PXE_OPERATIONS_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/pxeoperations"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

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

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

POST PXE-Operation erstellen API v1

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

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

Name Pflicht Typ Einschränkungen Beschreibung
user Optional Identifikator: Benutzer Identifikator (username) des Objekts „User“.
address Optional Identifikator: IP-Adresse Identifikator (address_plain) des Objekts „Address“.
mac_address Pflicht Text
action Pflicht Auswahl
changePassword diskExtend resetNetwork initRescue
password Optional Text
is_raid Pflicht Boolean (true/false)
network_name Optional Text
nur Buchstaben und Ziffern
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 '{
         "mac_address": "text",
         "action": "changePassword",
         "is_raid": true
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/pxeoperations/create"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/pxeoperations/create", [
    'mac_address' => 'text',
    'action' => 'changePassword',
    'is_raid' => true,
]);

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

GET Einzelne PXE-Operation abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/pxeoperations/{pxe_operation_id}
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
PXE_OPERATIONS_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
pxe_operation_id Pflicht Identifikator: PXE-Operation Identifikator (id) des Objekts „Pxe Operation“, 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/pxeoperations/{pxe_operation_id}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/pxeoperations/{pxe_operation_id}");

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

POST PXE-Operation abbrechen API v1

POST https://connect.nicapi.eu/api/v1/datacenter/pxeoperations/{pxe_operation_id}/cancel
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
PXE_OPERATIONS_CRUD

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
pxe_operation_id Pflicht Identifikator: PXE-Operation Identifikator (id) des Objekts „Pxe Operation“, 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/pxeoperations/{pxe_operation_id}/cancel"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/pxeoperations/{pxe_operation_id}/cancel");

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

Datacenter / Server-Aktionen

GET Server Actions: File API v1

GET https://connect.nicapi.eu/api/v1/datacenter/server-actions/file
Authentifizierung
keine (öffentlicher Endpunkt)

Request-Parameter Werden als Query-Parameter übergeben.

Name Pflicht Typ Einschränkungen Beschreibung
address Pflicht Text
DHCP-Konfiguration
 
curl \
  "https://connect.nicapi.eu/api/v1/datacenter/server-actions/file?address=text"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/server-actions/file", [
    'address' => 'text',
]);

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

GET Server Actions: Menu API v1

GET https://connect.nicapi.eu/api/v1/datacenter/server-actions/menu
Authentifizierung
keine (öffentlicher Endpunkt)

Request-Parameter Werden als Query-Parameter übergeben.

Name Pflicht Typ Einschränkungen Beschreibung
address Pflicht Text
DHCP-Konfiguration
 
curl \
  "https://connect.nicapi.eu/api/v1/datacenter/server-actions/menu?address=text"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/server-actions/menu", [
    'address' => 'text',
]);

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

POST Server Actions: Status API v1

POST https://connect.nicapi.eu/api/v1/datacenter/server-actions/status
Authentifizierung
keine (öffentlicher Endpunkt)

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

Name Pflicht Typ Einschränkungen Beschreibung
state Pflicht Auswahl
PENDING RUNNING DONE CANCELLED
state_percent Pflicht Ganzzahl
mindestens 0
höchstens 100
state_text Pflicht Text 
curl \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
         "state": "PENDING",
         "state_percent": 1,
         "state_text": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/datacenter/server-actions/status"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("datacenter/server-actions/status", [
    'state' => 'PENDING',
    'state_percent' => 1,
    'state_text' => 'text',
]);

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

Datacenter / Traffic

GET Traffic abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/traffic
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
TRAFFIC_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/traffic"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

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

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

GET Traffic-Pools abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/traffic/pools

Gibt alle zugewiesenen Traffic-Pools zurück. Pro Unterbenutzer mit Traffic existiert ein eigener Traffic-Pool.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
TRAFFIC_POOLS_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/traffic/pools"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

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

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

GET Traffic: Pools Statistics API v1

GET https://connect.nicapi.eu/api/v1/datacenter/traffic/pools/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
TRAFFIC_POOLS_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/traffic/pools/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

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

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

GET Einzelnen Traffic-Pool abrufen API v1

GET https://connect.nicapi.eu/api/v1/datacenter/traffic/pools/{traffic_pool}

Gibt Informationen zu einem einzelnen Traffic-Pool zurück.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
traffic_pool Pflicht Identifikator: Traffic-Pool Identifikator (id) des Objekts „Traffic Pool“, 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/traffic/pools/{traffic_pool}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/traffic/pools/{traffic_pool}");

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

GET Graph zu Traffic-Pool API v1

GET https://connect.nicapi.eu/api/v1/datacenter/traffic/pools/{traffic_pool}/graph

Gibt einen Graphen für den Traffic des Traffic-Pools zurück. Der Graph wird als BLOB zurückgegeben.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
traffic_pool Pflicht Identifikator: Traffic-Pool Identifikator (id) des Objekts „Traffic Pool“, Teil des Pfads.

Request-Parameter Werden als Query-Parameter übergeben.

Name Pflicht Typ Einschränkungen Beschreibung
start Pflicht Datum (YYYY-MM-DD)
end Pflicht Datum (YYYY-MM-DD) 
curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/datacenter/traffic/pools/{traffic_pool}/graph?start=2026-01-31&end=2026-01-31"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/traffic/pools/{traffic_pool}/graph", [
    'start' => '2026-01-31',
    'end' => '2026-01-31',
]);

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

GET Werte zu Traffic-Pool API v1

GET https://connect.nicapi.eu/api/v1/datacenter/traffic/pools/{traffic_pool}/history

Gibt den Traffic für den einzelnen Traffic-Pool in Monaten zurück.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
traffic_pool Pflicht Identifikator: Traffic-Pool Identifikator (id) des Objekts „Traffic Pool“, 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/traffic/pools/{traffic_pool}/history"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("datacenter/traffic/pools/{traffic_pool}/history");

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

GET Traffic: Statistics API v1

GET https://connect.nicapi.eu/api/v1/datacenter/traffic/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
TRAFFIC_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/traffic/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

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

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

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