Create a origin pool rule
const url = 'https://api.nsin.ir/domains/example.com/rules/origin_pool/';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"record_id":1,"record_ids":[1],"enabled":true,"priority":100,"host_pattern":"example","host_match_type":"","host_includes":["example"],"host_excludes":["example"],"action_mode":"enforce","lb_type":"round_robin","origins":[{"address":"example","port":1,"scheme":"http","weight":1,"node_ids":[1],"country":"example"}],"health_check":{"enabled":true,"path":"/","interval_sec":15,"timeout_sec":5,"unhealthy_threshold":3,"healthy_threshold":2,"eject_sec":30,"host":"example"},"host_header":"example","name":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.nsin.ir/domains/example.com/rules/origin_pool/ \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "record_id": 1, "record_ids": [ 1 ], "enabled": true, "priority": 100, "host_pattern": "example", "host_match_type": "", "host_includes": [ "example" ], "host_excludes": [ "example" ], "action_mode": "enforce", "lb_type": "round_robin", "origins": [ { "address": "example", "port": 1, "scheme": "http", "weight": 1, "node_ids": [ 1 ], "country": "example" } ], "health_check": { "enabled": true, "path": "/", "interval_sec": 15, "timeout_sec": 5, "unhealthy_threshold": 3, "healthy_threshold": 2, "eject_sec": 30, "host": "example" }, "host_header": "example", "name": "example" }'Load-balances matching traffic across several origins with optional health checking. Overrides the DNS record’s own destination for every path it matches.
Requires rules.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.comRequest Body required
Section titled “Request Body required ”object
Deprecated single-record scope. Prefer record_ids.
Scope the rule to these proxied records. Omit or send an empty array for a zone-wide rule. Every id must belong to this domain.
How the host filter — host_pattern, host_includes and
host_excludes — is matched. One strategy covers all three, exactly as
one path_match_type covers both path lists.
The empty string means “no host filter”, and is the only valid value
when the pattern and both lists are empty. Set a list without a match
type and the API defaults it to wildcard.
A wildcard entry matches subdomains, not the label itself:
*.example.com covers shop.example.com but not example.com — the
same reading as the DNS wildcard. Add the bare name as its own entry to
include it.
Hostnames the rule applies to; empty or omitted means every host. Sending an explicit empty array clears an existing list.
Hostnames excluded from the rule; excludes beat includes.
enforce— the rule acts (block, redirect, challenge, …).dry_run— the rule matches and is logged as “would have acted”, but the request reaches the origin unchanged. Use it to test a rule safely.
Not every rule type honours this; cache ignores it.
How traffic is spread across origins. geo routes by edge node —
see node_ids on each origin.
One origin in a pool.
object
Origin IP address or hostname.
Relative share of traffic under round_robin and least_load.
Under lb_type: geo, the edge nodes that use this origin.
ISO country code of this origin.
object
Probe path.
Seconds between active probes.
Probe timeout in seconds.
Consecutive probe failures before an origin is marked down.
Consecutive probe successes before an origin returns to service.
How long a passively ejected origin stays out, in seconds.
Host header override for the probe.
Host header (and SNI) sent to the pool’s origins.
Optional label for this pool, shown in the panel’s rule table and next to the records it overrides. Purely for identification — it does not affect routing. Omit or send an empty string for none.
Responses
Section titled “ Responses ”Rule created.
object
Deprecated single-record scope. Prefer record_ids. Absent for
zone-wide rules.
The proxied DNS records this rule applies to. Empty or absent means zone-wide — every proxied record of the domain.
Evaluation order; lower runs first. Defaults to 100.
Legacy single-hostname filter, kept for rules written before
host_includes existed. It is evaluated as one more entry of
host_includes; prefer the lists.
How the host filter — host_pattern, host_includes and
host_excludes — is matched. One strategy covers all three, exactly as
one path_match_type covers both path lists.
The empty string means “no host filter”, and is the only valid value
when the pattern and both lists are empty. Set a list without a match
type and the API defaults it to wildcard.
A wildcard entry matches subdomains, not the label itself:
*.example.com covers shop.example.com but not example.com — the
same reading as the DNS wildcard. Add the bare name as its own entry to
include it.
Hostnames the rule applies to. Empty or absent means every host the
scoped record(s) serve — which on a wildcard-proxied zone
(*.example.com) is every subdomain.
Hostnames carved back out of host_includes. An exclude always
wins over an include, so “everything except staging” is an empty
include list plus one exclude.
enforce— the rule acts (block, redirect, challenge, …).dry_run— the rule matches and is logged as “would have acted”, but the request reaches the origin unchanged. Use it to test a rule safely.
Not every rule type honours this; cache ignores it.
How traffic is spread across origins. geo routes by edge node —
see node_ids on each origin.
One origin in a pool.
object
Origin IP address or hostname.
Relative share of traffic under round_robin and least_load.
Under lb_type: geo, the edge nodes that use this origin.
ISO country code of this origin.
object
Probe path.
Seconds between active probes.
Probe timeout in seconds.
Consecutive probe failures before an origin is marked down.
Consecutive probe successes before an origin returns to service.
How long a passively ejected origin stays out, in seconds.
Host header override for the probe.
Host header (and SNI) sent to the pool’s origins.
Optional label for this pool, shown in the panel’s rule table and next to the records it overrides. Purely for identification — it does not affect routing. Omit or send an empty string for none.
Example
{ "type": "cache", "host_match_type": "", "action_mode": "enforce", "lb_type": "round_robin", "origins": [ { "scheme": "http" } ], "health_check": { "path": "/", "interval_sec": 15, "timeout_sec": 5, "unhealthy_threshold": 3, "healthy_threshold": 2, "eject_sec": 30 }}Malformed body, an invalid field value, or record_ids containing a
record that does not belong to this domain.
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Examples
{ "error": "record_ids do not belong to this domain"}Missing, malformed, revoked or expired API key — or the owning account is inactive.
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, or the domain’s plan does not include this rule type or allows fewer rules of it than you already have.
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Example
{ "error": "read-only API key"}No such domain, or your role on it does not permit this operation. The
rules endpoints deliberately answer 404 rather than 403 for an
insufficient role, so they never confirm that a domain exists to someone
who cannot use it.
The single error shape used by every endpoint.
object
Human-readable description of what went wrong.
Examples
{ "error": "not found"}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"}