REST API – Domains

GET /domains

Gibt eine Liste aller Domains des angemeldeten Kunden zurück, optional nach Status gefiltert. Der gleichwertige Pfad GET /domains/list bewirkt dasselbe (keine Verhaltensänderung, nur eine alternative URL-Form).

Parameter:

• status – optional, Query, String – gibt nur Domains im angegebenen Status zurück; wird er nicht angegeben, werden Domains in allen Status zurückgegeben

Rückgabecodes:

• 1000 – OK
• 2101 – ungültiges Format des Parameters status
• 2242 – unbekannter Domainstatus
• 5001 – es ist niemand angemeldet

Antwortdaten:

• domain – Array der Domains des Kunden; jedes Element enthält:
  • name – Domainname
  • status – Domainstatus

Beispiel:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains?status=active'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": [
      { "name": "domain1.tld", "status": "active" },
      { "name": "domain2.tld", "status": "active" }
    ]
  }
}

GET /domains/{name}

Gibt detaillierte Informationen zu einer Domain anhand ihres Namens im URL-Pfad zurück.

Parameter:

• name – erforderlich, Pfad – Domainname

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiges Parameterformat
• 2201 – nicht unterstützte TLD
• 2202 – ungültiges Format des Domainnamens
• 3216 – Fehler beim Laden der Domaininformationen
• 3222 – das Domainobjekt konnte nicht geladen werden
• 3223 – die Domain liegt in einem anderen Kundenkonto
• 4205 – Verbindungsfehler zur Registry

Antwortdaten:

• domain – Objekt mit Domaininformationen:
  • name – Domainname
  • status – Domainstatus bei der Registry
  • reg_owner, reg_creator, reg_update – Kennungen des Registrars (unsere/fremde)
  • setup_date, expiration, updated_date, transfer_date – Datum der Registrierung/des Ablaufs/der Aktualisierung
  • owner_c, admin_c, tech_c – Kennungen der zugeordneten Kontakte (je Registry)
  • dns.server – Array der konfigurierten DNS-Server (name, addr_ipv4, addr_ipv6)
  • dnssec_keys – konfigurierte DNSSEC-Schlüssel (sofern vorhanden)
  • own_* (own_name, own_company, own_email, own_addr_street, …) – Momentaufnahme der Daten des Inhaberkontakts zum Zeitpunkt der Abfrage

Beispiel:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/domena1.tld'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d5",
  "data": {
    "domain": {
      "name": "domena1.tld",
      "status": "active",
      "reg_owner": "WEDOS",
      "setup_date": "2024-01-10",
      "expiration": "2027-01-10",
      "owner_c": "CONTACT-1",
      "dns": {
        "server": [
          { "name": "ns.wedos.com", "addr_ipv4": null, "addr_ipv6": null },
          { "name": "ns.wedos.org", "addr_ipv4": null, "addr_ipv6": null }
        ]
      },
      "own_name": "Esmeralda Excavadora",
      "own_email": "esmeralda@wedos.com"
    }
  }
}

GET /domains/info

Funktional identisch mit GET /domains/{name}, ermöglicht aber die Abfrage von Informationen zu mehreren Domains auf einmal (durch Kommas getrennte Namen) über einen Query-Parameter.

Parameter:

• name – erforderlich, Query, String – Domainname oder mehrere durch Kommas getrennte Namen (ohne Leerzeichen)

Rückgabecodes:

• 1000 – OK (bei Abfragen mehrerer Domains gibt die API immer diesen Code zurück; das Ergebnis für jede Domain steht in ihrem eigenen Knoten, siehe unten)
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiges Parameterformat
• 2201 – nicht unterstützte TLD
• 2202 – ungültiges Format des Domainnamens
• 3216, 3222, 3223, 4205 – siehe GET /domains/{name}

Antwortdaten:

• Für eine Domain: domain – ein Objekt mit derselben Struktur wie bei GET /domains/{name}
• Für mehrere Domains: domain – ein Array von Objekten, die zusätzlich jeweils code (den Rückgabecode der Verarbeitung für diese Domain) und result (dessen Textbeschreibung) enthalten. Bei einer Sammelabfrage wird der Verarbeitungsstatus je Domain geführt, nicht auf der Ebene der gesamten Antwort.

Beispiel:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/info?name=domain1.tld,domain2.tld'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d6",
  "data": {
    "domain": [
      { "name": "domain1.tld", "status": "active", "expiration": "2027-01-10" },
      { "name": "domain2.tld", "code": 3223, "result": "Domain belongs to another account" }
    ]
  }
}

