Read a component's per-interface reachability

GET

/components/{name}/reachability

const url = 'https://example.com/api/v1/components/example/reachability';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/components/example/reachability

Composes, per interface, the latest reachability verdict, the probe-layer signals that compose it, and the recent verdict transitions for the availability strip. Gated by component:read; an out-of-scope component is a non-disclosing 404.

Parameters

Path Parameters

name

required

The component’s name, or a dotted address (e.g. boi.17c.415a.$comp.display-1)

string

The component’s name, or a dotted address (e.g. boi.17c.415a.$comp.display-1)

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

component

required

string

interfaces

required

Array<object> | null

object

endpoint

The probed endpoint (target[:port]) from the interface params

string

history

required

The recent verdict transitions, oldest first, for the availability strip

Array<object> | null

object

required

string format: date-time

value

required

string

interface

required

The interface’s derived name (its protocol)

string

interface_type

required

The interface type (icmp, tcp, …)

string

label

The friendly string an operator reads; absent when unset, and the row then reads the derived name verbatim

string

layers

required

The per-layer probe signals that compose the verdict

Array<object> | null

object

check

required

The property_type key of the primary signal

string

detail

A human timing detail (rtt / connect time), when present

string

layer

required

The probe layer word (ping, port)

string

required

When the signal was observed

string format: date-time

value

required

The latest signal value (1 = reachable/open, 0 = not)

number format: double

node

The node that probes this interface

string

verdict

required

The latest reachability verdict, or null if none yet

object

required

When the verdict was observed

string format: date-time

value

required

The latest stored verdict value (up/down)

string

Example

{
  "$schema": "/api/v1/schemas/ReachabilityOutputBody.json"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}