Rename a gateway
const url = 'https://api.nsin.ir/domains/example.com/gateways/1';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"my-chatgpt"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.nsin.ir/domains/example.com/gateways/1 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "my-chatgpt" }'Changes the hostname of a gateway that is already on, moving it in the
zone. Only the name changes — the origin and Host header behind the
gateway stay ours. This is the only way to rename the record, since the
DNS record endpoints refuse it. Requires records.edit.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The domain name (for example example.com) — not a numeric id.
Example
example.comNumeric id of the gateway, from the gateway list.
Request Body required
Section titled “Request Body required ”object
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.
Example
my-chatgptResponses
Section titled “ Responses ”The renamed record.
object
Record name relative to the domain. @ is the apex.
The fully-qualified name, with trailing dot.
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.
What is actually published in DNS. Equals the proxy IP for proxied records.
TTL in seconds.
Route this hostname through the NSIN edge. Only A, AAAA, CNAME
and ANAME may be proxied.
Challenge visitors before passing them to the origin.
False for records NSIN manages on your behalf.
The platform feature that owns this record, or empty for a record
you created. email_routing marks the MX, SPF and DKIM rows Email
Routing publishes; they are removed by disabling routing, never
through the record endpoints (which refuse them while locked).
Protocol the edge uses to reach the origin of a proxied record.
Https— TLS toport(443 when the port is unset or out of range).Http— plain HTTP toport(80 when unset or out of range).Auto— HTTPS on 443 first, falling back to plain HTTP. The port is always 443.Default— accepted on input, and so are an empty or unrecognised value, but stored asAutowith port 443: a record never reads back asDefault.
Origin port for proxied records: 443 for Auto, otherwise as set (default 443 for Https, 80 for Http).
Overrides the Host header (and SNI) sent to the origin.
Which name a proxied CNAME/ANAME sends to its origin as the Host
header (and SNI) when host_header is empty: empty — the record’s
own hostname (the default); target — the hostname it points at.
The gateway this record was created for, or null for a record you
made. A gateway record is not editable here; rename or remove it
through the gateway endpoints.
Gateway records only: a JSON array, as a string, of the other
hostnames the gateway’s service links to. The edge serves them
under /_nsin/<host>/ on the gateway hostname.
Gateway records only — whether the edge rewrites URLs in responses to go through the gateway.
Include this record in uptime monitoring.
How long an edge node waits for the origin to start responding before returning 504, in seconds. Default 60, maximum 1800 (30 minutes). Only applies to proxied records.
Only meaningful for MX.
Free-form note.
Always null — deleted records are never returned.
External-DNS domains, proxied records only. Whether the name
resolves to NSIN’s edge, as last checked: ok — every address it
resolves to is ours; miss — it resolves elsewhere, only partly to
us, or not at all; error — the first lookup failed and nothing is
known yet. Absent until the first check, and always absent on a
managed-DNS domain.
How an ok record reaches NSIN: through the CNAME target
(cname), by publishing our address directly (a), or proxy —
DNS points at another CDN or proxy, but that service forwards to
NSIN and the edge is serving the host (judged from the last 24h of
request logs). A CNAME keeps working when our addresses change; an
A record does not.
What the name actually resolves to, for display.
Example
{ "name": "www", "original_name": "www.example.com.", "type": "A", "scheme": "Http", "host_header_mode": "", "timeout": 60, "edge_status": "ok", "edge_via": "cname"}Missing or invalid name — not a valid hostname label, @, or a wildcard.
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Example
{ "error": "read-only API key"}Missing, malformed, revoked or expired API key. (A valid key whose
account has been deactivated gets 403 account is inactive instead.)
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Examples
{ "error": "invalid API key"}The key is read-only, your role on the domain lacks the required permission, or the domain’s plan does not include the feature.
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Example
{ "error": "read-only API key"}Domain not found, or this gateway is not on for it.
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Example
{ "error": "read-only API key"}The domain is disabled, uses external DNS (error_code: external_dns), or a record with that name already exists.
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Example
{ "error": "read-only API key"}The key exceeded its request budget (300 requests per minute by default).
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Examples
{ "error": "rate limit exceeded"}