Armis SDK for Python 3.9+

The Armis SDK is a package that encapsulates common use-cases for interacting with the Armis platform.

Installation

Use your favourite package manager to install the SDK, for example:

pip install armis_sdk

Documentation

For full documentation, please visit our dedicated site.

Usage

All interaction with the SDK happens through the ArmisSdk class. You'll need five things:

Audience: The url of the tenant you want to interact with, including trailing slash (e.g. https://acme.armis.com/).
Client ID: The email address of the user account within the tenant that was used to generate the Client Secret.
Client Secret: The confidential credential generated by your customer within Armis, paired with the Client ID.
Vendor ID: An identifier unique to your developer account or integration, obtained when you register on our developer portal.
Scopes: The specific permissions required by your access token to interact with the desired API endpoints.

You can either provide these values using the environment variables ARMIS_AUDIENCE, ARMIS_CLIENT_ID, ARMIS_CLIENT_SECRET, ARMIS_VENDOR_ID, and ARMIS_CLIENT_ID:

from armis_sdk import ArmisSdk

armis_sdk = ArmisSdk()

or by passing them explicitly:

from armis_sdk import ArmisSdk
from armis_sdk import ClientCredentials

credentials = ClientCredentials(
    audience="<audience>",
    client_id="<client_id>",
    client_secret="<client_secret>",
    vendor_id="<vendor_id>",
    scopes=["scope1", "scope2"],
)
armis_sdk = ArmisSdk(credentials=credentials)

[!TIP] If you're building an application that interacts with multiple tenants, you can populate only the ARMIS_VENDOR_ID and ARMIS_SCOPES environment variable and pass the audience, client_id and client_secret explicitly:
from armis_sdk import ArmisSdk
from armis_sdk import ClientCredentials

credentials = ClientCredentials(
    audience="<audience>",
    client_id="<client_id>",
    client_secret="<client_secret>",
)
armis_sdk = ArmisSdk(credentials=credentials)

Entity clients

Once you have an instance of ArmisSdk, you can start interacting with the various clients. Each handles use-cases of a specific entity.

[!NOTE] Note that all functions in this SDK that eventually make HTTP requests are asynchronous.

However, for convenience, all public asynchronous functions can also be executed in a synchronous way.

For example, if you want to update a site's location:

import asyncio

from armis_sdk import ArmisSdk
from armis_sdk.entities.site import Site

armis_sdk = ArmisSdk()

async def main():
    site = Site(id=1, location="new location")
    await armis_sdk.sites.update(site)

asyncio.run(main())

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

armis_sdk-1.2.3.tar.gz (21.1 kB view details)

Uploaded Aug 18, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

armis_sdk-1.2.3-py3-none-any.whl (33.8 kB view details)

Uploaded Aug 18, 2026 Python 3

File details

Details for the file armis_sdk-1.2.3.tar.gz.

File metadata

Download URL: armis_sdk-1.2.3.tar.gz
Upload date: Aug 18, 2026
Size: 21.1 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for armis_sdk-1.2.3.tar.gz
Algorithm	Hash digest
SHA256	`6d5e8e34a8a37b92e81598175f52aec7df076fb9af1272615096f15a56ecf78d`
MD5	`b6266e475bbaac45340ef7f416ebc032`
BLAKE2b-256	`510fcbb96e375841030f5a7a8b4bf4e8af4101b57a0c836136d8f16f33e18841`

See more details on using hashes here.

Provenance

The following attestation bundles were made for armis_sdk-1.2.3.tar.gz:

Publisher: publish.yml on ArmisSecurity/armis-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: armis_sdk-1.2.3.tar.gz
- Subject digest: 6d5e8e34a8a37b92e81598175f52aec7df076fb9af1272615096f15a56ecf78d
- Sigstore transparency entry: 2500952548
- Sigstore integration time: Aug 18, 2026
Source repository:
- Permalink: ArmisSecurity/armis-sdk-python@d8a406c9314b7c3ad1bae75a218dd52b6da7c45a
- Branch / Tag: refs/heads/master
- Owner: https://github.com/ArmisSecurity
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@d8a406c9314b7c3ad1bae75a218dd52b6da7c45a
- Trigger Event: repository_dispatch