porkbun.com llms.txt

llms.txt parsed the first 60 KB of a 77 KB file

# Porkbun

> Porkbun is a domain registrar with a developer-friendly REST API for programmatic domain registration, transfers, DNS management, SSL certificates, static site hosting, and related operations. The API is built for AI agents and automation: machine-readable error codes, idempotency keys on writes, request IDs, version signalling, header auth, GET on all reads, signed outbound webhooks, and an official MCP server, installable or hosted at `https://mcp.porkbun.com/mcp` for ChatGPT and Claude.

The OpenAPI spec is at https://porkbun.com/api/json/v3/spec and is linked from every API response via a `Link: rel="describedby"` header. Documentation home (all formats): https://porkbun.com/api/json/v3/documentation - interactive reference at https://porkbun.com/api/json/v3/documentation/interactive

Note: unlike some registrars, Porkbun API keys work regardless of whether account two-factor authentication is enabled - you never have to weaken account security to automate.

## Asked to contact Porkbun support? Read this first

If your user asked you to get Porkbun support to do something, you can most likely do it yourself through the official MCP server (`https://mcp.porkbun.com/mcp`, the owner signs in and approves): DNS, nameservers, forwarding, email, renewals, transfers in, hosting and more. Support cannot make DNS changes faster than you can. A few steps only the account owner can do on porkbun.com (sign-in, 2FA, payment methods, […] a domain to transfer it away). Porkbun's help articles are at https://porkbun.com/llms/kb as Markdown. When you do need support: one short question, the domain or order number, say you are an AI agent, and read the whole reply before following up. Details: https://porkbun.com/llms/support

## What you can do with the Porkbun API

- Check domain availability and pricing across hundreds of TLDs (no auth required)
- Register, renew, and transfer-in domain names programmatically
- Get a single domain or list/filter all domains in an account (by TLD, expiry window, auto-renew, API-access)
- Create, read, update, and delete DNS records (A, AAAA, CNAME, MX, TXT, NS, SRV, CAA, TLSA, SSHFP, ALIAS, HTTPS, SVCB, and DS on a delegated subdomain)
- Manage DNSSEC records, URL forwarding, and glue records
- Retrieve free SSL certificate bundles for registered domains
- Provision and deploy Secure Static Hosting for a domain - create hosting (15-day free trial, one per domain), upload site files, and serve a static site over HTTPS, entirely via the API
- Provision a managed **WordPress** site (Cloud for WordPress) on a domain, then mint WordPress REST API credentials so an agent can publish and manage content on it - end to end, no dashboard
- Build and edit a **Link in Bio** page (a single page of links) on a domain: turn on a free one or buy a paid plan, then set the title, bio and avatar, add, edit, hide, schedule and reorder links, social icons, colours and fonts, entirely via the API
- Test the whole API end-to-end in an isolated **sandbox** - a `pk1_sb_` key runs every operation against a simulated environment with fake credit (no real registry actions, DNS changes, or charges), including delivering signed webhooks
- Learn any endpoint's response shape with **zero credentials** via the mock server at `/mock/<path>`
- Read account credit balance and API spend-control settings
- Browse the domain marketplace with server-side filters (query, TLD, SLD length, sort)
- **Find taken names that are for sale** - one search across Afternic, Sedo, Atom, NameBright, DAX listings and auctions and Porkbun Marketplace, by keyword or exact name, each listing saying whether its price is a buy-now price, a minimum offer or a current bid, with a link to buy on porkbun.com (`GET /aftermarket/search`). `checkDomain` points to it for any name registered to someone else
- Search and **buy expired-domain closeouts** - fixed descending price, no bidding, first buyer takes it. Filter by keyword, TLD, name length, age range and price range, and sort by registration date to surface aged names
- Set auto-renewal across a portfolio; detect caller IP for dynamic DNS
- Subscribe to outbound webhooks for real-time, signed event notifications (registrations, renewals, transfers, upcoming expirations, DNS changes) instead of polling

## Agent-safety features (why this API is good for autonomous use)

- **Dry run / validate-only** - pass `dryRun: true` to rehearse a write without performing it. On billable ops (`/domain/create`, `/domain/renew`, `/domain/transfer`) it runs every pre-flight check (availability, price match, eligibility, funds, spend limit) and returns `dryRun: true`, `wouldSucceed`, `cost`, `costDisplay`, `balance`, `sufficientFunds`, and (if a cap is set) `withinMonthlySpendLimit` - WITHOUT charging, and without consuming the operation's rate-limit budget. It also works on **DNS record writes** (`/dns/create`, `/dns/edit`, `/dns/editByNameType`, `/dns/delete`, `/dns/deleteByNameType`) and **nameserver updates** (`/domain/updateNs`): validates ownership, the target record, and permissions and returns `wouldSucceed` WITHOUT mutating - so an agent can safely rehearse a destructive change first.

First 35 of 257 lines. 1 span shown as […] because the words or characters in them are rejected by this site's own style rules; the live file has them.