List web optimization rules

GET

/domains/{domain}/rules/optimize/

curl --request GET \
  --url https://api.nsin.ir/domains/example.com/rules/optimize/ \
  --header 'Authorization: Bearer <token>'

• Production

Shrinks matching responses at the edge: converts JPEG/PNG images to WebP, minifies JavaScript and CSS, and sets the brotli level used for cached text.

Returned in evaluation order. Requires domain.view.

Authorizations

• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

domain

required

string

The domain name (for example example.com) — not a numeric id.

Example

example.com

Responses

200

Optimization rules.

Media type application/json

Array

object

id

integer

domain_id

integer

record_id

Deprecated single-record scope. Prefer record_ids. Absent for zone-wide rules.

integer

record_ids

The proxied DNS records this rule applies to. Empty or absent means zone-wide — every proxied record of the domain.

Array<integer>

type

string

Allowed values: cache drop redirect rewrite waf captcha rate_limit bot_route origin_pool origin_route fingerprint error_page

enabled

boolean

priority

Evaluation order; lower runs first. Defaults to 100.

integer

host_pattern

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.

string

host_match_type

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.

string

Allowed values: "" exact wildcard regex

host_includes

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.

Array<string>

host_excludes

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.

Array<string>

action_mode

• 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.

string

Allowed values: enforce dry_run

created_at

string format: date-time

updated_at

string format: date-time

path_match_type

How path_includes and path_excludes are interpreted.

string

Allowed values: wildcard regex

path_includes

Paths the rule applies to. Defaults to ["/*"] — everything.

Array<string>

path_excludes

Paths carved back out of path_includes.

Array<string>

images

Convert JPEG and PNG responses to WebP. Only visitors whose Accept header advertises WebP are served it — those requests occupy a separate cache slot — so a client that cannot decode WebP always receives the original file.

boolean

image_quality

WebP encoder quality. Lower is smaller and lossier. 80 is the recommended balance.

integer

default: 80 >= 40 <= 100

minify_js

Strip comments and whitespace from JavaScript. Identifiers are never renamed.

Note: minifying a script breaks any page that loads it with a Subresource Integrity hash (integrity="sha384-..."), because the bytes no longer match, and it invalidates published source maps. The edge cannot detect either condition.

boolean

minify_css

Strip comments and whitespace from CSS.

boolean

compress_level

Brotli quality for cached text responses. 0 inherits the node default. Lossless, so it carries none of the risk of the other actions. Higher levels are applied in the background after the first response is served, so they never add latency.

integer

0 <= 11

Example

[
  {
    "type": "cache",
    "host_match_type": "",
    "action_mode": "enforce",
    "path_match_type": "wildcard",
    "images": false,
    "image_quality": 80,
    "minify_js": false,
    "minify_css": false,
    "compress_level": 0
  }
]

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

404

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.

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 notFound

{
  "error": "not found"
}

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