>_ NicAPI Dokumentation

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

  1. Einführung
  2. Domains

Domains / Domains

GET Domains abrufen API v1

GET https://connect.nicapi.eu/api/v1/domain/domains

Gibt alle zugewiesenen Domains zurück.

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

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/domains");

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

POST AuthCode abrufen API v1

POST https://connect.nicapi.eu/api/v1/domain/domains/authcode

Diese Funktion generiert einen AuthCode für die übergebene Domain.

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

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

Name Pflicht Typ Einschränkungen Beschreibung
domainName Pflicht Identifikator: Domain Identifikator (name) des Objekts „Domain“. 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "domainName": "{domainName}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/domains/authcode"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/domains/authcode", [
    'domainName' => '{domainName}',
]);

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

POST Verfügbarkeit abfragen API v1

POST https://connect.nicapi.eu/api/v1/domain/domains/check

Diese Funktion fragt die Verfügbarkeit einer Domain ab.

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

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

Name Pflicht Typ Einschränkungen Beschreibung
domainName Pflicht Text 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "domainName": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/domains/check"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/domains/check", [
    'domainName' => 'text',
]);

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

POST Domain bestellen API v1

POST https://connect.nicapi.eu/api/v1/domain/domains/create

Diese Funktion bestellt eine Domain mit den übergebenen Werten.

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

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

Name Pflicht Typ Einschränkungen Beschreibung
domainName Pflicht Text
ownerC Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“.
adminC Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“.
techC Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“.
zoneC Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“.
ns1 Pflicht Identifikator: Nameserver Identifikator (servername) des Objekts „Domain Nameserver“.
ns2 Pflicht Identifikator: Nameserver Identifikator (servername) des Objekts „Domain Nameserver“.
ns3 Optional Identifikator: Nameserver
darf leer (null) sein 		Identifikator (servername) des Objekts „Domain Nameserver“.
ns4 Optional Identifikator: Nameserver
darf leer (null) sein 		Identifikator (servername) des Objekts „Domain Nameserver“.
ns5 Optional Identifikator: Nameserver
darf leer (null) sein 		Identifikator (servername) des Objekts „Domain Nameserver“.
user Optional Identifikator: Benutzer
darf leer (null) sein 		Identifikator (username) des Objekts „User“.
years Optional Ganzzahl
mindestens 1
höchstens 10
create_zone Optional Boolean (true/false)
darf leer (null) sein
authinfo Optional Text
darf leer (null) sein
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 '{
         "domainName": "text",
         "ownerC": "{ownerC}",
         "adminC": "{adminC}",
         "techC": "{techC}",
         "zoneC": "{zoneC}",
         "ns1": "{ns1}",
         "ns2": "{ns2}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/domains/create"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/domains/create", [
    'domainName' => 'text',
    'ownerC' => '{ownerC}',
    'adminC' => '{adminC}',
    'techC' => '{techC}',
    'zoneC' => '{zoneC}',
    'ns1' => '{ns1}',
    'ns2' => '{ns2}',
]);

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

DELETE Domain löschen API v1

DELETE https://connect.nicapi.eu/api/v1/domain/domains/delete

Diese Funktion löscht eine Domain bzw. trägt eine Löschung zum übergebenen Datum ein.

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

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

Name Pflicht Typ Einschränkungen Beschreibung
domainName Pflicht Identifikator: Domain Identifikator (name) des Objekts „Domain“.
date Optional Datum (YYYY-MM-DD) 
curl \
  -X DELETE \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "domainName": "{domainName}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/domains/delete"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::delete("domain/domains/delete", [
    'domainName' => '{domainName}',
]);

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

POST Domain aktualisieren API v1

POST https://connect.nicapi.eu/api/v1/domain/domains/edit

Diese Funktion ändert die übergebene Domain auf die übergebenen Werte.

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

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

