Skip to main content
Tidy Names

Connect Porkbun

This guide walks you through enabling API access on your Porkbun account and connecting it to Tidy Names to sync your domains automatically.

Prerequisites

  • A Porkbun account with one or more domains
  • A Tidy Names account with an organisation set up

Step 1: Enable API Access

Porkbun requires you to enable API access on your account before you can generate keys. You also need to enable API access for each individual domain you want Tidy Names to manage.

Generate Your API Keys

  1. Log in to Porkbun - API Access
  2. If API access is not yet enabled, toggle it on
  3. Click Create API Key
  4. Copy both the API Key and the Secret API Key. The API Key starts with pk1_ and the Secret starts with sk1_

For more details, see Porkbun's API documentation.

Enable API Access per Domain

Porkbun requires API access to be enabled on each domain individually. In your Porkbun Domain Management page:

  1. Click the Details dropdown next to a domain
  2. Find the API Access toggle and enable it
  3. Repeat for each domain you want to appear in Tidy Names
Note: Domains without API access enabled will not appear in Tidy Names even if the connection is working correctly.

Step 2: Add the Connection in Tidy Names

  1. In Tidy Names, go to Connections in the sidebar
  2. Click Add Connection
  3. Select Porkbun from the registrar list
  4. Paste your API Key (pk1_...) into the API Key field
  5. Paste your Secret API Key (sk1_...) into the Secret API Key field
  6. Optionally set a Display Name
  7. Click Test Connection - you should see a success message
  8. Click Save Connection

Tidy Names will immediately start importing your domains that have API access enabled.

Step 3: Verify Your Domains

After saving the connection, go to the Domains page. You should see your Porkbun domains listed with:

  • Domain name and status
  • Expiry date
  • Auto-renew setting
  • Nameservers

Troubleshooting

Test Connection fails

  • Ensure you copied the full keys including the pk1_ and sk1_ prefixes
  • Verify API access is enabled on your account at porkbun.com/account/api

Missing domains

  • Check that API Access is enabled for each domain individually in your Porkbun domain management page
  • Newly registered domains may take a few minutes to become available via the API

Revoking access

  • In Tidy Names: Go to Connections and remove the Porkbun connection
  • In Porkbun: Go to API Access and delete the API key, or disable API access entirely

Next Steps