GET /domains/check

Prüft, ob eine oder mehrere Domains für die Registrierung verfügbar sind (bei uns oder allgemein gemäß der Verfügbarkeit bei der Registry).

Parameter:

• name – erforderlich, Query, String – Domainname oder mehrere durch Kommas getrennte Namen

Rückgabecodes:

• 1000 – die Domain ist für die Registrierung verfügbar (bei Abfragen mehrerer Domains gibt die API immer diesen Code zurück; das Ergebnis für jede Domain steht in ihrem eigenen Knoten, siehe unten)
• 2100 – Parameter name fehlt
• 2101 – ungültiges Parameterformat
• 2201 – nicht unterstützte TLD
• 2202 – ungültiges Format des Domainnamens
• 2250 – Limit der Prüfungen überschritten (gesperrt)
• 2251 – Prüfung des Limits fehlgeschlagen
• 3201 – die Domain ist bereits registriert
• 3203 – die Domain ist nicht verfügbar
• 3204 – die Domain befindet sich in Quarantäne
• 3205 – die Domain ist reserviert
• 3206 – die Domain ist gesperrt (der Grund – Premium/Marke/Reservierung/kurzer Name – steht in der Textbeschreibung)
• 4201 – Prüfung fehlgeschlagen – Verbindungsfehler zur Registry
• weitere Statuscodes, die für die Verfügbarkeitsprüfung spezifisch sind

Antwortdaten:

• Für eine Domain: name – der abgefragte Domainname (das Prüfergebnis steht direkt in der Antwort in den Feldern code/msg)
• Für mehrere Domains: ein Array von Objekten, jeweils mit name, code (das Prüfergebnis für diese Domain) und result (dessen Textbeschreibung)

Beispiel:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/check?name=domain1.tld,domain2.tld'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d7",
  "data": [
    { "name": "domain1.tld", "code": 3201, "result": "Domain is already registered" },
    { "name": "domain2.tld", "code": 1000, "result": "OK" }
  ]
}

GET /domains/{name}/transfer/check

Prüft, ob die Domain von einem anderen Registrar zu uns transferiert werden kann, ohne dass der Autorisierungscode bekannt sein muss.

Parameter:

• name – erforderlich, Pfad – Domainname

Rückgabecodes:

• 1000 – die Domain ist für den Transfer verfügbar
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiges Parameterformat
• 2201 – nicht unterstützte TLD
• 2202 – ungültiges Format des Domainnamens
• 3207 – die Domain ist bereits bei uns registriert
• 3208 – Transfer nicht möglich, der Ablauf ist zu nah
• 3266 – Transfer nicht möglich, die Domain ist abgelaufen
• 4206 – Verbindungsfehler zur Registry

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/domains/domain1.tld/transfer/check'

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

GET /domains/tld-periods

Prüft, ob eine Domain unter der angegebenen TLD für die angegebene Anzahl von Jahren registriert/verlängert werden kann.

Parameter:

• tld – erforderlich, Query, String – TLD (ohne Punkt, z. B. cz)
• period – erforderlich, Query, Integer – gewünschte Periode in Jahren

Rückgabecodes:

• 1000 – OK, die Periode ist für die TLD gültig
• 2100 – Eingabeparameter fehlt
• 2101 – ungültige Eingabeparameter
• 2203 – die Periode ist für die TLD nicht gültig

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/domains/tld-periods?tld=eu&period=1'

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

POST /domains/create

Registriert eine neue Domain. Sie müssen genau einen der Parameter dns oder nsset angeben (zur Einstellung von DNS/NSSET der Domain), niemals beide.

Parameter:

• name – erforderlich, String – Name der zu registrierenden Domain
• period – erforderlich, Integer – Dauer der Registrierung in Jahren
• owner_c – erforderlich, String – Kennung (Handle) des Kontakts des Domaininhabers
• admin_c – optional, String – Kennung des administrativen Kontakts
• dns – optional, 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); schließt sich gegenseitig aus mit nsset
• nsset – optional, String – Handle eines bestehenden NSSETs, das der Domain zugewiesen wird (nur bei Registries, die NSSETs unterstützen, z. B. .cz); schließt sich gegenseitig aus mit dns
• rules – optional, Array – Bestätigung der Zustimmung zu den Registrierungsregeln (nur bei TLDs erforderlich, die dies verlangen)

