>_ NicAPI Dokumentation

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

  1. Einführung
  2. Datacenter
  3. Dedizierte Server

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