Get the edge proxy IP

GET

/proxy-ip/

const url = 'https://api.nsin.ir/proxy-ip/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.nsin.ir/proxy-ip/ \
  --header 'Authorization: Bearer <token>'

What to point DNS at for an externally-hosted zone. For managed domains NSIN sets this automatically when you mark a record proxied.

Prefer cname for subdomains when it is present: a CNAME follows any future change of our addresses, an A record does not. The apex has to use the A addresses in ips. Per-record values (which honour address pins) are on each record’s edge_target in the records listing.

Authorizations

bearerAuth
apiKeyAuth

Responses

200

Proxy IP.

application/json

object

The first edge address (legacy single value).

string

ips

Every edge address a proxied record publishes.

Array<string>

cname

Hostname to CNAME proxied subdomains at. Empty when not configured.

string

Example

{
  "cname": "edge.nsin.ir"
}

401

Missing, malformed, revoked or expired API key. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

429

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

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

limited

{
  "error": "rate limit exceeded"
}