REST API – Domain-NSSETs

GET /nssets/check

Prüft, ob ein NSSET-Handle frei verwendbar ist und welchen Status es bei der Registry hat.

Parameter:

• tld – erforderlich, Query, String – TLD, für die das NSSET geprüft wird
• name – erforderlich, Query, String – Handle des NSSETs
• reg_key – optional, Query, String – Kennung einer konkreten Registry

Rückgabecodes:

• 1000 – das NSSET ist für die Registrierung verfügbar
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültige Eingabeparameter
• 2201 – ungültige TLD
• 2247 – nicht unterstütztes Format des NSSETs
• 3242 – das NSSET ist nicht verfügbar
• 3245 – das NSSET ist bereits registriert
• 3248 – NSSET nicht verfügbar – Quarantäne
• 3249 – NSSET nicht verfügbar – reserviert
• 3250 – NSSET nicht verfügbar – gesperrt
• 3251 – das NSSET ist bereits bei uns registriert
• 4218 – Prüfung fehlgeschlagen – Kommunikationsfehler
• 5001 – interner Authentifizierungsfehler

Antwortdaten: Keine – das Ergebnis liefert direkt die Antwort in den Feldern code/msg.

Beispiel:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/nssets/check?tld=cz&name=NSSET'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g1"
}

GET /nssets/{name}

Gibt detaillierte Informationen zu einem NSSET einschließlich seiner DNS-Server zurück.

Parameter:

• name – erforderlich, Pfad – Handle des NSSETs
• tld – erforderlich, Query, String – TLD
• reg_key – optional, Query, String – Kennung einer konkreten Registry

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültige Eingabeparameter
• 2201 – ungültige TLD
• 2209 – Syntaxfehler
• 2247 – nicht unterstütztes Format des NSSETs
• 3214 – das NSSET konnte nicht geladen werden
• 3242 – das NSSET ist nicht verfügbar
• 4204 – Verbindungsfehler

Antwortdaten:

• nsset – Objekt mit den Daten des NSSETs:
  • name – Handle des NSSETs
  • status – Status des NSSETs bei der Registry
  • reg_owner, reg_creator, reg_update – Kennungen des Registrars
  • created_date, updated_date, transfer_date – Datum der Erstellung/Aktualisierung/des Transfers
  • tech_c – Kennung des technischen Kontakts
  • dns.server – Array der DNS-Server des NSSETs (name, addr_ipv4, addr_ipv6)

Beispiel:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/nssets/NSSET?tld=cz'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g2",
  "data": {
    "nsset": {
      "name": "NSSET",
      "status": "ok",
      "tech_c": "CONTACT",
      "created_date": "2024-01-10",
      "dns": {
        "server": [
          { "name": "ns.wedos.com", "addr_ipv4": null, "addr_ipv6": null },
          { "name": "ns.wedos.org", "addr_ipv4": null, "addr_ipv6": null }
        ]
      }
    }
  }
}

POST /nssets

Legt ein neues NSSET an.

Parameter:

• tld – erforderlich, String – TLD, für die das NSSET angelegt wird
• name – optional, String – gewünschtes Handle des NSSETs; wird es nicht angegeben, wird es automatisch erzeugt
• dns – erforderlich, Array – Array von DNS-Servern in der Form [{"name":"ns1.example.com","addr_ipv4":"1.2.3.4","addr_ipv6":"..."},...] (addr_ipv4/addr_ipv6 sind für jeden Server optional; dieselbe Form wie bei POST /domains/create)
• tech_c – optional, String – Kennung des technischen Kontakts; wird sie nicht angegeben, wird die Standardkennung verwendet
• reg_key – optional, String – Kennung einer konkreten Registry

Rückgabecodes:

• 1000 – OK, NSSET angelegt
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiges Format der Eingabeparameter
• 2201 – falsch angegebene TLD
• 2210 – ungültiges Format des Arrays der DNS-Server
• 2211 – zu viele DNS-Server
• 2216 – ungültige Syntax des Kontakts
• 2247 – nicht unterstütztes Format des NSSETs
• 3228 – die Registry unterstützt keine Kontakte
• 3229 – Fehler beim Laden des Kontakts
• 3242 – das NSSET ist nicht verfügbar
• 3244 – Anlegen des NSSETs fehlgeschlagen
• 3245 – das NSSET ist bereits registriert
• 4212 – Verbindungsfehler
• 4218, 4219 – Prüfung/Anlegen fehlgeschlagen – Kommunikationsfehler

Antwortdaten:

