Unofficial client for the Porkbun API
Project description
pkb_client
Unofficial client for the Porkbun API
Table of Contents
About
pkb_client is an unofficial client for the Porkbun API. It supports the v3 of the API. You can find the official documentation of the Porkbun API here.
Installation
This project only works with Python 3, make sure you have at least Python 3.6 installed.
With pip (recommend)
Use the following command to install pkb_client with pip:
pip3 install pkb_client
You can also very easily update to a newer version:
pip3 install pkb_client -U
From source
git clone https://github.com/infinityofspace/pkb_client.git
cd pkb_client
pip install .
Usage
Each request must be made with the API key and secret. You can easily create them at Porkbun. Just follow the official instructions. Make sure that you explicitly activate the API usage for your domain at the end.
After installation pkb_client is available under the command pkb-client
.
You have to specify your API key and secret each time as follows:
pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> ping
If you don't want to specify the key and secret in the program call, because for example the command line calls are logged and you don't want to log the API access, then you can also omit both arguments and pkb-client asks for a user input.
You can see an overview of all usable API methods via the help:
pkb-client -h
If you need more help on a supported API method, you can use the following command, for example for the ping method:
pkb-client ping -h
Here are a few usage examples:
Create a new TXT record for the subdomain test
of the domain example.com
with the value porkbun is cool
and a TTL
of 500
:
pkb-client -k <YOUR-API-KEY> -s <YOUR-API-KEY-SECRET> dns-create example.com TXT "porkbun is cool" --name test --ttl 500
The call returns the DNS record id. The record DNS ids are used to distinguish the DNS records and can be used for editing or deleting records. The ID is only a Porkbun internal identifier and is not publicly available.
Delete the DNS record with the ID 12345
of the domain example.com
:
pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> dns-delete example.com 12345
Get all DNS records of the domain example.com
:
pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> dns-retrieve example.com
Change the TXT DNS record content with the ID 456789
of the domain example.com
to the answer is 42
:
pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> dns-edit example.com 456789 TXT "the answer is 42"
Exporting all current DNS records of the domain example.com
to the file dns_recods.json
:
pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> dns-export example.com dns_recods.json
Remove all existing DNS records of the domain example.com
and restore the DNS records from the file dns_recods.json
:
pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> dns-import example.com dns_recods.json clear
Note: The import function uses the record ID to distinguish DNS records.
Third party notices
All modules used by this project are listed below:
Name | License |
---|---|
requests | Apache 2.0 |
setuptools | MIT |
Furthermore, this readme file contains embeddings of Shields.io and PePy. The tests use ipify.
License
MIT - Copyright (c) Marvin Heptner
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.