Skip to main content
GET
/
v1
/
network-health
Get network health summary
curl --request GET \
  --url https://sandbox-api.borderless.xyz/v1/network-health \
  --header 'Authorization: Bearer <token>'
[
  {
    "namespace": "bridge",
    "overallStatus": "Operational",
    "componentsTotal": 123,
    "componentsOperational": 123,
    "lastEventAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json
​
namespace
string
required

Namespace identifier

Example:

"bridge"

​
overallStatus
enum<string>
required

Worst status across all components

Available options:
Operational,
DegradedPerformance,
PartialOutage,
MajorOutage,
UnderMaintenance
​
componentsTotal
number
required

Total number of monitored components

​
componentsOperational
number
required

Number of operational components

​
lastEventAt
string<date-time>

Timestamp of the last event