Camera API Tab
https://sec-cam.timeline.is/help/cameras/api-tab
Last updated: November 16, 2026
Table of Contents

Camera API Tab

Every camera page has an API tab that surfaces what the TetherBox knows about the camera over its native API and ONVIF, plus actions to refresh that state and remotely reboot the camera.

To open it, go to Admin > Cameras > [select camera] > API.


 API Status

The top of the tab shows a status badge for each protocol the TetherBox uses to talk to the camera:

  • ONVIF API - the standardised protocol used as a fallback for vendors we do not have a native integration with
  • Native API - the manufacturer's own protocol, used when we have a dedicated integration (Hikvision, Dahua, Axis, Hanwha, Uniview and others)

Possible states:

State Meaning
OK TetherBox is communicating with the camera over this API
Disabled The protocol is turned off on the camera or in the camera settings
Unauthorised Wrong username or password, or insufficient privileges for that user
User Locked The camera has temporarily blocked the account after too many failed logins. See Camera Troubleshooting
Not Available The camera does not advertise this protocol

Tip: A camera only needs one of these APIs to be OK. Native usually exposes more capabilities; ONVIF is the universal fallback. See How to Enable ONVIF if both are missing.


 Refresh Capabilities

Re-runs the discovery process against the camera. Use this after changing camera firmware, enabling ONVIF, or swapping the camera behind the same IP. The page updates with the new profiles, capabilities, and device info.


 Reboot Camera

Issues a remote reboot to the camera or recorder. The TetherBox uses the manufacturer's native API where it has an integration and falls back to ONVIF SystemReboot where it does not, so the action works on virtually any modern IP camera and on supported NVRs/DVRs added to the platform.

API tab showing the API Status card with the Reboot Camera button highlighted

The button requires hold-to-confirm to avoid accidental reboots. The camera typically takes one to three minutes to come back online; the Cameras page will show it as offline during that window and back to online once it has finished booting.

Note: The Reboot Camera button is only available on TetherBox software version 5.99 and later. Older units will only show the API status and profiles. See TetherBox Firmware Updates.


 Settings Cards

Below the status, the tab shows one card for each topic the camera reports, such as device information, time, storage, security, privacy masks and on-screen display. Cards sit in a two-column grid on a wide screen and stack on a narrow one. Each card has its own refresh button, so you can re-read one topic without reloading the whole tab.

Where the camera lets the TetherBox change a setting, you edit it in place on its card. The value is limited to the choices the camera itself accepts, and the TetherBox reads it back from the camera to confirm the change took effect.

A setting that is locked is read-only, and a hint beside it says why: the camera does not allow the change, the model does not keep it, or the TetherBox software on the unit is too old to make it. Updating the TetherBox (see TetherBox Firmware Updates) fixes the last case.


 Firmware Status

The Firmware status card shows:

  • Installed firmware - the version the camera reports
  • Build date - when that firmware was built
  • Latest on file - the newest firmware TetherX holds for this model, marked Up to date or Update available, or a note that no firmware is on file for the model
  • Upgrade state - whether an upgrade is running

A value the camera does not report is shown as Not reported. The upgrade flag and online upgrade details sit under Technical details. To upgrade, use the Firmware card under Troubleshooting. The Latest on file row is shown only to people who are allowed to upgrade.


 Strobe and Siren

The camera's strobe light and siren controls appear on the tab when the camera has them. If the TetherBox cannot read the camera's outputs (for example the camera refused a login at that moment), it keeps showing the last strobe and siren it did read, marked Unconfirmed since a time, with the reason. Treat those controls as last known: they may not work until the next successful read.


 Profiles

Lists every stream profile the camera advertises, with encoding, resolution, frame rate, bitrate, key frame interval, and audio capability. Click a profile to expand the full capability detail and copy the RTSP URI.

This is the same data the TetherBox uses when picking which streams to record and analyse, so it is the quickest way to confirm a camera is exposing the streams you expect.


Last updated: November 16, 2026