Rückgabecodes:

• 1000 – OK, Domain registriert
• 1001 – Anfrage angenommen, wird asynchron abgeschlossen
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiges Parameterformat
• 2201 – nicht unterstützte TLD
• 2202 – ungültiges Format des Domainnamens
• 2203 – ungültige Periode
• 2204 – Parameter owner_c fehlt
• 2207 – ungültiges Format des Parameters owner_c
• 2208 – ungültiges Format des Parameters admin_c
• 2209 – Syntaxfehler des NSSETs
• 2210 – Syntaxfehler des DNS-Servers
• 2211 – zu viele DNS-Server
• 2245 – Zustimmung zu den Registrierungsbedingungen nicht erteilt
• 3001 – ungültige Währung
• 3002 – nicht ausreichendes Guthaben
• 3211 – Kontakt owner_c nicht verfügbar
• 3212 – Kontakt admin_c nicht verfügbar
• 3221 – Anlegen der Domain fehlgeschlagen
• 4002 – Abbuchung des Guthabens vom Konto fehlgeschlagen
• weitere Fehlercodes, die für die Domainregistrierung spezifisch sind

Antwortdaten:

• num – Bestellnummer
• expiration – Ablaufdatum der Domain
• credit – Guthabenstand nach der Zahlung

Beispiel:

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

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e1",
  "data": {
    "num": "202610010001",
    "expiration": "2027-10-01",
    "credit": "1234.50"
  }
}

POST /domains/{name}/renew

Verlängert die Domainregistrierung um die angegebene Anzahl von Jahren. Bei .eu-Domains ist dies nicht möglich – sie werden automatisch verlängert.

Parameter:

• name – erforderlich, Pfad – Domainname
• period – erforderlich, Integer – Anzahl der Jahre für die Verlängerung

Rückgabecodes:

• 1000 – OK
• 1001 – Anfrage angenommen, wird asynchron abgeschlossen
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiges Parameterformat
• 2201 – nicht unterstützte TLD
• 2203 – ungültige Periode
• 2269 – es existiert bereits eine unbezahlte (neue) Periode
• 3001 – ungültige Währung
• 3002 – nicht ausreichendes Guthaben
• 3222 – die Domain konnte nicht geöffnet werden
• 3223 – die Domain gehört nicht zu diesem Kundenkonto
• 3224 – Verlängerung der Domain fehlgeschlagen
• 3265 – die Domain kann jetzt nicht verlängert werden – die Anzahl der Tage bis zum Ablauf überschreitet das zulässige Limit
• 4208 – Verlängerung fehlgeschlagen – Verbindungsfehler

Antwortdaten:

• num – Bestellnummer
• expiration – neues Ablaufdatum der Domain
• credit – Guthabenstand nach der Zahlung

Beispiel:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/domains/domain1.tld/renew' \
  --data '{"period": 1}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e2",
  "data": {
    "num": "202610010002",
    "expiration": "2028-10-01",
    "credit": "1134.50"
  }
}

POST /domains/{name}/transfer

Transferiert eine Domain von einem anderen Registrar zu uns. Der Parameter dns funktioniert wie folgt: Ist er in der Anfrage überhaupt nicht enthalten, werden die aktuellen Einstellungen der DNS-Server der Domain automatisch übernommen; false oder ein leeres Array setzt die Standardserver von WEDOS; ein Array von Objekten setzt konkrete Server.

Parameter:

• name – erforderlich, Pfad – Domainname
• auth_info – erforderlich, String – Autorisierungscode (Transfercode) der Domain
• owner_c – optional, String – Kennung des Inhaberkontakts (nur bei TLDs erforderlich, bei denen die Registry dies verlangt)
• dns – optional, Array – Array von DNS-Servern in derselben Form wie bei POST /domains/create
• rules – optional, Array – Bestätigung der Zustimmung zu den Regeln (nur bei TLDs, die dies verlangen)

Rückgabecodes:

