Skip to content
CanaroCanaroCanaro Docs

Overview

Canaro External API v1

Section titled “Canaro External API v1”

Read access to a Canaro workspace for server-to-server integrations.

Authenticate every request with a workspace API key in an Authorization: Bearer header. Keys are created in the Canaro dashboard under Settings → API, carry the scopes you grant them, and reach nothing outside this API.

Every refusal is a JSON object with a single error member carrying a machine-readable code and a human-readable message.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/devices
GET
/devices/{device_id}
GET
/devices/{device_id}/telemetry
GET
/alerts
GET
/alerts/{alert_id}
GET
/account

Authentication

Section titled “Authentication”

WorkspaceApiKey

Section titled “WorkspaceApiKey”

A workspace API key, created in the Canaro dashboard under Settings -> API.

Security scheme type: http

Bearer format: opaque