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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyctrld-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 2978133fed42ac61c7c3720e685f157c7d0e3e6beddd14c4b18d353382b050c6
MD5 7dec9291a908a7d58625900328eac6d9
BLAKE2b-256 e620cf0c901e9cab605fbc6e1c92563792df962bb6b9b4c88d3725a21e259f1d

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: pyctrld-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 98704ba7f8adb3c2ec97d1cc14f40b73175ce2502c682c3a6e153df03fe5e1c3
MD5 588971ab28dbea59d9cb7492b5780d4e
BLAKE2b-256 44b3603ee2a76d0cf18bb352de3801477727d1b5945d9d2cf11a7394ce1fc02c

See more details on using hashes here.

Provenance

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