pjdev-armis-sdk 5.1.5

Async Python SDK for the Armis API

pjdev-armis-sdk

---

Async Python SDK for the Armis API, built on httpx and pydantic.

Table of Contents

• Installation
• Usage
• License

Installation

pip install pjdev-armis-sdk

Usage

Configure once at startup (reads from environment variables prefixed with ARMIS_):

from pjdev_armis_sdk import config_service

config_service.init(
    instance_url="https://your-tenant.armis.com",
    secret_key="your-secret-key",
)

Then call any of the resource modules:

from pjdev_armis_sdk import devices, search

# AQL search
result = await search.aql_search("in:devices type:MOBILE_PHONE")

# Lookup a single device by id
device = await devices.get_device(id=12345)

Auth (Authorization header with a temporary access token) is handled automatically by the underlying httpx.AsyncClient. Tokens are refreshed on the fly when they expire or when the API returns 401.

License

pjdev-armis-sdk is distributed under the terms of the MIT license.