REST API – Domeny

GET /domains

Zwraca listę wszystkich domen zalogowanego klienta, opcjonalnie filtrowaną według statusu. Równoważna ścieżka GET /domains/list działa tak samo (bez zmiany zachowania, to tylko alternatywna postać adresu URL).

Parametry:

• status – opcjonalny, query, string – zwraca tylko domeny o podanym statusie; jeśli nie zostanie podany, zwracane są domeny we wszystkich statusach

Kody zwrotne:

• 1000 – OK
• 2101 – nieprawidłowy format parametru status
• 2242 – nieznany status domeny
• 5001 – nikt nie jest zalogowany

Dane odpowiedzi:

• domain – tablica domen klienta; każdy element zawiera:
  • name – nazwa domeny
  • status – status domeny

Przykład:

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}

Zwraca szczegółowe informacje o jednej domenie na podstawie jej nazwy w ścieżce adresu URL.

Parametry:

• name – wymagany, path – nazwa domeny

Kody zwrotne:

• 1000 – OK
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowy format parametru
• 2201 – nieobsługiwana TLD
• 2202 – nieprawidłowy format nazwy domeny
• 3216 – błąd wczytywania informacji o domenie
• 3222 – nie udało się wczytać obiektu domeny
• 3223 – domena znajduje się na innym koncie klienta
• 4205 – błąd połączenia z rejestrem

Dane odpowiedzi:

• domain – obiekt z informacjami o domenie:
  • name – nazwa domeny
  • status – status domeny w rejestrze
  • reg_owner, reg_creator, reg_update – identyfikatory rejestratora (nasz/inny)
  • setup_date, expiration, updated_date, transfer_date – daty rejestracji/wygaśnięcia/aktualizacji
  • owner_c, admin_c, tech_c – identyfikatory powiązanych kontaktów (zależnie od rejestru)
  • dns.server – tablica skonfigurowanych serwerów DNS (name, addr_ipv4, addr_ipv6)
  • dnssec_keys – skonfigurowane klucze DNSSEC (jeśli istnieją)
  • own_* (own_name, own_company, own_email, own_addr_street, …) – migawka danych kontaktu właściciela w chwili zapytania

Przykład:

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

Funkcjonalnie to samo co GET /domains/{name}, ale pozwala pobrać informacje o kilku domenach naraz (nazwy oddzielone przecinkami) za pomocą parametru zapytania.

Parametry:

• name – wymagany, query, string – nazwa domeny lub kilka nazw oddzielonych przecinkami (bez spacji)

Kody zwrotne:

• 1000 – OK (przy zapytaniach o wiele domen API zawsze zwraca ten kod; wynik dla każdej domeny znajduje się w jej własnym węźle, patrz niżej)
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowy format parametru
• 2201 – nieobsługiwana TLD
• 2202 – nieprawidłowy format nazwy domeny
• 3216, 3222, 3223, 4205 – patrz GET /domains/{name}

Dane odpowiedzi:

• Dla jednej domeny: domain – obiekt o tej samej strukturze co GET /domains/{name}
• Dla kilku domen: domain – tablica obiektów, z których każdy zawiera dodatkowo code (kod zwrotny przetwarzania dla tej domeny) oraz result (jego opis tekstowy). W zapytaniu zbiorczym status przetwarzania jest śledzony dla każdej domeny osobno, a nie na poziomie całej odpowiedzi.

Przykład:

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

Sprawdza, czy jedna lub więcej domen jest dostępnych do rejestracji (u nas lub ogólnie według dostępności w rejestrze).

Parametry:

• name – wymagany, query, string – nazwa domeny lub kilka nazw oddzielonych przecinkami

Kody zwrotne:

• 1000 – domena jest dostępna do rejestracji (przy zapytaniach o wiele domen API zawsze zwraca ten kod; wynik dla każdej domeny znajduje się w jej własnym węźle, patrz niżej)
• 2100 – parametr name nie został podany
• 2101 – nieprawidłowy format parametru
• 2201 – nieobsługiwana TLD
• 2202 – nieprawidłowy format nazwy domeny
• 2250 – przekroczono limit sprawdzeń (zablokowano)
• 2251 – sprawdzenie limitu nie powiodło się
• 3201 – domena jest już zarejestrowana
• 3203 – domena jest niedostępna
• 3204 – domena jest w kwarantannie
• 3205 – domena jest zarezerwowana
• 3206 – domena jest zablokowana (powód – premium/znak towarowy/rezerwacja/krótka nazwa – jest podany w opisie tekstowym)
• 4201 – sprawdzenie nie powiodło się – błąd połączenia z rejestrem
• inne kody statusu specyficzne dla sprawdzania dostępności

Dane odpowiedzi:

• Dla jednej domeny: name – zapytana nazwa domeny (wynik sprawdzenia znajduje się bezpośrednio w polach odpowiedzi code/msg)
• Dla kilku domen: tablica obiektów, każdy z polami name, code (wynik sprawdzenia dla tej domeny) oraz result (jego opis tekstowy)

Przykład:

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

Sprawdza, czy domenę można przenieść do nas od innego rejestratora, bez konieczności znajomości kodu autoryzacyjnego.

