@firstdorsal/powerdns-api
Advanced tools
Readme
npm i @firstdorsal/powerdns-api
(async () => {
//get enviroment variables from the .env file
require("dotenv").config();
//import the module
const { PowerdnsClient } = require("@firstdorsal/powerdns-api");
//create a powerdns client object
const pdns = new PowerdnsClient(process.env.PDNS_API_ENDPOINT, process.env.PDNS_API_KEY);
//use a function and return the results to console
console.log(await pdns.getZone("example.com"));
})();
The line "require('dotenv').config();" gets the contents of a file called ".env" in which you should store your global and secret variables.
1. Install the module "dotenv" with
npm i dotenv
2. Create a file named ".env" in your applications root directory
.env
PDNS_API_KEY='YOUR PDNS API KEY'
PDNS_API_ENDPOINT='https://example.com/api/v1/servers/localhost'
3. Use your secret variables
process.env.PDNS_API_ENDPOINT
process.env.PDNS_API_KEY
if you are using domains with two labels for the TLD like yourdomain.com.au please use the setHomogeneousRecords function instead of setRecords
Feel free to contact me via xl9jthv_7bvgakv9o9wg0jabn2ylm91xxrzzgt0e@y.gy in english or german
objectobjectArray.<Record>objectArrayObjectobjectobjectbooleanbooleanbooleanobjectbooleanObjectArray.<Cryptokey>booleanArrayNumberNumberArrayArrayBooleanClass representing the powerdns client
Kind: static class of powerdns-api
ArrayObjectobjectobjectbooleanbooleanbooleanobjectbooleanObjectArray.<Cryptokey>booleanArrayNumberNumberArrayArrayBooleanCreate a powerdns client.
| Param | Type | Description |
|---|---|---|
| baseurl | string | The base url where the api can be found |
| apikey | string | The api key for the powerdns endpoint |
Example
(async () => {
require('dotenv').config();
const {
PowerdnsClient
} = require('@firstdorsal/powerdns-api');
const pdns = new PowerdnsClient(process.env.PDNS_API_ENDPOINT, process.env.PDNS_API_KEY);
console.log(await pdns.getZone('example.com'));
})();
ArrayReturns array of all zones from this pdns server.
Kind: instance method of PowerdnsClient
Returns: Array - array of zones
Example
await pdns.getZones();
ObjectCreates zone/domain and returns its SOA record on success.
Kind: instance method of PowerdnsClient
Returns: Object - just the rrsets of the zone
| Param | Type | Default | Description |
|---|---|---|---|
| zoneName | string | takes a domain name | |
| [kind] | 'Native' | 'Master' | 'Slave' | Native | takes the kind of zone you want |
Example
await pdns.createZone('example.com');
objectReturns single zone with meta information.
Kind: instance method of PowerdnsClient
Returns: object - the zone with meta information
| Param | Type | Description |
|---|---|---|
| zoneName | string | takes a domain name |
Example
await pdns.getZoneWithMeta('example.com');
objectReturns array with rrsets for zone.
Kind: instance method of PowerdnsClient
Returns: object - just the rrsets of the zone
| Param | Type | Description |
|---|---|---|
| zoneName | string | takes a domain name |
Example
await pdns.getZone('example.com');
booleanDeletes the whole zone with all attached metadata and rrsets.
Kind: instance method of PowerdnsClient
Returns: boolean - true on success
| Param | Type | Description |
|---|---|---|
| zoneName | string | takes a domain name |
Example
await pdns.deleteZone('example.com');
booleanTakes records for a SINGLE domain as array and sets them. If records exist it replaces them.
Kind: instance method of PowerdnsClient
Returns: boolean - boolean indicating the success of the operation
| Param | Type | Description |
|---|---|---|
| records | Records | array containing the records |
| [domain] | string | optional domain name |
Example
await pdns.setHomogeneousRecords([{
name: "example.com",
type: "A",
ttl: 300,
content: ['1.1.1.1']
}]);
booleanTakes records as array and deletes them.
Kind: instance method of PowerdnsClient
Returns: boolean - boolean indicating the success of the operation
| Param | Type | Description |
|---|---|---|
| records | Records | array containing the records to be deleted |
Example
await pdns.deleteRecords([{
name: "example.com",
type: "A"
}]);
objectTakes Search object and searches for matching elements in the pdns server.
Kind: instance method of PowerdnsClient
Returns: object - search results
| Param | Type | Description |
|---|---|---|
| search | Search | object with the query paramters |
Example
await pdns.search({
query: 'example.com',
max: 100,
object_type: "zone"
});
booleanTakes ONE record as object and appends it not replacing other records with the same name.
Kind: instance method of PowerdnsClient
Returns: boolean - boolean indicating the success of the operation
| Param | Type | Description |
|---|---|---|
| record | Record | array containing the records to be appended |
Example
await pdns.appendRecord({
name: "example.com",
type: "A",
ttl: 300,
content: ['1.1.1.1','2.2.2.2']
});
ObjectCreates a DNS Cryptokey and enables it for DNSSEC. If you want to import your own please read the original documentation and put it in the Cryptokey parameter.
Kind: instance method of PowerdnsClient
Returns: Object - on success the public key and info will be returned
| Param | Type | Default | Description |
|---|---|---|---|
| zoneName | string | name of the zone/domain | |
| [cryptokey] | Cryptokey | {keytype: "ksk", active: true} | a Cryptokey |
| [returnPrivateKey] | boolean | false | setting to true returns the private key with the answer |
Example
await pdns.createCryptokey("example.com");
Array.<Cryptokey>Get the crypotkeys for a given zone.
Kind: instance method of PowerdnsClient
Returns: Array.<Cryptokey> - on success the cryptokeys of the zone will be returned
| Param | Type | Description |
|---|---|---|
| zoneName | string | name of the zone/domain |
Example
await pdns.getCryptoKeys("example.com");
booleanDelete a cryptokey with specified id from specified zone.
Kind: instance method of PowerdnsClient
Returns: boolean - true on success
| Param | Type | Description |
|---|---|---|
| zoneName | string | name of the zone/domain |
| cryptokeyId | string | id of the cryptokey |
Example
await pdns.deleteCryptoKey("example.com",171);
ArrayTakes records for single or mixed domains as array and sets them. If records exist it replaces them.
Kind: instance method of PowerdnsClient
Returns: Array - array of booleans indicating the success of each entry
| Param | Type | Description |
|---|---|---|
| records | Records | array containing the records |
Example
await pdns.setRecords([{
name: "example.com",
type: "A",
ttl: 300,
content: ['1.1.1.1']
},{
name: "example.org",
type: "A",
ttl: 300,
content: ['1.1.1.1']
},{
name: "example.me",
type: "A",
ttl: 300,
content: ['1.1.1.1','2.2.2.2.']
}]);
NumberSearches for records in a zone by comparing the RECORDS field NOT the name field. Replaces the found records with the replace string.
Kind: instance method of PowerdnsClient
Returns: Number - number of replaced entries
| Param | Type | Description |
|---|---|---|
| find | String | string to search for |
| replace | String | string to replace the find string with |
| zone | String | zone to search through |
Example
await pdns.replaceRecords('1.1.1.1','2.2.2.2','example.com');
NumberSearches for records on the pdns server by comparing the RECORDS field NOT the name field. Replaces the found records with the replace string.
Kind: instance method of PowerdnsClient
Returns: Number - number of replaced entries
| Param | Type | Description |
|---|---|---|
| find | String | string to search for |
| replace | String | string to replace the find string with |
Example
await pdns.replaceRecordsGlobal('1.1.1.1','2.2.2.2');
ArraySearches for records in a zone by comparing the RECORDS field NOT the name field
Kind: instance method of PowerdnsClient
Returns: Array - records matching the find string in the content field
| Param | Type | Description |
|---|---|---|
| find | String | string to search for |
| zone | String | zone to search through |
Example
await pdns.findRecords('1.1.1.1', 'example.com');
ArraySearches for records on the pdns server by comparing the RECORDS field NOT the name field
Kind: instance method of PowerdnsClient
Returns: Array - records matching the find string in the content field
| Param | Type | Description |
|---|---|---|
| find | String | string to search for |
Example
await pdns.findRecordsGlobal('1.1.1.1');
BooleanHigher level function for creating a zone with a custom soa record, name servers and dnssec/cryptokey. Skips creating zone and/or cryptokey if it exists.
Kind: instance method of PowerdnsClient
Returns: Boolean - true on success
| Param | Type | Description |
|---|---|---|
| zone | Object | string to search for |
Example
await pdns.createAndSetupZone({
domain: 'example.com',
nameserver: ['ns1.paulisttoll.somedomain', 'ns2.paulisttoll.somedomain', 'ns3.paulisttoll.somedomain'],
hostmasterEmail:'hostmaster@paulisttoll.somedomain',
})
objectKind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| keytype | 'ksk' | 'zsk' | 'csk' | The type of the key possible values are |
| active | boolean | Whether or not the key is in active use |
| published | boolean | Whether or not the DNSKEY record is published in the zone |
| dnskey | string | The DNSKEY record for this key |
| privateKey | string | The private key in ISC format |
| algorithm | string | The name of the algorithm of the key, should be a mnemonic |
objectKind: global typedef
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| query | string | query to search for | |
| [max] | number | 10 | limits the ammount of returned values |
| [object_type] | 'all' | 'zone' | 'record' | 'comment' | record | for what kind of pdns object to search |
Example
{query: 'example.com', max: 100, object_type: "zone"}
Array.<Record>Kind: global typedef
Example
[{
name: "example.com",
type: "A",
ttl: 300,
content: ['1.1.1.1', '8.8.8.8']
}, {
name: "*.example.com",
type: "A",
ttl: 300,
content: ['1.1.1.1', '8.8.8.8']
}]
objectKind: global typedef
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | key name of the record | |
| [type] | string | "'A'" | type of the record |
| [ttl] | number | 3600 | time to live of the record |
| content | Array | value array with content of the record |
Example
{name: "example.com", type: "A", ttl: 300, content: ['1.1.1.1', '8.8.8.8']}
FAQs
A Nodejs client for the PowerDns API with the most relevant functions.
The npm package @firstdorsal/powerdns-api receives a total of 42 weekly downloads. As such, @firstdorsal/powerdns-api popularity was classified as not popular.
We found that @firstdorsal/powerdns-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.