CLI frontend
The API client library for managing various resources.
Getting started
To install this package you need to take a few steps before this works correctly
- Create an virtual environment: python3 -m venv
- Activate the environment: /bin/activate
- Now install the package: pip install cacholong-cloud-cli
- Or upgrade the package: pip install cacholong-cloud-cli --upgrade
Now you can use the command ccloud on the system. Please note, make sure to activate the virtual environment before running the command ccloud.
You will need an API-token. This token can be created using our panel at https://cp.cacholong.eu/#/user/settings/api. You can create an api token within your profile under API.
When running the command ccloud for the first time it will ask you for an API-token.
After that you will be able to run the following command:
ccloud accounts list
This will give you an overview of accounts where you have access to.
Usage
Overview of the possibilities:
ccloud --help
To fetch an overview of the dns-zones for an account:
ccloud dns-zones list --account <account uuid>
Creating a DNS-record:
ccloud dns-records create --dns-zone <dns-zone uuid> \
--name localhost.example.com \
--dns-record-type A \
--content 127.0.0.1 \
--ttl 300
Updating a DNS-record:
ccloud dns-records update <dns-record uuid> \
--content 127.0.0.1
Deleting a DNS-record:
ccloud dns-records delete <dns-record uuid>
Every command includes an option --help which will give an overview of the possibilities.
Advanced usage
Its also possible to create your own command line utility to handle various parts. Here are the same examples as above but now using python.
Fetching DNS-zones
import asyncio
from cacholong_sdk.connection import connection
from cacholong_sdk import ResourceTuple, Inclusion, Filter
from cacholong_sdk import DnsZone, DnsZoneModel, DnsRecord, DnsRecordModel
async def main():
async with connection('https://api.cacholong.eu/api/v1/', 'YOUR-API-TOKEN') as api:
searchfilter = Filter(account="UUID_OF_ACCOUNT")
DnsZoneCtrl = DnsZone(api)
async for zone in DnsZoneCtrl.fetch_all(searchfilter):
print(zone["domain"])
# Execute main function
asyncio.run(main())
Create a DNS-record
import asyncio
from cacholong_sdk.connection import connection
from cacholong_sdk import ResourceTuple, Inclusion, Filter
from cacholong_sdk import DnsZone, DnsZoneModel, DnsRecord, DnsRecordModel
async def main():
async with connection('https://api.cacholong.eu/api/v1/', 'YOUR-API-TOKEN') as api:
DnsRecordCtrl = DnsRecord(api)
dns_record = DNSRecordCtrl.create()
dns_record["dns-zone"] = ResourceTuple("UUID_DNS_ZONE", "dns-zones")
dns_record["name"] = "localhost.example.nl"
dns_record["dns_record_type"] = "A"
dns_record["content"] = "127.0.0.1"
dns_record["ttl"] = 300
await DNSRecordCtrl.store(dns_record)
# Execute main function
asyncio.run(main())
Update a DNS-record
import asyncio
from cacholong_sdk.connection import connection
from cacholong_sdk import ResourceTuple, Inclusion, Filter
from cacholong_sdk import DnsZone, DnsZoneModel, DnsRecord, DnsRecordModel
async def main():
async with connection('https://api.cacholong.eu/api/v1/', 'YOUR-API-TOKEN') as api:
DnsRecordCtrl = DnsRecord(api)
dns_record = await DnsRecordCtrl.fetch("UUID_OF_DNS_RECORD")
dns_record["content"] = "127.0.0.1"
# Be careful: the above change will be applied automatically
# Execute main function
asyncio.run(main())
Delete a DNS-record
import asyncio
from cacholong_sdk.connection import connection
from cacholong_sdk import ResourceTuple, Inclusion, Filter
from cacholong_sdk import DnsZone, DnsZoneModel, DnsRecord, DnsRecordModel
async def main():
async with connection('https://api.cacholong.eu/api/v1/', 'YOUR-API-TOKEN') as api:
DnsRecordCtrl = DnsRecord(api)
await DnsRecordCtrl.destroy("UUID_OF_DNS_RECORD")
# Execute main function
asyncio.run(main())
SDK
cacholong_sdk is the programmatic layer bundled with this package. It gives you direct Python access to all Cacholong resources — DNS zones, mail, accounts, and more — without going through the CLI. Full documentation, including installation, authentication, CRUD examples, filtering, relationships, and error handling, is available at docs.cacholong.eu/sdk.
Support
Questions, feedback, or suggestions? Send us an email at [ccloud-support@cacholong.nl].
Metadata
Release files for cacholong-cloud-cli 1.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cacholong_cloud_cli-1.9.0.tar.gz | 45.4 kB | Without provenance | Details for cacholong_cloud_cli-1.9.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cacholong_cloud_cli-1.9.0-py3-none-any.whl | Python 3 | none | any | Details for cacholong_cloud_cli-1.9.0-py3-none-any.whl |
Total release size: 126.3 kB
Release files / cacholong_cloud_cli-1.9.0.tar.gz
| Download URL | cacholong_cloud_cli-1.9.0.tar.gz |
|---|---|
| Size | 45.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7babfd07e7f7c3e9e3d73405629142b05fe1cfa0bf8c68a0f2d244b0252f3c29
|
|
BLAKE2b-256 checksum How to use checksums |
bbf3e4662fff50a7bda3412b8bd3a47c135a3a0a597be7f622f7857258487210
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.3 CPython/3.11.16 Linux/6.1.0-52-amd64
|
Release files / cacholong_cloud_cli-1.9.0-py3-none-any.whl
| Download URL | cacholong_cloud_cli-1.9.0-py3-none-any.whl |
|---|---|
| Size | 81.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
301254bfec51df3edaae4a9467cf7030570e220e0383732e8a3334408a51ad42
|
|
BLAKE2b-256 checksum How to use checksums |
4751e7138415f7fdd78462f8cbfadfa7b680b989a6381a8f478ea782ddc74d06
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.3 CPython/3.11.16 Linux/6.1.0-52-amd64
|
Security for cacholong-cloud-cli 1.9.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.