Parametry:

• name – wymagany, path – nazwa domeny

Kody zwrotne:

• 1000 – domena jest dostępna do transferu
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowy format parametru
• 2201 – nieobsługiwana TLD
• 2202 – nieprawidłowy format nazwy domeny
• 3207 – domena jest już zarejestrowana u nas
• 3208 – nie można przenieść, ponieważ data wygaśnięcia jest zbyt bliska
• 3266 – nie można przenieść, domena wygasła
• 4206 – błąd połączenia z rejestrem

Dane odpowiedzi: Brak – wynik przekazują bezpośrednio pola odpowiedzi code/msg.

Przykład:

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

Sprawdza, czy domenę w podanej TLD można zarejestrować/przedłużyć na podaną liczbę lat.

Parametry:

• tld – wymagany, query, string – TLD (bez kropki, np. cz)
• period – wymagany, query, integer – żądany okres w latach

Kody zwrotne:

• 1000 – OK, okres jest prawidłowy dla danej TLD
• 2100 – brak parametru wejściowego
• 2101 – nieprawidłowe parametry wejściowe
• 2203 – okres nie jest prawidłowy dla danej TLD

Dane odpowiedzi: Brak – wynik przekazują bezpośrednio pola odpowiedzi code/msg.

Przykład:

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

Rejestruje nową domenę. Należy podać dokładnie jeden z parametrów dns lub nsset (ustawienie DNS/NSSET domeny), nigdy obu naraz.

Parametry:

• name – wymagany, string – nazwa rejestrowanej domeny
• period – wymagany, integer – długość rejestracji w latach
• owner_c – wymagany, string – identyfikator (handle) kontaktu właściciela domeny
• admin_c – opcjonalny, string – identyfikator kontaktu administracyjnego
• dns – opcjonalny, array – tablica serwerów DNS w postaci [{"name":"ns1.example.com","addr_ipv4":"1.2.3.4","addr_ipv6":"..."},...] (addr_ipv4/addr_ipv6 są opcjonalne dla każdego serwera); wzajemnie wykluczający się z nsset
• nsset – opcjonalny, string – handle istniejącego NSSET-u do przypisania do domeny (tylko dla rejestrów obsługujących NSSET-y, np. .cz); wzajemnie wykluczający się z dns
• rules – opcjonalny, array – potwierdzenie zgody na zasady rejestracji (wymagane tylko dla TLD, które tego wymagają)

Kody zwrotne:

• 1000 – OK, domena zarejestrowana
• 1001 – żądanie przyjęte, zostanie dokończone asynchronicznie
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowy format parametru
• 2201 – nieobsługiwana TLD
• 2202 – nieprawidłowy format nazwy domeny
• 2203 – nieprawidłowy okres
• 2204 – parametr owner_c nie został podany
• 2207 – nieprawidłowy format parametru owner_c
• 2208 – nieprawidłowy format parametru admin_c
• 2209 – błąd składni NSSET
• 2210 – błąd składni serwera DNS
• 2211 – zbyt wiele serwerów DNS
• 2245 – nie udzielono zgody na warunki rejestracji
• 3001 – nieprawidłowa waluta
• 3002 – niewystarczające środki na koncie
• 3211 – kontakt owner_c jest niedostępny
• 3212 – kontakt admin_c jest niedostępny
• 3221 – nie udało się utworzyć domeny
• 4002 – nie udało się pobrać środków z konta
• inne kody błędów specyficzne dla rejestracji domeny

Dane odpowiedzi:

• num – numer zamówienia
• expiration – data wygaśnięcia domeny
• credit – stan konta kredytowego po zapłacie

Przykład:

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

Przedłuża rejestrację domeny o podaną liczbę lat. Nie dotyczy to domen .eu – przedłużają się automatycznie.

Parametry:

• name – wymagany, path – nazwa domeny
• period – wymagany, integer – liczba lat przedłużenia

Kody zwrotne:

• 1000 – OK
• 1001 – żądanie przyjęte, zostanie dokończone asynchronicznie
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowy format parametru
• 2201 – nieobsługiwana TLD
• 2203 – nieprawidłowy okres
• 2269 – istnieje już nieopłacony (nowy) okres
• 3001 – nieprawidłowa waluta
• 3002 – niewystarczające środki na koncie
• 3222 – nie udało się otworzyć domeny
• 3223 – domena nie należy do tego konta klienta
• 3224 – nie udało się przedłużyć domeny
• 3265 – domeny nie można teraz przedłużyć – liczba dni do wygaśnięcia przekracza dozwolony limit
• 4208 – przedłużenie nie powiodło się – błąd połączenia

Dane odpowiedzi:

• num – numer zamówienia
• expiration – nowa data wygaśnięcia domeny
• credit – stan konta kredytowego po zapłacie

Przykład:

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

Przenosi domenę do nas od innego rejestratora. Parametr dns działa następująco: jeśli w ogóle nie zostanie zawarty w żądaniu, bieżące ustawienia serwerów DNS domeny są przejmowane automatycznie; false lub pusta tablica ustawia domyślne serwery WEDOS; tablica obiektów ustawia konkretne serwery.

