Classic Alarms¶

Classic Alarms API client and functional wrappers for pykada.

The ClassicAlarmsClient provides access to alarm device inventory and alarm site information through Verkada’s Classic Alarms API.

Client¶

class pykada.classic_alarms.ClassicAlarmsClient(api_key=None, token_manager=None)[source]¶

Bases: BaseClient

Client for interacting with Verkada’s Classic Alarms API. This client provides methods to retrieve alarm devices and site information.

Initialize the client with either an API key or a token manager. If not key is provided, a default token manager will be used based on the environment configuration (VERKADA_API_KEY in a .env file).

Parameters:

api_key (Optional[str]) – Optional API key for authentication.
token_manager (Optional[VerkadaTokenManager]) – Optional token manager for handling tokens.

get_alarm_devices(site_id, device_ids=None)[source]¶

Retrieve alarm devices for a given site.

Gets information about all devices in an alarm site specified by site_id. Optionally, a subset of devices can be returned by providing a list of device IDs.

Parameters:

site_id (str) – The unique identifier for the site. (Required)
device_ids (Optional[List[str]]) – Optional list of device unique identifiers to filter the results.

Return type:

Dict[str, Any]

Returns:

JSON response containing device information.

Raises:

ValueError – If site_id is an empty string.

get_alarm_site_information(site_ids=None)[source]¶

Retrieve information about alarm sites.

Returns information about a list of alarm sites. If no site_ids are provided, information on all sites will be returned.

Parameters:: site_ids (Optional[List[str]]) – Optional list of site unique identifiers.
Return type:: Dict[str, Any]
Returns:: JSON response containing site information.

property request_manager: VerkadaRequestManager¶: Returns the request manager used by this client.

Functional wrappers¶

Classic Alarms API client and functional wrappers for pykada.

The ClassicAlarmsClient provides access to alarm device inventory and alarm site information through Verkada’s Classic Alarms API.

pykada.classic_alarms.get_alarm_devices(site_id, device_ids=None)[source]

Retrieve alarm devices for a given site.

Gets information about all devices in an alarm site specified by site_id. Optionally, a subset of devices can be returned by providing a list of device IDs.

Parameters:

site_id (str) – The unique identifier for the site. (Required)
device_ids (Optional[List[str]]) – Optional list of device unique identifiers to filter the results.

Returns:

JSON response containing device information.

Raises:

ValueError – If site_id is an empty string.

—

Note: This is a functional wrapper for its equivalent method in the ClassicAlarmsClient. It creates a new client instance on every call, making it best for single, convenient operations. For making multiple API calls, instantiate and use an ClassicAlarmsClient object directly for better performance.

pykada.classic_alarms.get_alarm_site_information(site_ids=None)[source]

Retrieve information about alarm sites.

Returns information about a list of alarm sites. If no site_ids are provided, information on all sites will be returned.

Parameters:: site_ids (Optional[List[str]]) – Optional list of site unique identifiers.
Returns:: JSON response containing site information.

—