Name Pflicht Typ Einschränkungen Beschreibung
domainName Pflicht Identifikator: Domain Identifikator (name) des Objekts „Domain“.
ownerC Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“.
adminC Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“.
techC Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“.
zoneC Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“.
ns1 Pflicht Identifikator: Nameserver Identifikator (servername) des Objekts „Domain Nameserver“.
ns2 Pflicht Identifikator: Nameserver Identifikator (servername) des Objekts „Domain Nameserver“.
ns3 Optional Identifikator: Nameserver
darf leer (null) sein 		Identifikator (servername) des Objekts „Domain Nameserver“.
ns4 Optional Identifikator: Nameserver
darf leer (null) sein 		Identifikator (servername) des Objekts „Domain Nameserver“.
ns5 Optional Identifikator: Nameserver
darf leer (null) sein 		Identifikator (servername) des Objekts „Domain Nameserver“.
user Optional Identifikator: Benutzer Identifikator (username) des Objekts „User“.
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 '{
         "domainName": "{domainName}",
         "ownerC": "{ownerC}",
         "adminC": "{adminC}",
         "techC": "{techC}",
         "zoneC": "{zoneC}",
         "ns1": "{ns1}",
         "ns2": "{ns2}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/domains/edit"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/domains/edit", [
    'domainName' => '{domainName}',
    'ownerC' => '{ownerC}',
    'adminC' => '{adminC}',
    'techC' => '{techC}',
    'zoneC' => '{zoneC}',
    'ns1' => '{ns1}',
    'ns2' => '{ns2}',
]);

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

POST Domain wiederherstellen API v1

POST https://connect.nicapi.eu/api/v1/domain/domains/restore

Diese Funktion stellt eine Domain wieder her.

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

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

Name Pflicht Typ Einschränkungen Beschreibung
domainName Pflicht Identifikator: Domain Identifikator (name) des Objekts „Domain“. 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "domainName": "{domainName}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/domains/restore"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/domains/restore", [
    'domainName' => '{domainName}',
]);

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

GET Einzelne Domain abrufen API v1

GET https://connect.nicapi.eu/api/v1/domain/domains/show

Gibt Informationen über eine einzelne Domain zurück.

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

Request-Parameter Werden als Query-Parameter übergeben.

Name Pflicht Typ Einschränkungen Beschreibung
domainName Pflicht Identifikator: Domain Identifikator (name) des Objekts „Domain“. 
curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/domain/domains/show?domainName=%7BdomainName%7D"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/domains/show", [
    'domainName' => '{domainName}',
]);

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

GET Domains: Statistics API v1

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

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/domains/statistics");

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

GET TLDs abrufen API v1

GET https://connect.nicapi.eu/api/v1/domain/domains/tlds

Gibt alle verfügbaren TLDs zurück.

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

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

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

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/domains/tlds");

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

POST Domainlöschung zurückziehen API v1

POST https://connect.nicapi.eu/api/v1/domain/domains/undelete

Diese Funktion nimmt eine eingetragene Löschung zu einer Domain zurück.

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

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

Name Pflicht Typ Einschränkungen Beschreibung
domainName Pflicht Identifikator: Domain Identifikator (name) des Objekts „Domain“. 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "domainName": "{domainName}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/domains/undelete"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/domains/undelete", [
    'domainName' => '{domainName}',
]);

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

Domains / Domain-Aufträge

GET Domaintasks: Auflisten API v1

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

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/domaintasks");

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

Domains / Handles / Kontakte

GET Handles abrufen API v1

GET https://connect.nicapi.eu/api/v1/domain/handles

Diese Funktion gibt alle zugewiesenen Handles zurück.

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

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/handles");

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

GET Länder abrufen API v1

GET https://connect.nicapi.eu/api/v1/domain/handles/countries

Diese Funktion gibt alle verfügbaren Länder für Handles zurück.

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

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/handles/countries");

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

POST Handle erstellen API v1

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

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

Name Pflicht Typ Einschränkungen Beschreibung
type Pflicht Auswahl
PERS ORG ROLE
sex Pflicht Auswahl
MALE FEMALE
firstname Pflicht Text
höchstens 100 Zeichen
lastname Pflicht Text
höchstens 100 Zeichen
organisation Bedingt Text
Pflicht, wenn type = ORG
höchstens 100 Zeichen
street Pflicht Text
höchstens 100 Zeichen
number Pflicht Text
höchstens 10 Zeichen
Format: /^[a-zA-z0-9 \/\-]{1,10}$/
postcode Pflicht Text
höchstens 12 Zeichen
Format: /.+/
city Pflicht Text
höchstens 100 Zeichen
Format: /^[^@`´]+$/
region Pflicht Text
höchstens 100 Zeichen
Format: /^[^@`´()]+$/
country Pflicht Text
muss ein vorhandener Wert sein (Ländercode nach ISO 3166-1 alpha-2, z. B. DE)
email Pflicht E-Mail-Adresse
countryofbirth Optional Text
muss ein vorhandener Wert sein (Ländercode nach ISO 3166-1 alpha-2, z. B. DE)
user Optional Identifikator: Benutzer Identifikator (username) des Objekts „User“.
dateofbirth Optional Datum (YYYY-MM-DD)
phone Pflicht Text
Telefonnummer im internationalen Format, z. B. +49.1234567890
fax Optional Text
darf leer (null) sein
Telefonnummer im internationalen Format, z. B. +49.1234567890
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 '{
         "type": "PERS",
         "sex": "MALE",
         "firstname": "text",
         "lastname": "text",
         "organisation": "text",
         "street": "text",
         "number": "text",
         "postcode": "text",
         "city": "text",
         "region": "text",
         "country": "text",
         "email": "max@example.com",
         "phone": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/handles/create"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/handles/create", [
    'type' => 'PERS',
    'sex' => 'MALE',
    'firstname' => 'text',
    'lastname' => 'text',
    'organisation' => 'text',
    'street' => 'text',
    'number' => 'text',
    'postcode' => 'text',
    'city' => 'text',
    'region' => 'text',
    'country' => 'text',
    'email' => 'max@example.com',
    'phone' => 'text',
]);

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

