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

Pan-tilt-zoom control, presets, patrols, and calibration

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

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

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

9 operations 9 paths 4 schemas 9 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 PTZ 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 9

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

PTZ 9

Pan-tilt-zoom control, presets, patrols, and calibration

POST
/cgi-bin/api.cgi?cmd=PtzCtrl&token={token}
Control PTZ movement
ptzCtrl 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetPtzPreset&token={token}
Get PTZ presets
getPtzPreset 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=SetPtzPreset&token={token}
Set PTZ preset position
setPtzPreset 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetPtzPatrol&token={token}
Get PTZ patrol settings
getPtzPatrol 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=SetPtzPatrol&token={token}
Set PTZ patrol configuration
setPtzPatrol 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=PtzCheck&token={token}
Calibrate PTZ
ptzCheck 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetPtzCheckState&token={token}
Get PTZ calibration status
getPtzCheckState 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetAutoTrack&token={token}
Get auto-tracking settings
getAutoTrack 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=SetAutoTrack&token={token}
Set auto-tracking settings
setAutoTrack 1 param body → 200

Schemas 4

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reolink-ptz-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 Recording API
Reolink Security API
Reolink System API
Reolink Video API