Scan and import in one step

POST

/domains/{domain}/records/scan-import

curl --request POST \
  --url https://api.nsin.ir/domains/example.com/records/scan-import \
  --header 'Authorization: Bearer <token>'

• Production

Scans the domain’s existing DNS from public resolvers and imports everything it finds, without a review step. Convenient right after adding a domain. Requires records.edit.

Authorizations

• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

domain

required

string

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

Example

example.com

Responses

200

Import outcome, plus the domain’s full record list afterwards.

Media type application/json

object

created

integer

failed

Array<object>

object

name

string

type

string

error

string

records

The domain’s full record list after the import.

Array<object>

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

Example

{
  "records": [
    {
      "name": "www",
      "original_name": "www.example.com.",
      "type": "A",
      "scheme": "Http"
    }
  ]
}

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

403

The key is read-only, your role on the domain lacks the required permission, or the domain’s plan does not include the feature.

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

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

409

The domain is disabled.

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

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