Update a origin pool rule
const url = 'https://api.nsin.ir/domains/example.com/rules/origin_pool/1';const options = { method: 'PUT', 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":"","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"}'};
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/rules/origin_pool/1 \ --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": "", "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" }'Partial update — omitted fields keep their current value. 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.comNumeric id of the rule.
Request 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 host_pattern is matched. The empty string means “no host filter”,
and is the only valid value when host_pattern is empty — the two
fields are set and cleared together.
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.
Responses
Section titled “ Responses ”The updated rule.
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.
Optional hostname filter. Empty means the rule is not host-scoped.
How host_pattern is matched. The empty string means “no host filter”,
and is the only valid value when host_pattern is empty — the two
fields are set and cleared together.
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.
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 domain or the rule does not exist, the rule belongs to another domain or another rule type, or your role does not permit this operation.
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"}