Porkbun

Configuration

To use this provider, add an entry to creds.json with TYPE set to PORKBUN along with your api_key and secret_key. More info about authentication can be found in Getting started with the Porkbun API.

Example:

creds.json

{
  "porkbun": {
    "TYPE": "PORKBUN",
    "api_key": "your-porkbun-api-key",
    "secret_key": "your-porkbun-secret-key"
  }
}

Porkbun has quite strict API limits. If you experience errors with this provider (common when you have many domains), you can set one or both of max_attempts and max_duration in the credentials configuration.

Example:

creds.json

{
  "porkbun": {
    "TYPE": "PORKBUN",
    "api_key": "your-porkbun-api-key",
    "secret_key": "your-porkbun-secret-key",
    "max_attempts": "10",
    "max_duration": "5m"
  }
}

The default for max_attempts is 5. There is no maximum duration by default, instead the provider will perform exponential backoff between 1 and 10 seconds, until max_attempts is reached. To retry indefinitely until max_duration is reached, set max_attempts to any value below 1.

Metadata

This provider does not recognize any special metadata fields unique to Porkbun.

Usage

An example configuration: (DNS hosted with Porkbun):

dnsconfig.js

var REG_PORKBUN = NewRegistrar("porkbun");
var DSP_PORKBUN = NewDnsProvider("porkbun");

D("example.com", REG_PORKBUN, DnsProvider(DSP_PORKBUN),
    A("test", "1.2.3.4"),
);

An example configuration: (Registrar only. DNS hosted elsewhere)

dnsconfig.js

var REG_PORKBUN = NewRegistrar("porkbun");
var DSP_R53 = NewDnsProvider("r53");

D("example.com", REG_PORKBUN, DnsProvider(DSP_R53),
    A("test", "1.2.3.4"),
);

URL Forwarding

Porkbun supports URL forwarding (redirects) using the URL and URL301 record types:

dnsconfig.js

var REG_PORKBUN = NewRegistrar("porkbun");
var DSP_PORKBUN = NewDnsProvider("porkbun");

D("example.com", REG_PORKBUN, DnsProvider(DSP_PORKBUN),
    // Temporary redirect (HTTP 302)
    URL("redirect", "https://example.org"),
    // Permanent redirect (HTTP 301)
    URL301("www", "https://example.com"),
);

By default, URL forwarding includes wildcard subdomains but does not include the URI path in redirection. You can customize this behavior using metadata:

dnsconfig.js

D("example.com", REG_PORKBUN, DnsProvider(DSP_PORKBUN),
    // Include path and disable wildcard
    URL("redirect", "https://example.org", {includePath: "yes", wildcard: "no"}),
);

NOTE: The legacy PORKBUN_URLFWD record type is deprecated. Please use URL or URL301 instead.