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.account.user_data()
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_device(
    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.5.tar.gz (33.0 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.5-py3-none-any.whl (52.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyctrld-0.1.5.tar.gz
  • Upload date:
  • Size: 33.0 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.5.tar.gz
Algorithm Hash digest
SHA256 829b6c3d9a718bd2c25db419039f61a829048517c9089c57813f245940261ba3
MD5 7f26ca45f6a905c9c1de26c85fedb73d
BLAKE2b-256 714c109b4e04c8832a8da11d50e4e3c8cea16b3a66de4fda69752f5f7ece8fab

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyctrld-0.1.5.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.5-py3-none-any.whl.

File metadata

  • Download URL: pyctrld-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 52.2 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b310e42de1d83852cfc6c8f42a8b0ad4cace0fabe39d015854dbd41f342dc241
MD5 0c4b2ee5ae2ead2e3cc007cfde077713
BLAKE2b-256 92bef69b3c233eced75e25bd4aa41ffd07dce11030b43500933eec75552666a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyctrld-0.1.5-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