# Agent DVR API

**Canonical:** https://apis.io/apis/ispyconnect-com/ispyconnect-com-api/  
**Provider:** Agent DVR — https://apis.io/providers/ispyconnect-com/  
**Documentation:** https://ispysoftware.github.io/Agent_API

Agent DVR API is one of 2 APIs that [Agent DVR](https://apis.io/providers/ispyconnect-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. The published artifact set on APIs.io includes an OpenAPI specification.

Agent DVR API as documented publicly: 97 operations. Contract generated from the documentation by API Evangelist (2026-11-12); not the provider's own document.

## Operations (60 of 97)

| Method | Path | Summary |
|---|---|---|
| GET | `/alerts.json` | Returns collection of the current alerts |
| GET | `/audio.mp3` | Returns live audio from the specified microphone in mp3 format |
| GET | `/audio.ogg` | Returns live audio from the specified microphone in ogg format |
| GET | `/audio.wav` | Returns live audio from the specified microphone in wav format |
| GET | `/command/addfolder` | Add existing files from the devices folder to the database |
| GET | `/command/addrecording` | Add an existing recording to a device |
| GET | `/command/alert` | Trigger alert on the device. |
| GET | `/command/alertOff` | Turn alerts off for the device. |
| GET | `/command/alertOn` | Turn alerts on for the device. |
| GET | `/command/alertsOff` | Turn alerts off for the device and publish the MQTT state. |
| GET | `/command/alertsOn` | Turn alerts on for the device and publish the MQTT state. |
| GET | `/command/allOff` | Switch all devices off |
| GET | `/command/allOn` | Switch all devices on |
| GET | `/command/appendtimestamp` | Appends text to the devices default timestamp |
| GET | `/command/applySchedule` | Apply schedule to all devices. |
| GET | `/command/applyScheduleToDevice` | Apply schedule to a device, group or location. |
| GET | `/command/areaapply` | Apply a named detection zone map to a camera |
| GET | `/command/arm` | Arm the system. |
| GET | `/command/armProfile` | Arm the system and apply the specified profile. |
| GET | `/command/armgroups` | Arm system and groups of devices (enable alerts) |
| GET | `/command/blockExternal` | Block external access to the system. |
| GET | `/command/broadcast` | Send a broadcast message to all connected clients (7910+) |
| GET | `/command/checkRemote` | Check the status of the remote (web) connection |
| GET | `/command/cloudPhotosOff` | Turn cloud photos off for the device. |
| GET | `/command/cloudPhotosOn` | Turn cloud photos on for the device. |
| GET | `/command/cloudRecordingsOff` | Turn cloud recordings off for the device. |
| GET | `/command/cloudRecordingsOn` | Turn cloud recordings on for the device. |
| GET | `/command/deletephoto` | Delete photos by filename (7780+) |
| GET | `/command/deleterecording` | Delete recordings by filename (7780+) |
| GET | `/command/detect` | Trigger motion (or sound) detection on the device. |
| GET | `/command/detectorOff` | Turn the motion (or sound) detector off for the device. |
| GET | `/command/detectorOn` | Turn the motion (or sound) detector on for the device. |
| GET | `/command/disarm` | Disarm the system. |
| GET | `/command/disarmProfile` | Disarm the system and apply the specified profile. |
| GET | `/command/disarmgroups` | Disarm groups of devices (disable alerts) |
| GET | `/command/facedetectoff` | Turn facial recognition off |
| GET | `/command/facedetecton` | Turn facial recognition on |
| GET | `/command/ftpFrame` | Send a live frame via FTP. |
| GET | `/command/ftpPhotosOff` | Turn FTP photos off for the device. |
| GET | `/command/ftpPhotosOn` | Turn FTP photos on for the device. |
| GET | `/command/ftpRecordingsOff` | Turn FTP recordings off for the device. |
| GET | `/command/ftpRecordingsOn` | Turn FTP recordings on for the device. |
| GET | `/command/getObject` | Get object by ID. |
| GET | `/command/getObjects` | Get the configuration of all devices |
| GET | `/command/getProfiles` | List the configured profiles |
| GET | `/command/getStatus` | Get the server status |
| GET | `/command/getSystemStats` | Return the system usage stats |
| GET | `/command/getptzpreset` | Get the active PTZ preset (7.7.8.0+) |
| GET | `/command/lproff` | Turn lpr off |
| GET | `/command/lpron` | Turn LPR on |
| GET | `/command/objectdetectoff` | Turn object recognition off |
| GET | `/command/objectdetecton` | Turn object recognition on |
| GET | `/command/ping` | Check the server is running |
| GET | `/command/playsound` | Play one of the server's sound files through a camera's speaker now |
| GET | `/command/pluginCommand` | Send a command to the plugin configured on a device |
| GET | `/command/ptzpreset` | Move the camera to a PTZ preset by name (7.7.8.0+) |
| GET | `/command/ptzpresets` | List the camera PTZ presets (7.7.8.0+) |
| GET | `/command/ptzscheduleoff` | disable the ptz scheduler or disable a specific ptz schedule entry (5.9.4.0+) |
| GET | `/command/ptzscheduleon` | enable the ptz scheduler or enable a specific ptz schedule entry (5.9.4.0+) |
| GET | `/command/record` | Start recording for the device. |

…and 37 more operations. They are listed in full on the page.

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/ispyconnect-com/openapi/_ae-authored/ispyconnect-com-openapi-generated.yml

## Other Agent DVR APIs (1)

- [Agent DVR API](https://apis.io/apis/ispyconnect-com/agent-dvr/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/ispyconnect-com/ispyconnect-com-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/ispyconnect-com/.