Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tuladhar/easydns-restapi-cli

A command-line tool for managing (create/update) EasyDNS DNS records using easyDNS REST API.
https://github.com/tuladhar/easydns-restapi-cli

cli dns easydns hacktoberfest open-source

Last synced: 24 days ago
JSON representation

A command-line tool for managing (create/update) EasyDNS DNS records using easyDNS REST API.

Awesome Lists containing this project

README

        

# easydns-restapi-cli

A command-line tool for managing (create/update) EasyDNS DNS records using easyDNS rest API.

![Sample Screenshot](./docs/example.png)

### REQUIREMENTS

- [git](https://git-scm.com/downloads)
- [Python 3](https://www.python.org/downloads/)
- [pip3](https://pip.pypa.io/en/stable/)
- [EasyDNS API](https://docs.sandbox.rest.easydns.net/)

### INSTALLATION
```
$ git clone https://github.com/tuladhar/easydns-restapi-cli && cd easydns-restapi-cli
$ sudo make install
$ easydnscli --help

```
### BUILD FROM SOURCE
```
$ git clone https://github.com/tuladhar/easydns-restapi-cli
$ cd easydns-restapi-cli
$ pip3 install requests pyinstaller
$ pyinstaller --onefile easydns-restapi-cli.py -n easydnscli
$ cd dist && ./easydnscli --help

```

### CONFIGURATION
```
{
"domain": "XYZ",
"token": "XYZ",
"key": "XYZ",
"endpoint": "http://sandbox.rest.easydns.net",
"format": "json",
"delay": 5,
"ttl": 600
}
```

* `domain` - domain to manage
* `token` - API token received from EasyDNS
* `key` - API key received from EasyDNS
* `endpoint` - API endpoint received from EasyDNS
* `delay` - delay (in seconds) between subsequent API calls to get pass rate limiting
* `ttl` - TTL to use when creating/updating DNS records

### USAGE

Create DNS record (Syntax)

```
$ easydnscli --conf "PATH TO CONFIG FILE" --create --hostname www --address 127.0.0.1
```
Create DNS record (Example)

```
$ easydnscli --conf Downloads/sample-easydns.conf --create --hostname www --address 127.0.0.1
```

Update DNS record (Syntax)

```
$ easydnscli --conf "PATH TO CONFIG FILE" --update --hostname www --address 127.0.0.1
```
Update DNS record (Example)

```
$ easydnscli --conf Downloads/sample-easydns.conf --update --hostname www --address 127.0.0.1
```

### AUTHORS
- [Puru Tuladhar](github.com/tuladhar)

### CONTRIBUTORS
- See [Contributors.md](Contributors.md)