REST - DNS

Listowanie domen

Zapytanie

GET /v2/dns

Zwraca tablicę z listą istniejących domen wraz ze wszystkimi rekordami należącymi do tych domen.

Odpowiedź

{
  "id": "$domain_id",
  "name": "$name",
  "records": [
    {
      "record_id": "$record_id",
      "record_name": "$record_name",
      "record_type": "$record_type",
      "record_prio": "$record_prio",
      "record_ttl": "$record_ttl",
      "record_value": "$record_value",
      //lub zamiast record_value
      "lbr_type": "$lbr_type",
      "lbr_ips":  "$lbr_ips",
      "lbr_port": "$lbr_port",
      "lbr_url": "$lbr_url"
    }, { ... }
  ]
}

Zwracane informacje

  • $domain_id (int) - ID domeny
  • $name (string) - nazwa domeny
  • $record_id (int) - ID rekordu domeny
  • $record_name (string) - nazwa rekordu
  • $record_type (string) - typ rekordu A,AAAA,CAA,CNAME,MX,NS,PTR,SRV,TXT
  • $record_prio (int) - priorytet rekordu
  • $record_ttl (int) - czas przechowywania rekordu w pamięci podręcznej DNS
  • $record_value (string) - wartość rekordu DNS
  • $lbr_type (string) - typ load balancera DNS spdns_rec (sprawdzanie portu), spdns_url (sprawdzanie URL), pickrandom (wybór losowego serwera), jeśli to pole jest podane wartość pola $record_value jest ignorowana
  • $lbr_ips (string) - numery IP dla weryfikacji stanu serwera dla load balancera DNS
  • $lbr_port (int) - numer portu dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli lbr_type=spdns_rec
  • $lbr_url (string) - URL dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli lbr_type=spdns_url


Dodanie domeny

Zapytanie

PUT /v2/dns

Dodaje nową domenę.

Zawartość zapytania

{
    "name": "$name",
    "ip_address": "$ip_address"
}

Opis parametrów

  • $name (string) - domena
  • $ip_address (string) - parametr opcjonalny, dodanie adresu IP od razu stworzy rekord A

Odpowiedź

{
  "id": "$domain_id",
  "name": "$name",
  "records": [
    {
      "record_id": "$record_id",
      "record_name": "$record_name",
      "record_type": "$record_type",
      "record_prio": "$record_prio",
      "record_ttl": "$record_ttl",
      "record_value": "$record_value",
      //lub zamiast record_value
      "lbr_type": "$lbr_type",
      "lbr_ips":  "$lbr_ips",
      "lbr_port": "$lbr_port",
      "lbr_url": "$lbr_url"
    }
  ]
}

Zwracane informacje

  • $domain_id (int) - ID domeny
  • $name (string) - nazwa domeny
  • $record_id (int) - ID rekordu domeny
  • $record_name (string) - nazwa rekordu
  • $record_type (string) - typ rekordu A,AAAA,CAA,CNAME,MX,NS,PTR,SRV,TXT
  • $record_prio (int) - priorytet rekordu
  • $record_ttl (int) - czas przechowywania rekordu w pamięci podręcznej DNS
  • $record_value (string) - wartość rekordu DNS
  • $lbr_type (string) - typ load balancera DNS spdns_rec (sprawdzanie portu), spdns_url (sprawdzanie URL), pickrandom (wybór losowego serwera), jeśli to pole jest podane wartość pola $record_value jest ignorowana
  • $lbr_ips (string) - numery IP dla weryfikacji stanu serwera dla load balancera DNS
  • $lbr_port (int) - numer portu dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli $lbr_type=spdns_rec
  • $lbr_url (string) - URL dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli $lbr_type=spdns_url


Dodanie rekordu

Zapytanie

PUT /v2/dns/$DOMAIN_ID

Dodaje rekord do domeny $DOMAIN_ID.

Zawartość zapytania

{
    "record_name": "$record_name",
    "record_type": "$record_type",
    "record_priority": "$record_priority",
    "record_ttl": "$record_ttl",
    "record_value": "$record_value",
    //lub zamiast record_value
    "lbr_type": "$lbr_type",
    "lbr_ips":  "$lbr_ips",
    "lbr_port": "$lbr_port",
    "lbr_url": "$lbr_url"
}

Opis parametrów

  • $record_name (string) - nazwa rekordu
  • $record_type (string) - typ rekordu A,AAAA,CAA,CNAME,MX,NS,PTR,SRV,TXT
  • $record_priority (int) - priorytet rekordu
  • $record_ttl (int) - czas przechowywania rekordu w pamięci podręcznej DNS
  • $record_value (string) - wartość rekordu DNS
  • $lbr_type (string) - typ load balancera DNS spdns_rec (sprawdzanie portu), spdns_url (sprawdzanie URL), pickrandom (wybór losowego serwera), jeśli to pole jest podane wartość pola $record_value jest ignorowana
  • $lbr_ips (string) - numery IP dla weryfikacji stanu serwera dla load balancera DNS
  • $lbr_port (int) - numer portu dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli lbr_type=spdns_rec
  • $lbr_url (string) - URL dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli lbr_type=spdns_url

