REST API – NSSET-y domen

GET /nssets/check

Sprawdza, czy handle NSSET-u jest wolny do użycia i jaki ma status w rejestrze.

Parametry:

• tld – wymagany, query, string – TLD, dla której sprawdzany jest NSSET
• name – wymagany, query, string – handle NSSET-u
• reg_key – opcjonalny, query, string – identyfikator konkretnego rejestru

Kody zwrotne:

• 1000 – NSSET jest dostępny do rejestracji
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowe parametry wejściowe
• 2201 – nieprawidłowa TLD
• 2247 – nieobsługiwany format NSSET-u
• 3242 – NSSET jest niedostępny
• 3245 – NSSET jest już zarejestrowany
• 3248 – NSSET niedostępny – kwarantanna
• 3249 – NSSET niedostępny – zarezerwowany
• 3250 – NSSET niedostępny – zablokowany
• 3251 – NSSET jest już zarejestrowany u nas
• 4218 – sprawdzenie nie powiodło się – błąd komunikacji
• 5001 – wewnętrzny błąd uwierzytelnienia

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/nssets/check?tld=cz&name=NSSET'

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

GET /nssets/{name}

Zwraca szczegółowe informacje o NSSET-cie wraz z jego serwerami DNS.

Parametry:

• name – wymagany, path – handle NSSET-u
• tld – wymagany, query, string – TLD
• reg_key – opcjonalny, query, string – identyfikator konkretnego rejestru

Kody zwrotne:

• 1000 – OK
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowe parametry wejściowe
• 2201 – nieprawidłowa TLD
• 2209 – błąd składni
• 2247 – nieobsługiwany format NSSET-u
• 3214 – nie udało się wczytać NSSET-u
• 3242 – NSSET jest niedostępny
• 4204 – błąd połączenia

Dane odpowiedzi:

• nsset – obiekt z danymi NSSET-u:
  • name – handle NSSET-u
  • status – status NSSET-u w rejestrze
  • reg_owner, reg_creator, reg_update – identyfikatory rejestratora
  • created_date, updated_date, transfer_date – daty utworzenia/aktualizacji/transferu
  • tech_c – identyfikator kontaktu technicznego
  • dns.server – tablica serwerów DNS NSSET-u (name, addr_ipv4, addr_ipv6)

Przykład:

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

Tworzy nowy NSSET.

Parametry:

• tld – wymagany, string – TLD, dla której tworzony jest NSSET
• name – opcjonalny, string – żądany handle NSSET-u; jeśli nie zostanie podany, jest generowany automatycznie
• dns – wymagany, 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; ta sama postać co w POST /domains/create)
• tech_c – opcjonalny, string – identyfikator kontaktu technicznego; jeśli nie zostanie podany, używany jest domyślny
• reg_key – opcjonalny, string – identyfikator konkretnego rejestru

Kody zwrotne:

• 1000 – OK, NSSET utworzony
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowy format parametru wejściowego
• 2201 – nieprawidłowo podana TLD
• 2210 – nieprawidłowy format tablicy serwerów DNS
• 2211 – zbyt wiele serwerów DNS
• 2216 – nieprawidłowa składnia kontaktu
• 2247 – nieobsługiwany format NSSET-u
• 3228 – rejestr nie obsługuje kontaktów
• 3229 – błąd wczytywania kontaktu
• 3242 – NSSET jest niedostępny
• 3244 – utworzenie NSSET-u nie powiodło się
• 3245 – NSSET jest już zarejestrowany
• 4212 – błąd połączenia
• 4218, 4219 – sprawdzenie/utworzenie nie powiodło się – błąd komunikacji

Dane odpowiedzi:

• nsset – handle utworzonego NSSET-u

Przykład:

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

Przenosi NSSET do nas od innego rejestratora.

Parametry:

• name – wymagany, path – handle NSSET-u
• tld – wymagany, string – TLD
• auth_info – wymagany, string – kod autoryzacyjny NSSET-u
• reg_key – opcjonalny, string – identyfikator konkretnego rejestru

Kody zwrotne:

• 1000 – OK
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowe parametry wejściowe
• 2201 – nieobsługiwana TLD
• 2215 – auth_info nie został podany
• 2247 – nieprawidłowa nazwa NSSET-u
• 2249 – transfer NSSET-u nie jest dozwolony dla tej TLD
• 3214 – nie udało się wczytać NSSET-u
• 3242 – NSSET nie jest obsługiwany
• 3251 – NSSET jest już zarejestrowany u docelowego rejestratora
• 3255 – błąd autoryzacji
• 3256 – transfer NSSET-u nie powiódł się
• 4221 – transfer nie powiódł 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>' -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

Wysyła kod autoryzacyjny NSSET-u na adres e-mail kontaktu technicznego.

Parametry:

• name – wymagany, path – handle NSSET-u
• tld – wymagany, string – TLD
• reg_key – opcjonalny, string – identyfikator konkretnego rejestru

Kody zwrotne:

• 1000 – OK, kod autoryzacyjny wysłany na adres e-mail kontaktu
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowe parametry wejściowe
• 2201 – nieobsługiwana TLD
• 2243 – wysłanie kodu autoryzacyjnego nie jest dozwolone dla tego NSSET-u
• 3214 – nie udało się wczytać NSSET-u
• 3217 – wysłanie kodu autoryzacyjnego nie powiodło się
• 3242 – NSSET jest niedostępny
• 4222 – wysłanie nie powiodło się – błąd połączenia
• 5001 – wewnętrzny błąd autoryzacji

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

Przykład:

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}

Modyfikuje istniejący NSSET – jego serwery DNS, kontakt techniczny lub zakres testów.

Parametry:

• name – wymagany, path – handle NSSET-u
• tld – wymagany, string – TLD
• dns – wymagany, array – tablica serwerów DNS w tej samej postaci co w POST /nssets
• auth_info – wymagany, string – kod autoryzacyjny NSSET-u
• tech_c – opcjonalny, string – identyfikator kontaktu technicznego; jeśli nie zostanie podany, pozostaje bez zmian
• reg_key – opcjonalny, string – identyfikator konkretnego rejestru
• report_level – opcjonalny – zakres testów wykonywanych przez rejestr podczas modyfikacji

Kody zwrotne:

• 1000 – OK
• 2100 – brak wymaganego parametru
• 2101 – nieprawidłowe parametry wejściowe
• 2201 – nieprawidłowo podana TLD
• 2209 – błąd składni
• 2210 – nieprawidłowy format tablicy serwerów DNS
• 2211 – zbyt wiele serwerów DNS
• 2216 – nieprawidłowa składnia kontaktu
• 2247 – nieprawidłowy NSSET
• 3214 – nie udało się wczytać NSSET-u
• 3242 – NSSET nie jest obsługiwany przez tę domenę/ten rejestr
• 3252 – błąd autoryzacji
• 3254 – modyfikacja NSSET-u nie powiodła się
• 4204, 4220 – NSSET niedostępny/modyfikacja nie powiodła się – błąd połączenia
• 4212 – kontakt niedostępny – błąd połączenia

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