Skip to main content

Non-official Control D API for Python

Project description

PyCtrlD

Python 3.10+License: MIT

A unofficial Python client library for the Control D API.

What not supported?

Organizations endpoint and features are not tested and may not work as expected.

Installation

pip install pyctrld

Or with uv:

uv add pyctrld

Quick Start

from pyctrld import ControlDApi

# Initialize the API client
api = ControlDApi(token="your_api_token_here")

# List all devices
devices = api.devices.list_all_devices()
for device in devices:
    print(f"Device: {device.name} - {device.status}")

# Get account information
account = api.accounts.fetch()
print(f"Account: {account.email}")

# List all profiles
profiles = api.profiles.profiles.list()
for profile in profiles:
    print(f"Profile: {profile.name}")

# Create a new device
from pyctrld import CreateDeviceFormData

new_device = api.devices.create(
    data=CreateDeviceFormData(
        name="My DNS Device",
        icon="router",
        profile_id="PK123456"
    )
)
print(f"Created device with ID: {new_device.device_id}")

Disclaimer

This is an unofficial library and is not affiliated with, officially maintained by, or endorsed by Control D. Use at your own risk.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Links

Support

If you encounter any issues or have questions:

  1. Check the GitHub Issues
  2. Review the Control D API Documentation
  3. Open a new issue with detailed information about your problem

Project details


Download files

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

Source Distribution

pyctrld-0.1.0.tar.gz (32.9 kB view details)

Uploaded Source

Built Distribution

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

pyctrld-0.1.0-py3-none-any.whl (52.1 kB view details)

Uploaded Python 3

File details

Details for the file pyctrld-0.1.0.tar.gz.

File metadata

  • Download URL: pyctrld-0.1.0.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyctrld-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ba9ac2922ff11d9013983ebb9e4187b31f3e81975b19c4a862ccb3a899acca7e
MD5 b22c86fb42397026eea33a1e78480755
BLAKE2b-256 5bf502a052aee8bb224b431354ecb85b381ec150a578577877423667dc82eb53

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyctrld-0.1.0.tar.gz:

Publisher: publish_release_to_pypi.yml on xenolex/PyCtrlD

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

File details

Details for the file pyctrld-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pyctrld-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 52.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyctrld-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 90dce629beb8f5da8c3512f2e6b4e0f6466d38e8c9cb2a1e0bf9c25a1983e024
MD5 bd5ac4aa3e55f04a700ad40b00e75ead
BLAKE2b-256 42747d7107fb3fbb528813442b381d1eb8631a80dec9abb68662ceb8002c37a0

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyctrld-0.1.0-py3-none-any.whl:

Publisher: publish_release_to_pypi.yml on xenolex/PyCtrlD

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page