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 System API

Device information, maintenance, time settings, firmware, and storage

Reolink System 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 System. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 9 JSON Schemas.

This API exposes 12 operations across 12 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}.

12 operations 12 paths 3 schemas 12 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 System 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 12

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

System 12

Device information, maintenance, time settings, firmware, and storage

POST
/cgi-bin/api.cgi?cmd=GetDevInfo&token={token}
Get device information
getDevInfo 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetAbility&token={token}
Get user abilities and permissions
getAbility 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetTime&token={token}
Get device time
getTime 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=SetTime&token={token}
Set device time
setTime 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetHddInfo&token={token}
Get storage information
getHddInfo 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=FormatHdd&token={token}
Format storage drive
formatHdd 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=Reboot&token={token}
Reboot the device
reboot 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetDevName&token={token}
Get device name
getDevName 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=SetDevName&token={token}
Set device name
setDevName 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetAutoMaint&token={token}
Get automatic maintenance settings
getAutoMaint 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetAutoUpgrade&token={token}
Get auto upgrade settings
getAutoUpgrade 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetChannelStatus&token={token}
Get channel status
getChannelStatus 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), DevInfoResponse (3 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reolink-system-api-openapi.yml Raw ↑

Other APIs Reolink publishes across the network.

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