Skip to content
nsin nsin nsin Docs

List DNS records

GET
/domains/{domain}/records/
 
curl --request GET \
  --url https://api.nsin.ir/domains/example.com/records/ \
  --header 'Authorization: Bearer <token>'

All records of the domain, newest first.

Proxied records may carry origin_rules — origin route or origin pool rules that override where that record’s traffic actually goes, so the effective origin is not the record’s destination. Routes are listed before pools, mirroring edge precedence.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
domain
required
string

The domain name (for example example.com) — not a numeric id.

Example 
example.com

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Record list.

Media type application/json
Array
object
id
integer
name

Record name relative to the domain. @ is the apex.

string
original_name

The fully-qualified name, with trailing dot.

string
type
string
Allowed values: A AAAA CNAME ANAME NS TXT MX SRV PTR CAA TLSA SSHFP URI
destination

The record’s value. For a proxied record this is the origin the edge connects to, and the published DNS answer is the NSIN proxy IP instead — see dns_content.

string
dns_content

What is actually published in DNS. Equals the proxy IP for proxied records.

string
ttl

TTL in seconds.

integer
proxied

Route this hostname through the NSIN edge. Only A, AAAA, CNAME and ANAME may be proxied.

boolean
captcha

Challenge visitors before passing them to the origin.

boolean
editable

False for records NSIN manages on your behalf.

boolean
user_id
integer
domain_id
integer
scheme

Protocol the edge uses to reach the origin for a proxied record. Default follows the request’s own scheme; Auto probes.

string
Allowed values: Http Https Auto Default
port

Origin port for proxied records. Default: 443.

integer
host_header

Overrides the Host header (and SNI) sent to the origin.

string
monitor

Include this record in uptime monitoring.

boolean
dest_country

ISO country code of the destination, detected by NSIN.

string
timeout

Upstream timeout in seconds. Default: 15.

integer
mx_priority

Only meaningful for MX.

integer
<= 65535
comment

Free-form note.

string
<= 1024 characters
created_at
string format: date-time
updated_at
string format: date-time
origin_rules

Absent when nothing overrides this record’s origin. Routes are listed before pools.

Array<object>

An enabled origin rule that overrides where a proxied record’s traffic goes, meaning the effective origin is not the record’s destination.

object
rule_id
integer
type
string
Allowed values: origin_route origin_pool
zone_wide

True when the rule applies to every proxied record of the domain.

boolean
dry_run

The rule is evaluated but not enforced.

boolean
Example 
[
  {
    "name": "www",
    "original_name": "www.example.com.",
    "type": "A",
    "scheme": "Http",
    "origin_rules": [
      {
        "type": "origin_route"
      }
    ]
  }
]

401

Section titled “401 ”

Missing, malformed, revoked or expired API key — or the owning account is inactive.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example invalidKey 
{
  "error": "invalid API key"
}

404

Section titled “404 ”

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Example 
{
  "error": "read-only API key"
}

429

Section titled “429 ”

The key exceeded its request budget (300 requests per minute by default).

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example limited 
{
  "error": "rate limit exceeded"
}