Skip to content
nsin docs
EN فا

Current origin-error status per subdomain

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

What is happening right now, per watched scope, over the domain’s detection window — including hosts that are erroring but have not (yet) crossed the alert thresholds. Distinct from /uptime, which lists only sustained outages.

One hostname may appear on several rows: the whole-host watch (monitor_id: 0) plus one row per uptime monitor that matches it, each measured over its own traffic. Key on (hostname, monitor_id).

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 ”

Live status.

Media type application/json
object
window_min

Length of the trailing window, in minutes.

integer
hosts
Array<object>
object
hostname
string
monitor_id

The monitor this row belongs to; 0 for the domain’s default whole-host watch. One hostname can appear on several rows — one per matching monitor, plus the whole-host row — so key on (hostname, monitor_id), never on hostname alone.

integer
monitor_name

Empty for the whole-host watch.

string
scope_label

Human name of the watch, so two rows for one hostname do not read as duplicates. Empty for the whole-host watch.

string
requests
integer
errors

Origin-attributable 5xx responses.

integer
error_pct

Origin-error percentage across the window.

number
down

Currently meets this domain’s alert thresholds.

boolean
incident

An incident is currently open for this scope.

boolean
Example generated
{
  "window_min": 1,
  "hosts": [
    {
      "hostname": "example",
      "monitor_id": 1,
      "monitor_name": "example",
      "scope_label": "example",
      "requests": 1,
      "errors": 1,
      "error_pct": 1,
      "down": true,
      "incident": true
    }
  ]
}

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. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

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