DELETE Handle löschen API v1

DELETE https://connect.nicapi.eu/api/v1/domain/handles/delete
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
HANDLES_CRUD

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

Name Pflicht Typ Einschränkungen Beschreibung
handle Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“. 
curl \
  -X DELETE \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "handle": "{handle}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/handles/delete"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::delete("domain/handles/delete", [
    'handle' => '{handle}',
]);

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

POST Handle bearbeiten API v1

POST https://connect.nicapi.eu/api/v1/domain/handles/edit
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
HANDLES_CRUD

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

Name Pflicht Typ Einschränkungen Beschreibung
handle Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“.
organisation Optional Text
höchstens 100 Zeichen
street Pflicht Text
höchstens 100 Zeichen
number Pflicht Text
höchstens 10 Zeichen
Format: /^[a-zA-z0-9 \/\-]{1,10}$/
postcode Pflicht Text
höchstens 12 Zeichen
Format: /.+/
city Pflicht Text
höchstens 100 Zeichen
Format: /^[^@`´]+$/
region Pflicht Text
höchstens 100 Zeichen
Format: /^[^@`´()]+$/
country Pflicht Text
muss ein vorhandener Wert sein (Ländercode nach ISO 3166-1 alpha-2, z. B. DE)
email Pflicht E-Mail-Adresse
countryofbirth Optional Text
muss ein vorhandener Wert sein (Ländercode nach ISO 3166-1 alpha-2, z. B. DE)
user Optional Identifikator: Benutzer Identifikator (username) des Objekts „User“.
phone Pflicht Text
Telefonnummer im internationalen Format, z. B. +49.1234567890
fax Optional Text
Telefonnummer im internationalen Format, z. B. +49.1234567890
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 '{
         "handle": "{handle}",
         "street": "text",
         "number": "text",
         "postcode": "text",
         "city": "text",
         "region": "text",
         "country": "text",
         "email": "max@example.com",
         "phone": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/handles/edit"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/handles/edit", [
    'handle' => '{handle}',
    'street' => 'text',
    'number' => 'text',
    'postcode' => 'text',
    'city' => 'text',
    'region' => 'text',
    'country' => 'text',
    'email' => 'max@example.com',
    'phone' => 'text',
]);

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

GET Einzelnes Handle abrufen API v1

GET https://connect.nicapi.eu/api/v1/domain/handles/show

Gibt Informationen über ein einzelnes Handle zurück.

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

Request-Parameter Werden als Query-Parameter übergeben.

Name Pflicht Typ Einschränkungen Beschreibung
handle Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“. 
curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/domain/handles/show?handle=%7Bhandle%7D"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/handles/show", [
    'handle' => '{handle}',
]);

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

GET Handles: Statistics API v1

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

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/handles/statistics");

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

POST Handles: Verification Refresh API v1

POST https://connect.nicapi.eu/api/v1/domain/handles/verification/refresh
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
HANDLES_LIST

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

Name Pflicht Typ Einschränkungen Beschreibung
handle Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“. 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "handle": "{handle}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/handles/verification/refresh"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/handles/verification/refresh", [
    'handle' => '{handle}',
]);

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

POST Handles: Verification Resend API v1

POST https://connect.nicapi.eu/api/v1/domain/handles/verification/resend
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
HANDLES_CRUD

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

Name Pflicht Typ Einschränkungen Beschreibung
handle Pflicht Identifikator: Domain-Handle (Kontakt) Identifikator (handle) des Objekts „Domain Handle“. 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "handle": "{handle}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/handles/verification/resend"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/handles/verification/resend", [
    'handle' => '{handle}',
]);

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

