Probe which HTTP versions the origins speak

GET

/domains/{domain}/origin-protocols

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

• Production

Makes a TLS handshake (reading the ALPN answer), a QUIC handshake and one HEAD / request (reading the Alt-Svc header) against every distinct origin behind the domain’s proxied records, from the NSIN control plane, and reports whether each speaks HTTP/1.1, HTTP/2 and HTTP/3. HTTP/3 counts as supported when either the QUIC handshake completed or the origin advertised h3 in Alt-Svc; http3_via says which. Use it before changing origin_protocol. Answers younger than 20 seconds are reused, so repeated calls do not hammer the origin. 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

Per-origin protocol support.

Media type application/json

What a domain’s origins speak, from a TLS handshake (ALPN), a QUIC handshake and one HEAD / request (for Alt-Svc) made from the NSIN control plane. A result proves the origin speaks a protocol; whether UDP is open on the path from a given edge is decided at the edge, which falls back to TCP per origin.

object

current

The domain’s current origin_protocol setting.

string

Allowed values: http1 http2 http3

origins

One entry per distinct origin (destination, port, scheme) across the domain’s proxied records. Gateway records are excluded.

Array<object>

object

host

string

port

integer

sni

The server name presented in the handshake.

string

tls

false for a plain-HTTP origin, which can only be HTTP/1.1.

boolean

http1

boolean

http2

boolean

http3

boolean

http3_via

How HTTP/3 support was established. Absent when http3 is false.

string

Allowed values: quic alt-svc

error

Why the TCP/TLS handshake failed

string

http3_error

Why the QUIC handshake failed. Absent when it succeeded. Present next to http3_via = alt-svc when the origin advertises HTTP/3 but the control plane could not reach it over UDP.

string

checked_at

string format: date-time

supports

Whether EVERY TLS origin answered the protocol.

object

http2

boolean

http3

boolean

recommended

The highest protocol every origin supports.

string

Allowed values: http1 http2 http3

probed_from

string

Example

{
  "current": "http1",
  "origins": [
    {
      "http3_via": "quic"
    }
  ],
  "recommended": "http1",
  "probed_from": "control plane"
}

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

403

The key is read-only, your role on the domain lacks the required permission, or the domain’s plan does not include the feature.

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

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

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