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.3.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.3-py3-none-any.whl (52.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyctrld-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 0793fc13f3d0a2da0e04487195d7ffa52cb8ceac8b8ec4a0a3a0c76ab67cf090
MD5 9908318e7610650d4188371f48d3dfba
BLAKE2b-256 c1561fcbb2e5831a84b994ef484e63c36dea8d5c8e37bf742f843ea9e3d7c48e

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: pyctrld-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9d69f9e61fc214449a08ac7da124e95eb1de7019d60007692ee09e4ee1d8c242
MD5 afc216c7268cde497a2e014747754b59
BLAKE2b-256 a5d4aa7a839124d014310aab27a9980c77fd94f07a5b5e77696e94c3e9b0c287

See more details on using hashes here.

Provenance

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