Tools

Utility endpoints to keep your integration running smoothly. Use these for health checks, monitoring, and diagnostics.

GET /System/Echo

Lightweight health check to confirm the service is reachable.

Use case: CI/CD or monitoring pings the API and alerts on failures.

const baseUrl = 'https://api.hlc.bike/us/v3.0'

const res = await fetch(`${baseUrl}/System/Echo`)
if (!res.ok) throw new Error(`Echo failed: ${res.status}`)

const body = await res.text()

Response

Returns a simple text response confirming the service is alive:

HLC API is running