API Reference

Bridges API

Get information about bridge devices at sites

Bridges API

Retrieve information about bridge devices that connect security systems to the CHeKT platform.

Endpoints Overview

Method	Endpoint	Description
GET	`/ext/v1/sites/{site_id}/bridges`	Get bridges information

Get Bridges Information

Retrieve all bridge devices at a site.

Endpoint

GET /ext/v1/sites/{site_id}/bridges

Request Example

curl -X GET "https://api.chektdev.com/ext/v1/sites/site_123abc/bridges" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response (200 OK)

{
  "data": {
    "bridges": [
      {
        "bridge_id": "bridge_abc123",
        "serial_number": "CHK-BRG-2024-001234",
        "model": "CHeKT Bridge Pro",
        "firmware_version": "2.4.1",
        "status": "online",
        "connection_type": "ethernet",
        "ip_address": "192.168.1.100",
        "mac_address": "00:1B:44:11:3A:B7",
        "signal_strength": 95,
        "uptime_seconds": 2592000,
        "last_seen": "2025-01-15T10:30:00Z",
        "capabilities": {
          "wifi": true,
          "ethernet": true,
          "cellular": false,
          "backup_battery": true
        },
        "health": {
          "cpu_usage": 35,
          "memory_usage": 48,
          "temperature_celsius": 42,
          "battery_level": 100
        }
      }
    ],
    "total_count": 1
  }
}

Bridge Fields

Field	Type	Description
`bridge_id`	string	Unique bridge identifier
`serial_number`	string	Device serial number
`model`	string	Bridge model name
`firmware_version`	string	Current firmware version
`status`	string	Connection status
`connection_type`	string	Active connection method
`ip_address`	string	Local IP address
`mac_address`	string	MAC address
`signal_strength`	integer	Signal strength (0-100)
`uptime_seconds`	integer	Seconds since last reboot
`last_seen`	string	Last communication timestamp

Bridge Status Values

Status	Description
`online`	Bridge is connected and operational
`offline`	Bridge is not responding
`degraded`	Bridge has connectivity issues
`updating`	Firmware update in progress
`error`	Bridge has an error condition
`rebooting`	Bridge is rebooting

Connection Types

Type	Description
`ethernet`	Wired Ethernet connection
`wifi`	Wireless WiFi connection
`cellular`	Cellular network connection
`backup`	Using backup connection

Health Metrics

CPU Usage

0-50%: Normal operation
51-75%: Moderate load
76-100%: High load (may affect performance)

Memory Usage

0-60%: Normal operation
61-80%: Moderate usage
81-100%: High usage (may require restart)

Temperature

0-50°C: Normal operating temperature
51-70°C: Elevated temperature
71°C+: Overheating (requires attention)

Battery Level

80-100%: Fully charged
50-79%: Good charge
20-49%: Low battery
0-19%: Critical battery (replace soon)

Troubleshooting

Bridge Offline

If a bridge shows offline status:

Check physical connections (power, network)
Verify network connectivity
Check for firmware updates
Contact support if issue persists

Poor Signal Strength

If signal strength is below 50:

Check WiFi router location
Reduce interference sources
Consider using Ethernet connection
Check for network congestion

High Temperature

If temperature exceeds 70°C:

Ensure adequate ventilation
Remove from direct sunlight
Check ambient room temperature
Clean any dust from vents

Alternative Endpoints

Using Reference ID

GET /ref/v1/sites/{account_reference_id}/bridges

Monitoring Best Practices

Regular Health Checks: Monitor bridge health metrics daily
Firmware Updates: Keep firmware up to date
Backup Connectivity: Configure backup connection methods
Alert Configuration: Set up alerts for offline bridges

Next Steps

Sites API - View site information
Webhook Events - Bridge event notifications
Zones API - Manage security zones