Skip to content

ttayson/HurricaneAPI

Repository files navigation

HurricaneAPI

Api rest para gerenciamento de DNS Hurricane

N|Solid

This is not an official version

Features

Function - Status -
List Domain
List Hosts
Add
Update itens
Remove itens
Docker

Installation

Requires Node.js v10+ to run.

Install the dependencies and devDependencies and start the server.

git clone https://github.com/ttayson/HurricaneAPI.git
cd HurricaneAPI
npm install 
npm start

Docker Installation

git clone https://github.com/ttayson/HurricaneAPI.git
cd HurricaneAPI
docker-compose up -d  --build

Specify your port to run the instance, the default is 3000

If necessary, change the port in docker-compose

Usage

> List Domains

curl --request POST \
  --url http://localhost:3000/api/list \
  --header 'Content-Type: application/json' \
  --data '{
	"login": "LOGIN",
	"pass": "PASSWORD"
}'
wget --quiet \
  --method POST \
  --header 'Content-Type: application/json' \
  --body-data '{\n	"login": "LOGIN",\n	"pass": "PASSWORD"\n}' \
  --output-document \
  - http://localhost:3000/api/list
 

> List all information for a domain

curl --request POST \
  --url http://localhost:3000/api/list \
  --header 'Content-Type: application/json' \
  --data '{
	"login": "LOGIN",
	"pass": "PASSWORD",
	"domain": "VALID DOMAIN"
}'
wget --quiet \
  --method POST \
  --header 'Content-Type: application/json' \
  --body-data '{\n	"login": "LOGIN",\n	"pass": "PASSWORD",\n	"domain": "VALID DOMAIN"\n}' \
  --output-document \
  - http://localhost:3000/api/list

> To ADD

curl --request POST \
  --url http://localhost:3000/api/add \
  --header 'Content-Type: application/json' \
  --data '{
	"login": "LOGIN",
	"pass": "PASSWORD",
	"domain": "DOMAIN",
	"type": "Type",
	"name": "NAME",
	"data": "",
	"ttl": "ttl"
}'
wget --quiet \
  --method POST \
  --header 'Content-Type: application/json' \
  --body-data '{\n	"login": "LOGIN",\n	"pass": "PASWORD",\n	"domain": "DOMAIN",\n	"type": "TYPE",\n	"name": "NAME",\n	"data": "",\n	"ttl": "TTL"\n}' \
  --output-document \
  - http://localhost:3000/api/add

Approved values in request body

Types:

  • A
  • CNAME
  • ALIAS
  • MX
  • NS
  • TXT

Name:

  • IP or -HOST or TEXT

TTL:

  • 300
  • 900
  • 1800
  • 3600
  • 7200
  • 14400
  • 28800
  • 43200
  • 86400
  • 172800

License

MIT

Legal

This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by Hurricane Electric. This is an independent and unofficial software. Use at your own risk.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published