Skip to main content

zeronetworks

Developer-friendly & type-safe Python SDK specifically catered to leverage zeronetworks API.

Built by Speakeasy License: MIT



Summary

Zero Networks: APIs for Zero Networks

Table of Contents

SDK Installation

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add git+<UNSET>.git

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install git+<UNSET>.git

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add git+<UNSET>.git

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from zeronetworks python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.10"
# dependencies = [
#     "zeronetworks",
# ]
# ///

from zeronetworks import Zeronetworks

sdk = Zeronetworks(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

SDK Example Usage

Example

# Synchronous Example
import os
from zeronetworks import Zeronetworks


with Zeronetworks(
    api_key=os.getenv("ZERONETWORKS_API_KEY"),
) as z_client:

    res = z_client.assets.assets_search(fqdn="server.domain.local")

    # Handle response
    print(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
import os
from zeronetworks import Zeronetworks

async def main():

    async with Zeronetworks(
        api_key=os.getenv("ZERONETWORKS_API_KEY"),
    ) as z_client:

        res = await z_client.assets.assets_search_async(fqdn="server.domain.local")

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
api_key apiKey API key ZERONETWORKS_API_KEY

To authenticate with the API the api_key parameter must be set when initializing the SDK client instance. For example:

import os
from zeronetworks import Zeronetworks


with Zeronetworks(
    api_key=os.getenv("ZERONETWORKS_API_KEY"),
) as z_client:

    res = z_client.assets.assets_search(fqdn="server.domain.local")

    # Handle response
    print(res)

Available Resources and Operations

Available methods

AEExclusions

Assets

GroupsCustom

InternalAccessPolicy

MFAInbound

MFAOutbound

RulesInbound

RulesOutbound

RulesRPC

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

import os
from zeronetworks import Zeronetworks
from zeronetworks.utils import BackoffStrategy, RetryConfig


with Zeronetworks(
    api_key=os.getenv("ZERONETWORKS_API_KEY"),
) as z_client:

    res = z_client.assets.assets_search(fqdn="server.domain.local",
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

import os
from zeronetworks import Zeronetworks
from zeronetworks.utils import BackoffStrategy, RetryConfig


with Zeronetworks(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    api_key=os.getenv("ZERONETWORKS_API_KEY"),
) as z_client:

    res = z_client.assets.assets_search(fqdn="server.domain.local")

    # Handle response
    print(res)

Error Handling

ZeronetworksError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
err.message str Error message
err.status_code int HTTP response status code eg 404
err.headers httpx.Headers HTTP response headers
err.body str HTTP body. Can be empty string if no body is returned.
err.raw_response httpx.Response Raw HTTP response
err.data Optional. Some errors may contain structured data. See Error Classes.

Example

import os
from zeronetworks import Zeronetworks, errors


with Zeronetworks(
    api_key=os.getenv("ZERONETWORKS_API_KEY"),
) as z_client:
    res = None
    try:

        res = z_client.assets.assets_search(fqdn="server.domain.local")

        # Handle response
        print(res)


    except errors.ZeronetworksError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.Error):
            print(e.data.error)  # Optional[str]
            print(e.data.message)  # Optional[str]

Error Classes

Primary errors:

Less common errors (6)

Network errors:

Inherit from ZeronetworksError:

  • StaleConflictError: Conflict - the object was modified or deleted since the zn-expected-updated-at value. Status code 409. Applicable to 16 of 40 methods.*
  • ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Server Variables

The default server https://portal.zeronetworks.com/v1/api contains variables and is set to https://portal.zeronetworks.com/v1/api by default. To override default values, the following parameters are available when initializing the SDK client instance:

Variable Parameter Default Description
CustomerURL customer_url: str "portal" this value is per customer / partner

Example

import os
from zeronetworks import Zeronetworks


with Zeronetworks(
    server_idx=0,
    customer_url="portal",
    api_key=os.getenv("ZERONETWORKS_API_KEY"),
) as z_client:

    res = z_client.assets.assets_search(fqdn="server.domain.local")

    # Handle response
    print(res)

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

import os
from zeronetworks import Zeronetworks


with Zeronetworks(
    server_url="https://portal.zeronetworks.com/v1/api",
    api_key=os.getenv("ZERONETWORKS_API_KEY"),
) as z_client:

    res = z_client.assets.assets_search(fqdn="server.domain.local")

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from zeronetworks import Zeronetworks
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Zeronetworks(client=http_client)

or you could wrap the client with your own custom logic:

from zeronetworks import Zeronetworks
from zeronetworks.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Zeronetworks(async_client=CustomClient(httpx.AsyncClient()))

httpx2 (Pydantic's httpx fork)

httpx2 is Pydantic's maintained fork of httpx. To run this SDK on httpx2, call alias_httpx() at your program's entry point, before importing the SDK, so every import httpx — including the ones inside the SDK — resolves to httpx2:

import httpx2

httpx2.alias_httpx()

from zeronetworks import Zeronetworks

s = Zeronetworks()

An SDK can also be generated against httpx2 directly, so it depends on the fork instead of httpx, by setting python.httpClientLibrary: httpx2 in gen.yaml.

Resource Management

The Zeronetworks class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

import os
from zeronetworks import Zeronetworks
def main():

    with Zeronetworks(
        api_key=os.getenv("ZERONETWORKS_API_KEY"),
    ) as z_client:
        # Rest of application here...
        pass


# Or when using async:
async def amain():

    async with Zeronetworks(
        api_key=os.getenv("ZERONETWORKS_API_KEY"),
    ) as z_client:
        # Rest of application here...
        pass

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from zeronetworks import Zeronetworks
import logging

logging.basicConfig(level=logging.DEBUG)
s = Zeronetworks(debug_logger=logging.getLogger("zeronetworks"))

You can also enable a default debug logger by setting an environment variable ZERONETWORKS_DEBUG to true, 1, yes or on (case-insensitive). Any other value leaves it off.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

Metadata

Release files for zeronetworks 1.1.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 zeronetworks 1.1.0
File Size Uploaded Provenance Actions
zeronetworks-1.1.0.tar.gz 117.9 kB Without provenance Details for zeronetworks-1.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for zeronetworks 1.1.0
File Interpreter ABI Platform Actions
zeronetworks-1.1.0-py3-none-any.whl Python 3 none any Details for zeronetworks-1.1.0-py3-none-any.whl

Total release size: 322.5 kB

Release files / zeronetworks-1.1.0.tar.gz

Download URL zeronetworks-1.1.0.tar.gz
Size 117.9 kB
Tags Source
SHA-256 checksum
How to use checksums
aa0a458041d78b35bfad3954c4f2f3f848e8dcd101c7982bd8b2248b18b7d216
BLAKE2b-256 checksum
How to use checksums
a2c3e8e9cf582b543765f5650a28ae7df97b940ea5a092926ae3efd0d10bd365
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Release files / zeronetworks-1.1.0-py3-none-any.whl

Download URL zeronetworks-1.1.0-py3-none-any.whl
Size 204.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d05d76b960cb188672a409f6c17cdf6b2f2b3b3d89e24ff21b2996aa12d822aa
BLAKE2b-256 checksum
How to use checksums
f9c2ae603016c395b7c6b4af0c3b09ad59e81d46b94b66602d9368b0fcb9f2d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Security for zeronetworks 1.1.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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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