Pola $lbr_* są dostępne tylko dla $record_type A lub AAAA.

Odpowiedź

{
  "id": "$domain_id",
  "name": "$name",
  "records": [
    {
      "record_id": "$record_id",
      "record_name": "$record_name",
      "record_type": "$record_type",
      "record_prio": "$record_prio",
      "record_ttl": "$record_ttl",
      "record_value": "$record_value",
      //lub zamiast record_value
      "lbr_type": "$lbr_type",
      "lbr_ips":  "$lbr_ips",
      "lbr_port": "$lbr_port",
      "lbr_url": "$lbr_url"
    }
  ]
}

Zwracane informacje

  • $record_id (int) - ID rekordu domeny
  • $record_name (string) - nazwa rekordu
  • $record_type (string) - typ rekordu A,AAAA,CAA,CNAME,MX,NS,PTR,SRV,TXT.
  • $record_prio (int) - priorytet rekordu
  • $record_ttl (int) - czas przechowywania rekordu w pamięci podręcznej DNS
  • $record_value (string) - wartość rekordu DNS
  • $lbr_type (string) - typ load balancera DNS spdns_rec (sprawdzanie portu), spdns_url (sprawdzanie URL), pickrandom (wybór losowego serwera), jeśli to pole jest podane wartość pola $record_value jest ignorowana
  • $lbr_ips (string) - numery IP dla weryfikacji stanu serwera dla load balancera DNS
  • $lbr_port (int) - numer portu dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli lbr_type=spdns_rec
  • $lbr_url (string) - URL dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli lbr_type=spdns_url


Edycja rekordu do domeny

Zapytanie

POST /v2/dns/$RECORD_ID/record

Edycja danych rekordu $RECORD_ID.

Zawartość zapytania

{
    "record_name": "$record_name",
    "record_type": "$record_type",
    "record_priority": "$record_priority",
    "record_ttl": "$record_ttl",
    "record_value": "$record_value",
    //lub zamiast record_value
    "lbr_type": "$lbr_type",
    "lbr_ips":  "$lbr_ips",
    "lbr_port": "$lbr_port",
    "lbr_url": "$lbr_url"
}

Opis parametrów

  • $record_name (string) - nazwa rekordu
  • $record_type (string) - typ rekordu A,AAAA,CAA,CNAME,MX,NS,PTR,SRV,TXT
  • $record_priority (int) - priorytet rekordu
  • $record_ttl (int) - czas przechowywania rekordu w pamięci podręcznej DNS
  • $record_value (string) - wartość rekordu DNS
  • $lbr_type (string) - typ load balancera DNS spdns_rec (sprawdzanie portu), spdns_url (sprawdzanie URL), pickrandom (wybór losowego serwera), jeśli to pole jest podane wartość pola $record_value jest ignorowana
  • $lbr_ips (string) - numery IP dla weryfikacji stanu serwera dla load balancera DNS
  • $lbr_port (int) - numer portu dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli lbr_type=spdns_rec
  • $lbr_url (string) - URL dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli lbr_type=spdns_url

Pola $lbr_* są dostępne tylko dla $record_type A lub AAAA.

Odpowiedź

{
  "id": "$domain_id",
  "name": "$name",
  "records": [
    {
      "record_id": "$record_id",
      "record_name": "$record_name",
      "record_type": "$record_type",
      "record_prio": "$record_prio",
      "record_ttl": "$record_ttl",
      "record_value": "$record_value",
      //lub zamiast record_value
      "lbr_type": "$lbr_type",
      "lbr_ips":  "$lbr_ips",
      "lbr_port": "$lbr_port",
      "lbr_url": "$lbr_url"
    }
  ]
}

Zwracane informacje

  • $record_id (int) - ID rekordu domeny
  • $record_name (string) - nazwa rekordu
  • $record_type (string) - typ rekordu A,AAAA,CAA,CNAME,MX,NS,PTR,SRV,TXT.
  • $record_prio (int) - priorytet rekordu
  • $record_ttl (int) - czas przechowywania rekordu w pamięci podręcznej DNS
  • $record_value (string) - wartość rekordu DNS
  • $lbr_type (string) - typ load balancera DNS spdns_rec (sprawdzanie portu), spdns_url (sprawdzanie URL), pickrandom (wybór losowego serwera), jeśli to pole jest podane wartość pola $record_value jest ignorowana
  • $lbr_ips (string) - numery IP dla weryfikacji stanu serwera dla load balancera DNS
  • $lbr_port (int) - numer portu dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli lbr_type=spdns_rec
  • $lbr_url (string) - URL dla weryfikacji stanu serwera dla load balancera DNS, zwracane, jeśli lbr_type=spdns_url


Usuwanie rekordu

Zapytanie

DELETE /v2/dns/$RECORD_ID/record

Usuwa rekord $RECORD_ID.

Odpowiedź

{  
  "success":true
}


Usuwanie domeny

Zapytanie

DELETE /v2/dns/$DOMAIN_ID

Usuwa domenę $DOMAIN_ID.

Odpowiedź

{  
  "success":true
}