Summary
Checks if a specific gateway connection is healthy
Description
Given the cluster ID of an gateway connection, this endpoint will return the health status of the device
Route
GET /gateway_manager/v1/connections/:clusterId
Roles
gateway:read
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| clusterId |
string |
yes |
The cluster ID of the specific gateway connection |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
string |
The result of the device health status check returned from the device itself |
Copied to Clipboard
{
"id": "670fc09db12a3c6c180db1a7",
"jsonrpc": "2.0",
"result": {
"reply": "Health test from GatewayManager"
},
"receiveTime": 1729085597352,
"status": "success"
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"670fc09db12a3c6c180db1a7"
]
},
"jsonrpc": {
"type": "string",
"examples": [
"2.0"
]
},
"result": {
"type": "object",
"properties": {
"reply": {
"type": "string",
"examples": [
"Health test from GatewayManager"
]
}
}
},
"receiveTime": {
"type": "integer",
"examples": [
1729085597352
]
},
"status": {
"type": "string",
"examples": [
"success"
]
}
},
"additionalProperties": false
}
