Skip to content
nsin
docs
Search
Ctrl
K
Cancel
EN
فا
Select theme
Dark
Light
Auto
Login
Getting Started
What is nsin?
Quick Start
DNS & Domains
Domain Modes
Managing DNS Records
Nameservers
Email
Email Routing
SSL / HTTPS
SSL Overview
Caching
How Caching Works
Purging & Browsing the Cache
Downloading Your Cached Files
Gateways
What Are Gateways?
Using a Gateway
AI Crawl Control
AI Crawl Control
Markdown for Agents
Monitoring
Monitoring & Analytics
Uptime & Outages
Recommendations
Rules
Rules Overview
Redirects
URL Rewrites
Cache Rules
Header Rules
Blocking Traffic
Rate Limiting
WAF (Firewall)
Bots & Challenges
Origins & Failover
Custom Error Pages
API & MCP
API Keys
REST API
API Reference — all endpoints
MCP Server
Agent Skill
acme.sh DNS Plugin
NSIN CLOUD
Commands
REST API Reference
Overview
Domains
Overview
List domains
GET
Add a domain
POST
List accepted nameserver sets
GET
Get a domain
GET
Update domain settings
PUT
Delete a domain
DELETE
Enable developer mode
POST
Disable developer mode
DELETE
Get the automatic attack switches
GET
Change the automatic attack switches
PUT
List detected attacks
GET
Enforce an attack's rule
POST
Ignore an attack
POST
Get Under Attack Mode
GET
Switch Under Attack Mode
PUT
Get the NsinNabz analytics tag
GET
Set the NsinNabz analytics tag
PUT
Remove the NsinNabz analytics tag
DELETE
Get the domain's custom pages
GET
Set the domain's custom pages
PUT
Probe which HTTP versions the origins speak
GET
Re-enable a disabled domain
POST
Last result of each manual check
GET
Check nameserver delegation now
POST
Verify an external-DNS domain
POST
Issue a fresh verification token
POST
DNS Records
Overview
List DNS records
GET
Create a DNS record
POST
Export the zone as a BIND master file
GET
Update a DNS record
PUT
Delete a DNS record
DELETE
Re-check that proxied records point to NSIN (external DNS)
POST
Update many records at once
POST
Delete many records at once
POST
Scan the domain's existing DNS
GET
Scan and import in one step
POST
Parse a zone file into an import preview
POST
Import records
POST
Start a record import session
POST
Get the domain's open import session
GET
Get one import session
GET
Discard an import session
DELETE
Commit a reviewed import session
POST
Rescan, superseding an import session
POST
Gateways
Overview
List gateways
GET
Gateway terms of use status
GET
Accept the gateway terms of use
POST
Switch a gateway on
POST
Rename a gateway
PUT
Switch a gateway off
DELETE
Get a gateway's icon image
GET
SSL
Overview
Get certificate status
GET
Upload a custom certificate
POST
Inspect a certificate before uploading
POST
Request certificate issuance
POST
Check the SSL delegation record now
POST
List the domain's certificates
GET
Choose which certificate the edge serves
POST
Remove an uploaded certificate
DELETE
Ask NSIN to issue a certificate as well
POST
Get the domain's acme-dns account
GET
Store acme-dns credentials for this domain
PUT
Remove the domain's acme-dns account
DELETE
Test the stored acme-dns credentials
POST
Rules
Overview
List cache rules
GET
Create a cache rule
POST
Reorder cache rules
PATCH
Get a cache rule
GET
Update a cache rule
PUT
Delete a cache rule
DELETE
Enable or disable a cache rule
PATCH
List drop rules
GET
Create a drop rule
POST
Reorder drop rules
PATCH
Get a drop rule
GET
Update a drop rule
PUT
Delete a drop rule
DELETE
Enable or disable a drop rule
PATCH
List custom rules
GET
Create a custom rule
POST
Reorder custom rules
PATCH
Get a custom rule
GET
Update a custom rule
PUT
Delete a custom rule
DELETE
Enable or disable a custom rule
PATCH
List redirect rules
GET
Create a redirect rule
POST
Reorder redirect rules
PATCH
Get a redirect rule
GET
Update a redirect rule
PUT
Delete a redirect rule
DELETE
Enable or disable a redirect rule
PATCH
List rewrite rules
GET
Create a rewrite rule
POST
Reorder rewrite rules
PATCH
Get a rewrite rule
GET
Update a rewrite rule
PUT
Delete a rewrite rule
DELETE
Enable or disable a rewrite rule
PATCH
List header rules
GET
Create a header rule
POST
Reorder header rules
PATCH
Get a header rule
GET
Update a header rule
PUT
Delete a header rule
DELETE
Enable or disable a header rule
PATCH
List web optimization rules
GET
Create a web optimization rule
POST
Reorder web optimization rules
PATCH
Get a web optimization rule
GET
Update a web optimization rule
PUT
Delete a web optimization rule
DELETE
Enable or disable a web optimization rule
PATCH
List WAF rules
GET
Create a WAF rule
POST
Reorder WAF rules
PATCH
Get a WAF rule
GET
Update a WAF rule
PUT
Delete a WAF rule
DELETE
Enable or disable a WAF rule
PATCH
Default protection status
GET
Restore default protection
POST
List captcha rules
GET
Create a captcha rule
POST
Reorder captcha rules
PATCH
Get a captcha rule
GET
Update a captcha rule
PUT
Delete a captcha rule
DELETE
Enable or disable a captcha rule
PATCH
List basic auth rules
GET
Create a basic auth rule
POST
Reorder basic auth rules
PATCH
Get a basic auth rule
GET
Update a basic auth rule
PUT
Delete a basic auth rule
DELETE
Enable or disable a basic auth rule
PATCH
List rate limit rules
GET
Create a rate limit rule
POST
Reorder rate limit rules
PATCH
Get a rate limit rule
GET
Update a rate limit rule
PUT
Delete a rate limit rule
DELETE
Enable or disable a rate limit rule
PATCH
List bot route rules
GET
Create a bot route rule
POST
Reorder bot route rules
PATCH
Get a bot route rule
GET
Update a bot route rule
PUT
Delete a bot route rule
DELETE
Enable or disable a bot route rule
PATCH
List origin pool rules
GET
Create an origin pool rule
POST
Reorder origin pool rules
PATCH
Get an origin pool rule
GET
Update an origin pool rule
PUT
Delete an origin pool rule
DELETE
Enable or disable an origin pool rule
PATCH
List origin route rules
GET
Create an origin route rule
POST
Reorder origin route rules
PATCH
Get an origin route rule
GET
Update an origin route rule
PUT
Delete an origin route rule
DELETE
Enable or disable an origin route rule
PATCH
List fingerprint rules
GET
Create a fingerprint rule
POST
Reorder fingerprint rules
PATCH
Get a fingerprint rule
GET
Update a fingerprint rule
PUT
Delete a fingerprint rule
DELETE
Enable or disable a fingerprint rule
PATCH
List error page rules
GET
Create an error page rule
POST
Reorder error page rules
PATCH
Get an error page rule
GET
Update an error page rule
PUT
Delete an error page rule
DELETE
Enable or disable an error page rule
PATCH
Cache
Overview
Cached entry count and size for a domain
GET
Purge the entire cache for a domain
DELETE
Browse cached entries
GET
Cache totals with per-node breakdown
GET
Download one cached object
GET
Purge or refresh selected cached entries
POST
Analytics
Overview
Per-domain totals across your account
GET
Per-domain totals with sparkline
GET
Account-wide summary
GET
Account-wide peak requests per second
GET
Origin-direction bandwidth across your domains
GET
Clients whose traffic resembles a proxy tunnel
GET
List edge nodes
GET
Traffic by edge node, across your domains
GET
List edge node countries
GET
Traffic summary for one domain
GET
This period against the one before it
GET
Billable traffic per day or hour, over whole days
GET
Busiest day and hour, and what changed
GET
The files that used the most bytes
GET
What used the traffic, by one dimension
GET
Requests over time
GET
Requests over time, for period-over-period comparison
GET
Unique visitors over time
GET
Bandwidth over time
GET
Most requested URIs
GET
Top-N breakdown by a chosen metric
GET
Traffic by visitor country
GET
Traffic by visitor network (ASN)
GET
Traffic by HTTP protocol version
GET
TLS versions, cipher suites and session resumption
GET
AI crawler traffic, in full
GET
Traffic by HTTP status code
GET
Why requests could not be served
GET
Cache hit, miss and bypass counts
GET
Cache counters for verified search-engine crawlers
GET
Egress bytes by cache status over time
GET
Egress bytes by serving path over time
GET
Traffic by edge node
GET
Edge-to-origin request statistics
GET
Traffic by user-agent category
GET
Requests per gateway
GET
Raw request logs
GET
Security actions by family
GET
Busiest rules
GET
Tripped rate-limit keys
GET
Under Attack Mode challenged vs cleared
GET
Bot score distribution
GET
Attacks with rule hits
GET
How the traffic behaves over time
GET
WAF event logs
GET
Preview Markdown-for-Agents conversion
GET
Run a custom query over your request logs
POST
Uptime
Overview
List outage incidents
GET
Outage incidents open right now
GET
Current origin-error status per subdomain
GET
Get outage-detection settings
GET
Update outage-detection settings
PUT
List the domain's uptime monitors
GET
Create an uptime monitor
POST
Update an uptime monitor
PUT
Delete an uptime monitor
DELETE
Enable or disable an uptime monitor
PATCH
Get the uptime webhook
GET
Send a test event to the uptime webhook
POST
Generate a new webhook signing secret
POST
List recent webhook deliveries
GET
Email Routing
Overview
Email routing status
GET
Enable email routing
POST
Disable email routing
POST
Unlock the managed records
POST
Lock the managed records
POST
Check the published records now
POST
Update routing settings
PUT
Get the catch-all
GET
Update the catch-all
PUT
List email addresses
GET
Create an email address
POST
Update an email address
PUT
Delete an email address
DELETE
Enable or disable an email address
POST
Message counts over time
GET
Activity log
GET
List the domain owner's destinations
GET
Add a destination to the domain owner's account
POST
Set up email routing in one call
POST
Send an email from one of the domain's addresses
POST
List sent email
GET
List my destinations
GET
Add a destination
POST
Resend the verification mail
POST
Delete a destination
DELETE
Verify a destination from its emailed link
POST
Recommendations
Overview
Get the domain's advisory checklist
GET
Outstanding recommendations across every domain
GET
Count outstanding recommendations
GET
Apply a one-click fix
POST
Dismiss a recommendation
POST
Restore a dismissed recommendation
DELETE
Sharing
Overview
List domain members
GET
Notification categories, channels and role defaults
GET
Remove a member
DELETE
Change a member's role or notifications
PATCH
List pending invitations
GET
Invite someone to the domain
POST
Revoke an invitation
DELETE
Resend an invitation
POST
Inspect an invitation
GET
Accept an invitation
POST
Billing
Overview
Get wallet balance
GET
List wallet transactions
GET
Get one wallet transaction
GET
Look up a top-up payment result
GET
Get one subscription's period statement
GET
List completed billing-period statements
GET
List your subscriptions
GET
Get one subscription
GET
Current subscription (removed)
GET
Plan summary per domain
GET
Traffic usage and pricing across your account
GET
List invoices
GET
Get one invoice
GET
Get the domain's current subscription
GET
List the domain's subscription history
GET
Get one of the domain's subscriptions
GET
Who pays for this domain, and what they have
GET
Get the domain's effective plan entitlements
GET
Get the domain's traffic usage
GET
List the domain's invoices
GET
Get one of the domain's invoices
GET
Support
Overview
List your support tickets
GET
Open a support ticket
POST
Count tickets with unread replies
GET
Get a ticket with its messages
GET
Reply to a ticket
POST
Notifications
Overview
List your notifications
GET
Count unseen notifications
GET
Mark notifications as seen
POST
Account
Overview
Identify the calling credential
GET
Unread counters for tickets and notifications
GET
Get the edge proxy IP
GET
SSO
Overview
OpenID Connect discovery document
GET
Token signing keys (JWKS)
GET
Look up a client before redirecting
GET
Approve an authorization request
POST
Exchange a code, or refresh a token
POST
Revoke a refresh token
POST
The signed-in user's claims
GET
Connected apps
GET
Change an app's domain access
PUT
Disconnect an app
DELETE
Webhooks
Uptime alert delivered to your webhook
POST
Reference
Proxy Headers
Security Headers
Account & Billing
Plans
Traffic & Usage
Sharing a Domain
Reset Your Password
Help
FAQ
Telegram
GitHub
Select theme
Dark
Light
Auto
Select language
English
فارسی
Overview
#
Sharing
#
Operations
Sharing
Section titled “Sharing”
Domain members and invitations.
Operations
Section titled “ Operations ”
GET
/domains/{domain}/members
GET
/domains/{domain}/members/notify-catalog
DELETE
/domains/{domain}/members/{userId}
PATCH
/domains/{domain}/members/{userId}
GET
/domains/{domain}/invites
POST
/domains/{domain}/invites
DELETE
/domains/{domain}/invites/{inviteId}
POST
/domains/{domain}/invites/{inviteId}/resend
GET
/invites/{token}
POST
/invites/{token}/accept
