Porkbun API — Documentation

v3.7 REST API for domains, DNS, SSL, email forwarding, the marketplace, and more. Base URL: https://api.porkbun.com/api/json/v3

For AI agents & programmatic use

• OpenAPI 3.0 spec (JSON) Machine-readable spec for client/tool generation. Linked from every API response via a Link: rel="describedby" header.
• Per-TLD registration requirements (JSON Schema) GET /domain/getRegistrationRequirements/{tld} returns whether a TLD is API-registerable and the registration payload as JSON Schema — including registry eligibility fields like .us nexus or .ca legal type. Validate a registration before sending it.
• Full reference (Markdown) Every endpoint, parameters, request/response fields, and curl examples in one flat, no-JavaScript file.
• Per-topic docs (Markdown index) One readable page per area — e.g. /llms/dns, /llms/webhooks, /llms/domain.
• Guides (how-tos) Task-oriented walkthroughs: getting started, register a domain, dynamic DNS, verify a webhook.
• LLM overview (llms.txt) Short orientation: what the API does, agent-safety features, quickstart, and key endpoints.
• Official MCP server First-party Model Context Protocol server — npx -y @porkbunllc/mcp-server. One server covers both live operations (domains, DNS, SSL, webhooks; write tools auto-attach an idempotency key) and documentation grounding — search_docs, read_doc, and list_doc_topics let an agent search and read these docs in-session. Works in Claude Desktop, Cursor, Cline, etc.

For humans

• Interactive reference Browse and try endpoints in the browser (requires JavaScript).
• Create API keys Generate and manage API keys, per-key IP/domain restrictions, spend controls, and webhooks.

Authenticate with X-API-Key / X-Secret-API-Key headers, or apikey / secretapikey in the JSON body. API keys work whether or not account two-factor authentication is enabled.