Parametry:

• name – wymagany, path – nazwa domeny
• auth_info – wymagany, string – kod autoryzacyjny domeny (kod transferowy)
• owner_c – opcjonalny, string – identyfikator kontaktu właściciela (wymagany tylko dla TLD, dla których rejestr tego wymaga)
• dns – opcjonalny, array – tablica serwerów DNS w tej samej postaci co w POST /domains/create
• rules – opcjonalny, array – potwierdzenie zgody na zasady (tylko dla TLD, które tego wymagają)

Kody zwrotne:

• 1000 – transfer zakończony pomyślnie
• 1001 – żądanie przyjęte, zostanie wykonane asynchronicznie
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowy format parametru
• 2201 – nieobsługiwana TLD
• 2202 – nieprawidłowy format nazwy domeny
• 2204 – brak identyfikatora kontaktu właściciela
• 2207 – nieprawidłowy identyfikator kontaktu właściciela
• 2210 – nieprawidłowy format serwera DNS
• 2215 – auth_info nie został podany, a jest wymagany dla tej TLD
• 3001 – nieprawidłowa waluta
• 3207 – domena jest już zarejestrowana u nas
• 3208 – nie można przenieść, ponieważ data wygaśnięcia jest zbyt bliska
• 3219 – istnieje oczekujące żądanie transferu tej domeny
• 3220 – domena jest już w naszej ewidencji
• 3226 – transfer domeny nie powiódł się
• 3227 – błąd autoryzacji w rejestrze domen
• 3266 – nie można przenieść, domena wygasła
• inne kody błędów specyficzne dla transferu domeny

Dane odpowiedzi:

• num – numer zamówienia
• expiration – data wygaśnięcia domeny
• credit – stan konta kredytowego po zapłacie

Przykład:

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

Wysyła kod autoryzacyjny domeny (kod transferowy) na adres e-mail kontaktu właściciela domeny.

Parametry:

• name – wymagany, path – nazwa domeny

Kody zwrotne:

• 1000 – OK, kod autoryzacyjny wysłany na adres e-mail właściciela domeny
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowy format parametru
• 2201 – nieobsługiwana TLD
• 2202 – nieprawidłowy format nazwy domeny
• 2243 – wysłanie kodu autoryzacyjnego nie jest dozwolone dla tej domeny
• 3209 – wysłanie kodu autoryzacyjnego nie powiodło się
• 3210 – wysłanie nie powiodło się – domena jest niedostępna
• 3222 – nie udało się wczytać domeny
• 3223 – domena nie należy do tego konta klienta
• 4214 – wysłanie nie powiodło się – błąd połączenia

Dane odpowiedzi: Brak – wynik przekazują bezpośrednio pola odpowiedzi code/msg.

Przykład:

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

Ustawia nowe serwery DNS dla domeny lub łączy ją z istniejącym NSSET-em. Należy podać dokładnie jeden z parametrów dns lub nsset, nigdy obu naraz.

Parametry:

• name – wymagany, path – nazwa domeny
• dns – opcjonalny, array – tablica serwerów DNS w tej samej postaci co w POST /domains/create; wzajemnie wykluczający się z nsset
• nsset – opcjonalny, string – handle istniejącego NSSET-u; wzajemnie wykluczający się z dns

Kody zwrotne:

• 1000 – OK
• 1001 – OK, wykonano asynchronicznie
• 2100 – brak wymaganego parametru (nie podano ani dns ani nsset )
• 2101 – nieprawidłowe parametry (podano jednocześnie dns i nsset lub nieprawidłowy format)
• 2201 – nieobsługiwana TLD
• 2202 – nieprawidłowa nazwa domeny
• 2209 – błąd składni NSSET
• 2210 – błąd składni serwera DNS
• 2211 – zbyt wiele serwerów DNS
• 3214 – NSSET niedostępny
• 3222 – nie udało się otworzyć domeny
• 3223 – domena należy do innego konta klienta
• 3225 – aktualizacja DNS/NSSET nie powiodła się
• 3315 – dla domeny są już ustawione identyczne serwery NS
• 4204 – błąd połączenia (NSSET)
• 4210 – błąd połączenia (DNS)

Dane odpowiedzi: Brak – wynik przekazują bezpośrednio pola odpowiedzi code/msg.

Przykład:

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

Ustawia, wyłącza lub przełącza DNSSEC dla domeny.

Parametry:

• name – wymagany, path – nazwa domeny
• keyset – wymagany – ustawienie DNSSEC:
  • 0 – DNSSEC wyłączony
  • 1 – DNSSEC zarządzany przez WEDOS
  • dowolny inny ciąg – handle własnego KEYSET-u klienta

Kody zwrotne:

• 1000 – OK
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowy format parametru
• 2201 – nieobsługiwana TLD
• 2202 – nieprawidłowy format nazwy domeny
• inne kody błędów specyficzne dla ustawień DNSSEC

Dane odpowiedzi: Brak – wynik przekazują bezpośrednio pola odpowiedzi code/msg.

Przykład:

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