Domains / Nameserver

GET Nameserver abrufen API v1

GET https://connect.nicapi.eu/api/v1/domain/nameservers

Gibt alle zugewiesenen Nameserver zurück.

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

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/nameservers");

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

POST Nameserver erstellen API v1

POST https://connect.nicapi.eu/api/v1/domain/nameservers/create

Erstellt einen neuen Nameserver.

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

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

Name Pflicht Typ Einschränkungen Beschreibung
nameserver Pflicht Text
muss eindeutig sein (noch nicht vergeben)
Format: /^[A-Za-z0-9.\-ßäöü]+$/
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 '{
         "nameserver": "text"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/nameservers/create"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/nameservers/create", [
    'nameserver' => 'text',
]);

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

DELETE Nameserver löschen API v1

DELETE https://connect.nicapi.eu/api/v1/domain/nameservers/delete

Löscht einen Nameserver. Eine Löschung ist nur möglich, wenn dieser bei keiner Domain mehr verwendet wird.

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

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

Name Pflicht Typ Einschränkungen Beschreibung
nameserver Pflicht Identifikator: Nameserver Identifikator (servername) des Objekts „Domain Nameserver“. 
curl \
  -X DELETE \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "nameserver": "{nameserver}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/nameservers/delete"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::delete("domain/nameservers/delete", [
    'nameserver' => '{nameserver}',
]);

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

POST Nameserver aktualisieren API v1

POST https://connect.nicapi.eu/api/v1/domain/nameservers/refresh
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
NAMESERVERS_ACTIONS

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

Name Pflicht Typ Einschränkungen Beschreibung
nameserver Pflicht Identifikator: Nameserver Identifikator (servername) des Objekts „Domain Nameserver“. 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "nameserver": "{nameserver}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/nameservers/refresh"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/nameservers/refresh", [
    'nameserver' => '{nameserver}',
]);

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

GET Einzelnen Nameserver abrufen API v1

GET https://connect.nicapi.eu/api/v1/domain/nameservers/show
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
NAMESERVERS_LIST

Request-Parameter Werden als Query-Parameter übergeben.

Name Pflicht Typ Einschränkungen Beschreibung
nameserver Pflicht Identifikator: Nameserver Identifikator (servername) des Objekts „Domain Nameserver“. 
curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/domain/nameservers/show?nameserver=%7Bnameserver%7D"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/nameservers/show", [
    'nameserver' => '{nameserver}',
]);

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

GET Nameservers: Statistics API v1

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

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/nameservers/statistics");

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

Domains / Kontakt-Verifizierungen

GET Verifications: Auflisten API v1

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

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/verifications");

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

POST Verifications: Refresh API v1

POST https://connect.nicapi.eu/api/v1/domain/verifications/refresh
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
HANDLES_LIST

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

Name Pflicht Typ Einschränkungen Beschreibung
domain_handle_verification Pflicht Identifikator: Kontakt-Verifizierung Identifikator (id) des Objekts „Domain Handle Verification“. 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "domain_handle_verification": "{domain_handle_verification}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/verifications/refresh"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/verifications/refresh", [
    'domain_handle_verification' => '{domain_handle_verification}',
]);

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

POST Verifications: Resend API v1

POST https://connect.nicapi.eu/api/v1/domain/verifications/resend
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
HANDLES_CRUD

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

Name Pflicht Typ Einschränkungen Beschreibung
domain_handle_verification Pflicht Identifikator: Kontakt-Verifizierung Identifikator (id) des Objekts „Domain Handle Verification“. 
curl \
  -X POST \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "domain_handle_verification": "{domain_handle_verification}"
     }' \
  "https://connect.nicapi.eu/api/v1/domain/verifications/resend"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::post("domain/verifications/resend", [
    'domain_handle_verification' => '{domain_handle_verification}',
]);

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

GET Verifications: Show API v1

GET https://connect.nicapi.eu/api/v1/domain/verifications/show
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
HANDLES_LIST

Request-Parameter Werden als Query-Parameter übergeben.

Name Pflicht Typ Einschränkungen Beschreibung
domain_handle_verification Pflicht Identifikator: Kontakt-Verifizierung Identifikator (id) des Objekts „Domain Handle Verification“. 
curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/domain/verifications/show?domain_handle_verification=%7Bdomain_handle_verification%7D"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/verifications/show", [
    'domain_handle_verification' => '{domain_handle_verification}',
]);

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

GET Verifications: Statistics API v1

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

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("domain/verifications/statistics");

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