• 1000 – Transfer erfolgreich abgeschlossen
• 1001 – Anfrage angenommen, wird asynchron ausgeführt
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiges Parameterformat
• 2201 – nicht unterstützte TLD
• 2202 – ungültiges Format des Domainnamens
• 2204 – Kennung des Inhaberkontakts fehlt
• 2207 – ungültige Kennung des Inhaberkontakts
• 2210 – ungültiges Format des DNS-Servers
• 2215 – auth_info fehlt, ist aber für diese TLD erforderlich
• 3001 – ungültige Währung
• 3207 – die Domain ist bereits bei uns registriert
• 3208 – Transfer nicht möglich, der Ablauf ist zu nah
• 3219 – für diese Domain existiert bereits eine offene Transferanfrage
• 3220 – die Domain ist bereits in unseren Aufzeichnungen
• 3226 – Transfer der Domain fehlgeschlagen
• 3227 – Autorisierungsfehler bei der Registry der Domain
• 3266 – Transfer nicht möglich, die Domain ist abgelaufen
• weitere Fehlercodes, die für den Domaintransfer spezifisch sind

Antwortdaten:

• num – Bestellnummer
• expiration – Ablaufdatum der Domain
• credit – Guthabenstand nach der Zahlung

Beispiel:

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

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3e3",
  "data": {
    "num": "202610010003",
    "expiration": "2027-10-01",
    "credit": "1134.50"
  }
}

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

Sendet den Autorisierungscode (Transfercode) der Domain an die E-Mail-Adresse des Kontakts des Domaininhabers.

Parameter:

• name – erforderlich, Pfad – Domainname

Rückgabecodes:

• 1000 – OK, Autorisierungscode an die E-Mail-Adresse des Domaininhabers gesendet
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiges Parameterformat
• 2201 – nicht unterstützte TLD
• 2202 – ungültiges Format des Domainnamens
• 2243 – das Senden des Autorisierungscodes ist für diese Domain nicht erlaubt
• 3209 – das Senden des Autorisierungscodes ist fehlgeschlagen
• 3210 – Senden fehlgeschlagen – die Domain ist nicht verfügbar
• 3222 – die Domain konnte nicht geladen werden
• 3223 – die Domain gehört nicht zu diesem Kundenkonto
• 4214 – Senden fehlgeschlagen – Verbindungsfehler

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

Beispiel:

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/domains/domain1.cz/auth-info/send'

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

PATCH /domains/{name}/nsset/update

Setzt neue DNS-Server für die Domain oder verknüpft sie mit einem bestehenden NSSET. Sie müssen genau einen der Parameter dns oder nssetangeben, niemals beide.

Parameter:

• name – erforderlich, Pfad – Domainname
• dns – optional, Array – Array von DNS-Servern in derselben Form wie bei POST /domains/create; schließt sich gegenseitig aus mit nsset
• nsset – optional, String – Handle eines bestehenden NSSETs; schließt sich gegenseitig aus mit dns

Rückgabecodes:

• 1000 – OK
• 1001 – OK, asynchron ausgeführt
• 2100 – erforderlicher Parameter fehlt (weder dns noch nsset angegeben)
• 2101 – ungültige Parameter (sowohl dns und nsset angegeben, oder ungültiges Format)
• 2201 – nicht unterstützte TLD
• 2202 – ungültiger Domainname
• 2209 – Syntaxfehler des NSSETs
• 2210 – Syntaxfehler des DNS-Servers
• 2211 – zu viele DNS-Server
• 3214 – NSSET nicht verfügbar
• 3222 – die Domain konnte nicht geöffnet werden
• 3223 – die Domain gehört zu einem anderen Kundenkonto
• 3225 – Aktualisierung von DNS/NSSET fehlgeschlagen
• 3315 – für die Domain sind bereits identische NS-Server eingestellt
• 4204 – Verbindungsfehler (NSSET)
• 4210 – Verbindungsfehler (DNS)

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/domains/domain1.tld/nsset/update' \
  --data '{
    "dns": [
      { "name": "ns.wedos.com" },
      { "name": "ns.wedos.org" }
    ]
  }'

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

PATCH /domains/{name}/keyset/update

Setzt, deaktiviert oder wechselt DNSSEC für die Domain.

Parameter:

• name – erforderlich, Pfad – Domainname
• keyset – erforderlich – Einstellung des DNSSEC:
  • 0 – DNSSEC deaktiviert
  • 1 – von WEDOS verwaltetes DNSSEC
  • beliebiger anderer String – Handle des eigenen KEYSETs des Kunden

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiges Parameterformat
• 2201 – nicht unterstützte TLD
• 2202 – ungültiges Format des Domainnamens
• weitere Fehlercodes, die für die DNSSEC-Einstellung spezifisch sind

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/domains/domain1.tld/keyset/update' \
  --data '{"keyset": 1}'

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