Skip to main content

A CLI tool for managing netcup DNS records via the netcup API

Project description

netcup CLI

PyPI version Python Versions License: MIT

A Python command-line interface for managing DNS records via the netcup DNS API.

Features

Authentication Management: Secure credential storage using system keyring
DNS Zone Info: View zone details, TTL, serial, DNSSEC status
DNS Records: List, add, update, and delete DNS records
Rich Output: Beautiful formatted tables and clear status messages
Debug Mode: Comprehensive debugging for troubleshooting

Installation

From PyPI (Recommended)

pip install netcup-dns-cli

From Source

# Clone the repository
git clone https://github.com/danielmeint/netcup-cli.git
cd netcup-cli

# Install with uv (recommended)
uv sync

# Or install with pip
pip install -e .

Quick Start

1. Authentication

First, log in with your netcup credentials:

netcup auth login

You'll be prompted for:

  • Customer Number (found in your netcup Customer Control Panel)
  • API Key (generated in CCP under "API")
  • API Password (generated in CCP under "API")

Credentials are securely stored in your system keyring.

2. DNS Management

View DNS zone information:

netcup dns zone info example.com

List all DNS records:

netcup dns records list example.com

Add a new DNS record:

netcup dns record add example.com subdomain A 192.168.1.1
netcup dns record add example.com mail MX mail.example.com --priority 10

Update an existing record:

netcup dns record update example.com 12345 subdomain A 192.168.1.2

Delete a record:

netcup dns record delete example.com 12345

3. Other Commands

Check authentication status:

netcup auth status

View configuration:

netcup config show

Logout:

netcup auth logout

Enable debug mode:

netcup --debug dns zone info example.com

Requirements

  • Python 3.8+
  • netcup account with DNS API access
  • Domain(s) registered with netcup using netcup nameservers

API Access Setup

  1. Log into your netcup Customer Control Panel
  2. Navigate to "API" section
  3. Generate an API Key and API Password
  4. Ensure DNS management is enabled for your domains

Troubleshooting

  • Use --debug flag for detailed API response logging
  • Verify your domains are using netcup nameservers
  • Check that DNS management is enabled in your CCP
  • Ensure API credentials have proper permissions

License

MIT License - see LICENSE file for details.

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

netcup_dns_cli-0.1.0.tar.gz (98.2 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: netcup_dns_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 98.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for netcup_dns_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 30161f7c25f99ec693707fc0d9cabc79ff375e1edf9de8db347a35a8d5fbfd37
MD5 19f06e35ae40636ad21587c46698b942
BLAKE2b-256 0a32a327e2a4bd4e1df27d85345c628460cee266dfb99d721291dfe79f628594

See more details on using hashes here.

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