Switch a gateway on

POST

/domains/{domain}/gateways/{gatewayId}/apply

curl --request POST \
  --url https://api.nsin.ir/domains/example.com/gateways/1/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "my-chatgpt" }'

• Production

Creates the gateway’s record on this domain and returns it. The record is proxied through the NSIN edge and counts against your plan’s record limit, but it is not editable — updating or deleting it through the DNS record endpoints returns 403. Use the rename and delete endpoints below instead.

Send a name to choose the hostname yourself; omit the body entirely and one is generated as <slug>-<5 digits>.

A gateway can be on at most once per 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

gatewayId

required

integer

Numeric id of the gateway, from the gateway list.

Request Body

Media type application/json

object

name

required

Hostname relative to the domain — letters, digits and hyphens. Wildcards and @ are rejected. On apply this field is optional; leave it out and a name is generated for you.

string

Example

my-chatgpt

Responses

201

Gateway switched on; the created record.

Media type application/json

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

How long an edge node waits for the origin to start responding before returning 504, in seconds. Default 15, maximum 1800 (30 minutes). Only applies to proxied records.

integer

default: 15 >= 1 <= 1800

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

{
  "name": "www",
  "original_name": "www.example.com.",
  "type": "A",
  "scheme": "Http",
  "timeout": 15
}

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

Insufficient permission, no active plan, or the plan’s record limit is already reached.

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

Domain not found, or no such gateway is on offer.

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, uses external DNS (error_code: external_dns), or this gateway is already on — in that last case the response carries the existing record under record.

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