Skip to content
nsin nsin nsin Docs

List outage incidents

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

The domain’s sustained origin-outage incidents, most recent first. An incident opens when a subdomain’s origin-error rate stays above the domain’s threshold for the whole detection window, and resolves after recover_min clear minutes.

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 ”

Incident history.

Media type application/json
Array<object>
object
id
integer
hostname
string
state

open while ongoing, resolved once recovered.

string
ongoing
boolean
started_at
string format: date-time
resolved_at

Absent while the incident is ongoing.

string format: date-time
duration_seconds
integer
peak_err_pct

Highest origin-error percentage reached.

number
sample_reqs

Requests observed over the incident.

integer
Example generated
[
  {
    "id": 1,
    "hostname": "example",
    "state": "example",
    "ongoing": true,
    "started_at": "2026-04-15T12:00:00Z",
    "resolved_at": "2026-04-15T12:00:00Z",
    "duration_seconds": 1,
    "peak_err_pct": 1,
    "sample_reqs": 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"
}