Skip to main content

ACE-X Client

Synchronous Python client for the ACE-X backend.

Installation

pip install acex-client

Quick start

from acex_client import Acex

with Acex(base_url="https://acex.local") as client:
    result = client.inventory.sites.query(name="stockholm")
    for site in result:
        print(site.id, site.name)

Auth is auto-detected from /auth/config. Override via env vars:

  • ACEX_BASE_URL — backend URL
  • ACEX_ISSUER_URL, ACEX_CLIENT_ID, ACEX_CLIENT_SECRET — OIDC override
  • ACEX_VERIFY_SSL=false — disable TLS verification

or inject an AuthProvider directly:

from acex_client.auth import ClientCredentialsAuth

auth = ClientCredentialsAuth(client_id="...", client_secret="...", issuer_url="...", verify_ssl=True)
with Acex(base_url="...", auth=auth) as client:
    ...

Namespaces

Namespace Resources / actions
client.inventory sites, regions, region_assignments, contacts, contact_assignments, assets, asset_clusters, collection_agents, credentials, logical_nodes, management_connections, node_instances, node_credentials(node_id), site_credentials(site_name)
client.observability agents (with bound outputs, rules, nodes), grafana
client.operations compliance (.check(), .site()), config_history.list_changes(), lldp (.upload(), .topology(), .by_site(), .get(), .reverse())
client.config_components catalog(), generate(), reconcile(), drivers(), translate()
client.neds list(), get(), download()
client.ai ask(), analyze() (SSE-streamed) — None if backend has no ai_ops mounted
client.system auth_config(), health_node(), health_site()

CRUD pattern

Each resource inherits the mixins for the verbs it supports. All mutations return a LiveInstance proxy that holds the Pydantic model; .save() diffs against the original and PATCHes only changed fields, .delete() removes the resource:

site = client.inventory.sites.create(name="stockholm", city="SE")
site.display_name = "Stockholm HQ"
site.save()  # PATCH /inventory/sites/{id} with {display_name: ...}
site.delete()  # DELETE /inventory/sites/{id}

get, update, create, delete all raise AcexNotFoundError on HTTP 404 rather than returning None — wrap in try/except for "if exists" flows.

Actions and sub-resources

Action methods use @action(method, path_template):

client.inventory.collection_agents.manifest(id=1)
client.inventory.collection_agents.ack(id=1, payload=CollectionAgentAck(config_revision=5))

CVE payload models format their date fields as ISO 8601 strings when dumped, so they work with the standard client actions without custom request handling.

Bound sub-resources are accessed via .parent_or_id:

client.inventory.collection_agents.rules(1).create(region="eu")

Via a LiveInstance, the bound sub-resource is exposed as an attribute:

agent = client.observability.agents.get(1)
agent.rules.create(region="eu")

Errors

from acex_client import (
    AcexNotFoundError,
    AcexValidationError,
    AcexAuthError,
    AcexPermissionError,
    AcexServerError,
    AcexTimeoutError,
    AcexConnectionError,
)

All errors inherit from AcexError. HTTP errors carry status_code and body attributes.

Examples

See examples/crud.py and examples/observe.py.

Metadata

Release files for acex-client 4.12.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for acex-client 4.12.0
File Size Uploaded Provenance Actions
acex_client-4.12.0.tar.gz 34.5 kB With provenance Details for acex_client-4.12.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for acex-client 4.12.0
File Interpreter ABI Platform Actions
acex_client-4.12.0-py3-none-any.whl Python 3 none any Details for acex_client-4.12.0-py3-none-any.whl

Total release size: 85.8 kB

Release files / acex_client-4.12.0.tar.gz

Download URL acex_client-4.12.0.tar.gz
Size 34.5 kB
Tags Source
SHA-256 checksum
How to use checksums
3518a1aa8e783eb142985f48ef7d35768478339a7fe66cb7e3389cd16e37c4b7
BLAKE2b-256 checksum
How to use checksums
086e2874baba73a2696c3bd2034c895e1f3493e70c9fb222834897c222a58c3c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Release files / acex_client-4.12.0-py3-none-any.whl

Download URL acex_client-4.12.0-py3-none-any.whl
Size 51.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0f1eee52bda35a34949201ec1bcad7aa3c440c8ddead8ca7f1bd0c4798711417
BLAKE2b-256 checksum
How to use checksums
e3ec6477ec30e34a780ee43e1b4374c9794c22ff77e6d5efb4d5bf13f27cc261
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Security for acex-client 4.12.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for acex_client-4.12.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page