Skip to content
nsin nsin nsin Docs

Get outage-detection settings

GET
/uptime/settings
 
curl --request GET \
  --url 'https://api.nsin.ir/uptime/settings?domain=example.com' \
  --header 'Authorization: Bearer <token>'

The domain’s detection thresholds, with the valid range for each in bounds.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
domain
required
string

The domain name (for example example.com). These endpoints take the domain as a query parameter rather than a path segment.

Example 
example.com

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Current settings.

Media type application/json
object
enabled

Whether outage alerts are sent for this domain.

boolean
threshold_pct

Per-minute origin-error percentage that counts as down.

integer
window_min

Minutes the host must stay down before an incident opens.

integer
min_requests

Traffic floor — below this, no incident opens.

integer
min_active_min

Minimum populated one-minute buckets required in the window.

integer
recover_min

Consecutive clear minutes before an incident resolves.

integer
bounds

Valid range for each configurable field.

object
threshold_pct_min
integer
threshold_pct_max
integer
window_min_min
integer
window_min_max
integer
min_requests_min
integer
recover_min_min
integer
recover_min_max
integer
Example generated
{
  "enabled": true,
  "threshold_pct": 1,
  "window_min": 1,
  "min_requests": 1,
  "min_active_min": 1,
  "recover_min": 1,
  "bounds": {
    "threshold_pct_min": 1,
    "threshold_pct_max": 1,
    "window_min_min": 1,
    "window_min_max": 1,
    "min_requests_min": 1,
    "recover_min_min": 1,
    "recover_min_max": 1
  }
}

400

Section titled “400 ”

The domain query parameter is missing.

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 missing 
{
  "error": "domain is required"
}

401

Section titled “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

Section titled “404 ”

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Example 
{
  "error": "read-only API key"
}

429

Section titled “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"
}