• nsset – Handle des angelegten NSSETs

Beispiel:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets' \
  --data '{
    "tld": "cz",
    "dns": [
      { "name": "ns.wedos.com" },
      { "name": "ns.wedos.org" }
    ]
  }'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g3",
  "data": {
    "nsset": "NSSET"
  }
}

POST /nssets/{name}/transfer

Transferiert ein NSSET von einem anderen Registrar zu uns.

Parameter:

• name – erforderlich, Pfad – Handle des NSSETs
• tld – erforderlich, String – TLD
• auth_info – erforderlich, String – Autorisierungscode des NSSETs
• reg_key – optional, String – Kennung einer konkreten Registry

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültige Eingabeparameter
• 2201 – nicht unterstützte TLD
• 2215 – auth_info fehlt
• 2247 – ungültiger Name des NSSETs
• 2249 – der Transfer eines NSSETs ist für diese TLD nicht erlaubt
• 3214 – das NSSET konnte nicht geladen werden
• 3242 – NSSET wird nicht unterstützt
• 3251 – das NSSET ist bereits beim Zielregistrar registriert
• 3255 – Autorisierungsfehler
• 3256 – Transfer des NSSETs fehlgeschlagen
• 4221 – Transfer fehlgeschlagen – Verbindungsfehler

Antwortdaten: Keine – das Ergebnis liefert direkt die Antwort in den Feldern code/msg.

Beispiel:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets/NSSET/transfer' \
  --data '{"tld": "cz", "auth_info": "AUTHCODE123"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g4"
}

POST /nssets/{name}/auth-info/send

Sendet den Autorisierungscode des NSSETs an die E-Mail-Adresse des technischen Kontakts.

Parameter:

• name – erforderlich, Pfad – Handle des NSSETs
• tld – erforderlich, String – TLD
• reg_key – optional, String – Kennung einer konkreten Registry

Rückgabecodes:

• 1000 – OK, Autorisierungscode an die Kontakt-E-Mail-Adresse gesendet
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültige Eingabeparameter
• 2201 – nicht unterstützte TLD
• 2243 – das Senden des Autorisierungscodes ist für dieses NSSET nicht erlaubt
• 3214 – das NSSET konnte nicht geladen werden
• 3217 – das Senden des Autorisierungscodes ist fehlgeschlagen
• 3242 – das NSSET ist nicht verfügbar
• 4222 – Senden fehlgeschlagen – Verbindungsfehler
• 5001 – interner Autorisierungsfehler

Antwortdaten: Keine – das Ergebnis liefert direkt die Antwort in den Feldern code/msg.

Beispiel:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets/NSSET/auth-info/send' \
  --data '{"tld": "cz"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g5"
}

PATCH /nssets/{name}

Ändert ein bestehendes NSSET – seine DNS-Server, den technischen Kontakt oder den Umfang der Tests.

Parameter:

• name – erforderlich, Pfad – Handle des NSSETs
• tld – erforderlich, String – TLD
• dns – erforderlich, Array – Array von DNS-Servern in derselben Form wie bei POST /nssets
• auth_info – erforderlich, String – Autorisierungscode des NSSETs
• tech_c – optional, String – Kennung des technischen Kontakts; wird sie nicht angegeben, bleibt sie unverändert
• reg_key – optional, String – Kennung einer konkreten Registry
• report_level – optional – Umfang der Tests, die die Registry während der Änderung durchführt

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültige Eingabeparameter
• 2201 – falsch angegebene TLD
• 2209 – Syntaxfehler
• 2210 – ungültiges Format des Arrays der DNS-Server
• 2211 – zu viele DNS-Server
• 2216 – ungültige Syntax des Kontakts
• 2247 – ungültiges NSSET
• 3214 – das NSSET konnte nicht geladen werden
• 3242 – das NSSET wird von dieser Domain/Registry nicht unterstützt
• 3252 – Autorisierungsfehler
• 3254 – Änderung des NSSETs fehlgeschlagen
• 4204, 4220 – NSSET nicht verfügbar/Änderung fehlgeschlagen – Verbindungsfehler
• 4212 – Kontakt nicht verfügbar – Verbindungsfehler

Antwortdaten: Keine – das Ergebnis liefert direkt die Antwort in den Feldern code/msg.

Beispiel:

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/nssets/NSSET-1' \
  --data '{
    "tld": "cz",
    "auth_info": "AUTHCODE123",
    "dns": [
      { "name": "ns.wedos.com" },
      { "name": "ns.wedos.org" }
    ]
  }'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3g6"
}