Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Reolink Alarm API

Motion detection, audio alarms, and detection zone configuration

Reolink Alarm API is one of 11 APIs that Reolink publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include Alarm. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 9 JSON Schemas.

This API exposes 7 operations across 7 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 8.0.

Requests are made against a single base URL, https://{camera_ip}.

7 operations 7 paths 3 schemas 7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.0
Server
https://{camera_ip}
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Reolink Alarm API declares 1 security scheme for authenticating requests. An API key is passed in the query as token (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Authentication token obtained from the Login command. Pass as a query parameter on all requests after authentication.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 POST. Each is listed below with its method, path, parameters, and response codes.

Alarm 7

Motion detection, audio alarms, and detection zone configuration

POST
/cgi-bin/api.cgi?cmd=GetMdAlarm&token={token}
Get motion detection alarm settings
getMdAlarm 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=SetMdAlarm&token={token}
Set motion detection alarm settings
setMdAlarm 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetAiAlarm&token={token}
Get AI detection alarm settings
getAiAlarm 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=SetAiAlarm&token={token}
Set AI detection alarm settings
setAiAlarm 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetAlarmArea&token={token}
Get alarm detection area
getAlarmArea 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=SetAlarmArea&token={token}
Set alarm detection area
setAlarmArea 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetAudioAlarm&token={token}
Get audio alarm settings
getAudioAlarm 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CommandResponse (4 properties), CommandRequest (3 properties), ChannelRequest (3 properties). Each schema is shown below with its type and property counts.

ChannelRequest
object
3 properties 3 required
CommandRequest
object
3 properties 2 required
CommandResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reolink-alarm-api-openapi.yml Raw ↑

Other APIs Reolink publishes across the network.

Reolink AI API
Reolink Authentication API
Reolink Encoding API
Reolink LED API
Reolink Network API
Reolink PTZ API
Reolink Recording API
Reolink Security API
Reolink System API
Reolink Video API