Login

Get list of records

HTTP method

GET

URL

https://api.zilore.com/dns/v1/domains/{domain_name}/records

Request parameters

Parameter

Description

domain_name

Domain name. Must conform to the standard. Names of national domains must be passed in Punycode format.

Additional parameters

Parameter

Description

offset

Omission of the stated number of records in the response

limit

Limit on the number of records returned

order_by

Sort parameter, accepts values:

  • record_id — Record identifier
  • idn_record_name — Name of record in Unicode format
  • record_type — Record type
  • idn_record_value — Record value in Unicode format
  • record_ttl — Maximum permitted time for record to be cached

order_param

Sort parameter, accepts values:

  • asc — alphabetical order (A-Z)
  • desc — reverse alphabetical order (Z-A)

search_text

Search by record name in Unicode format, record type, record value in Unicode format, record lifetime.

For exact matching, you need to use the additional strict_search=yes parameter. To search by specific record type, use search_record_type=A/AAAA/CNAME/ALIAS/MX/TXT/NS/SRV/PTR/CAA.

Response fields

Parameter

Description

record_id

Record identifier

record_name

Name of record in Unicode format

record_status

Record status:

  • enabled — Active
  • disabled — Inactive

record_type

Record type:

  • A — Establishes correspondence between a domain name/subdomain and its IPv4 address
  • AAAA — Establishes correspondence between a domain name/subdomain and its IPv6 address
  • CNAME — Establishes correspondence beteeem a subdomain and another domain name (cannot be used with a domain name directly)
  • ALIAS — Establishes correspondence between a domain name/subdomain and another domain name (can be used without limitation)
  • MX — Show mail servers for domain name/subdomain
  • TXT — Includes arbitrary text information for the domain name/subdomain
  • NS — Show authoritative DNS servers for domain name/subdomain
  • SRV — Show location of servers for different services/domains
  • PTR — Establishes correspondence between an IP address and its domain name/subdomain
  • CAA — Defines SSL/TLS certificate issue policy for domain name/subdomain
  • SOA — Includes a number of system parameters required for the correct functioning of the domain name (record is supported automatically and cannot be edited)

record_value

Record value in Unicode format

record_ttl

Maximum permitted time for record to be cached

is_geo

Is the record a GEO record by default?

  • yes — Yes
  • no — No

is_failover

Is Failover set up for this record?

  • yes — Yes
  • no — No

Request example

GET https://api.zilore.com/dns/v1/domains/example.com/records?offset=0&limit=5&order_by=idn_record_name&order_param=asc
X-Auth-Key: 6fac94db-691b-ec08-d22c-00000b7c06c0

Response example

{
"status": "ok",
"response": [{
"record_id": "1",
"record_status": "enabled",
"record_name": "foo.example.com",
"record_type": "CNAME",
"record_value": "example.com",
"record_ttl": "3600",
"is_geo": "no",
"is_failover": "no"
}, {
"record_id": "2",
"record_status": "enabled",
"record_name": "www.example.com",
"record_type": "CNAME",
"record_value": "example.com",
"record_ttl": "3600",
"is_geo": "no",
"is_failover": "no"
}, {
"record_id": "3",
"record_status": "enabled",
"record_name": "example.com",
"record_type": "A",
"record_value": "8.8.8.8",
"record_ttl": "60",
"is_geo": "no",
"is_failover": "no"
}, {
"record_id": "4",
"record_status": "enabled",
"record_name": "example.com",
"record_type": "TXT",
"record_value": "\"hello\"",
"record_ttl": "3600",
"is_geo": "no",
"is_failover": "no"
}, {
"record_id": "5",
"record_status": "disabled",
"record_name": "example.com",
"record_type": "A",
"record_value": "8.8.4.4",
"record_ttl": "3600",
"is_geo": "yes",
"is_failover": "no"
}]
}