Porkbun API JSON v3

https://porkbun.com/api/json/v3/
Admin
Porkbun API v3 is a JSON-based REST API for managing domains, DNS records, SSL certificates, and...
Tokens:21,049
Snippets:132
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
================
LIBRARY RULES
================
- The Porkbun API uses JSON content sent to URI endpoints via HTTP POST.

================
CODE SNIPPETS
================
### Install Porkbun MCP server with npx

Source: https://porkbun.com/api/json/v3/documentation/interactive

Installs and runs the official Porkbun MCP server using npx. No integration code is required; the server provides domain registration, DNS, SSL, marketplace, and account-management tools to MCP-compatible AI clients.

```bash
npx -y @porkbunllc/mcp-server

```

--------------------------------

### Target domain allowlist entries

Source: https://porkbun.com/api/json/v3/documentation/interactive

Example entries for the target domain allowlist. Exact match only; example.com does not include foo.example.com. When set, operations on other domains fail with HTTP 403 DOMAIN_NOT_ALLOWED.

```text
example.com
myothersite.io
```

--------------------------------

### Source IP allowlist entries

Source: https://porkbun.com/api/json/v3/documentation/interactive

Example entries for the source IP allowlist. Supports IPv4 and IPv6, bare addresses and CIDR ranges, one per line. When set, requests from other IPs fail with HTTP 403 IP_NOT_ALLOWED.

```text
203.0.113.10
198.51.100.0/24
2001:db8::/32
```

--------------------------------

### GET /ip

Source: https://porkbun.com/api/json/v3/documentation/interactive

Returns the public IP address of the requester. No credentials are required for this endpoint.

```APIDOC
## [GET] /ip

### Description
Returns the public IP address of the requester. No credentials are required.

### Method
GET

### Endpoint
https://api.porkbun.com/api/json/v3/ip

### Parameters
None

### Request Example
No request body required.

### Response
#### Success Response (200)
- **ip** (string) - The public IP address.

#### Response Example
{
  "ip": "203.0.113.1"
}
```

--------------------------------

### GET /webhook/eventTypes

Source: https://porkbun.com/api/json/v3/documentation/interactive

Retrieves the live catalog of available webhook event types. Use this to discover supported events for subscription.

```APIDOC
## [GET] /webhook/eventTypes

### Description
Retrieves the live catalog of available webhook event types. Use this to discover supported events for subscription.

### Method
GET

### Endpoint
/webhook/eventTypes

### Response
#### Success Response (200)
- **eventTypes** (array of strings) - List of event type identifiers (e.g., "domain.registered").

#### Response Example
{
  "eventTypes": ["domain.registered", "domain.renewed", "dns.record.created"]
}
```

--------------------------------

### POST /domain/create/{domain}

Source: https://porkbun.com/api/json/v3/documentation/interactive

Registers a domain. Requires the cost in pennies and agreement to terms.

```APIDOC
## [POST] /domain/create/{domain}

### Description
Registers a domain. Requires the cost in pennies and agreement to terms.

### Method
POST

### Endpoint
https://api.porkbun.com/api/json/v3/domain/create/{domain}

### Parameters
#### Path Parameters
- **domain** (string) - Required - The domain to register, e.g., example.com

#### Request Body
- **apikey** (string) - Required - Your API key.
- **secretapikey** (string) - Required - Your secret API key.
- **cost** (integer) - Required - The cost in pennies (e.g., 973 for $9.73).
- **agreeToTerms** (string) - Required - Must be "yes" to agree to terms.

### Request Example
{
  "apikey": "your_api_key",
  "secretapikey": "your_secret_key",
  "cost": 973,
  "agreeToTerms": "yes"
}

### Response
#### Success Response (200)
- **status** (string) - Success status.

#### Response Example
{
  "status": "SUCCESS"
}
```

--------------------------------

### GET /webhook/deliveries

Source: https://porkbun.com/api/json/v3/documentation/interactive

Lists recent webhook delivery attempts. Can be filtered by endpoint ID or status, and returns newest first.

```APIDOC
## [GET] /webhook/deliveries

### Description
Lists recent webhook delivery attempts. Can be filtered by endpoint ID or status, and returns newest first.

### Method
GET

### Endpoint
/webhook/deliveries

### Parameters
#### Query Parameters
- **endpointId** (string) - Optional - Filter by webhook endpoint ID.
- **status** (string) - Optional - Filter by delivery status (e.g., "success", "failed").

### Response
#### Success Response (200)
- **deliveries** (array) - List of delivery records.

#### Response Example
{
  "deliveries": [
    {
      "id": "delivery-uuid",
      "endpointId": "endpoint-uuid",
      "status": "success",
      "createdAt": "2026-06-17T18:30:00Z"
    }
  ]
}
```

--------------------------------

### POST /dns/create/{domain}

Source: https://porkbun.com/api/json/v3/documentation/interactive

Adds a DNS record for a domain. Requires the record type, content, and TTL.

```APIDOC
## [POST] /dns/create/{domain}

### Description
Adds a DNS record for a domain. Requires the record type, content, and TTL.

### Method
POST

### Endpoint
https://api.porkbun.com/api/json/v3/dns/create/{domain}

### Parameters
#### Path Parameters
- **domain** (string) - Required - The domain to add the record to, e.g., example.com

#### Request Body
- **apikey** (string) - Required - Your API key.
- **secretapikey** (string) - Required - Your secret API key.
- **type** (string) - Required - The DNS record type (e.g., A).
- **content** (string) - Required - The record content (e.g., IP address).
- **ttl** (string) - Required - Time to live in seconds (e.g., "600").

### Request Example
{
  "apikey": "your_api_key",
  "secretapikey": "your_secret_key",
  "type": "A",
  "content": "1.2.3.4",
  "ttl": "600"
}

### Response
#### Success Response (200)
- **status** (string) - Success status.

#### Response Example
{
  "status": "SUCCESS"
}
```

--------------------------------

### GET /webhook/delivery/{id}

Source: https://porkbun.com/api/json/v3/documentation/interactive

Fetches a single webhook delivery record including its full payload. Use the delivery ID from the list endpoint.

```APIDOC
## [GET] /webhook/delivery/{id}

### Description
Fetches a single webhook delivery record including its full payload. Use the delivery ID from the list endpoint.

### Method
GET

### Endpoint
/webhook/delivery/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The delivery record ID.

### Response
#### Success Response (200)
- **delivery** (object) - The full delivery record, including the payload.

#### Response Example
{
  "delivery": {
    "id": "delivery-uuid",
    "endpointId": "endpoint-uuid",
    "event": "domain.registered",
    "payload": { "event": "domain.registered", "data": {} }
  }
}
```

--------------------------------

### Check domain availability with curl

Source: https://porkbun.com/api/json/v3/documentation/interactive

Verifies credentials and returns availability and price. Returns an error if credentials are invalid.

```bash
curl -X POST https://api.porkbun.com/api/json/v3/domain/checkDomain/example.com \
  -H "Content-Type: application/json" \
  -d '{"apikey":"your_api_key","secretapikey":"your_secret_key"}'

```

--------------------------------

### Register domain with curl

Source: https://porkbun.com/api/json/v3/documentation/interactive

Converts price to pennies for cost. Requires agreement to terms.

```bash
curl -X POST https://api.porkbun.com/api/json/v3/domain/create/example.com \
  -H "Content-Type: application/json" \
  -d '{"apikey":"your_api_key","secretapikey":"your_secret_key","cost":973,"agreeToTerms":"yes"}'

```

--------------------------------

### POST /domain/checkDomain/{domain}

Source: https://porkbun.com/api/json/v3/documentation/interactive

Checks the availability of a domain and returns the price in USD. Requires API credentials in the request body.

```APIDOC
## [POST] /domain/checkDomain/{domain}

### Description
Checks the availability of a domain and returns the price in USD. Requires API credentials in the request body.

### Method
POST

### Endpoint
https://api.porkbun.com/api/json/v3/domain/checkDomain/{domain}

### Parameters
#### Path Parameters
- **domain** (string) - Required - The domain name to check, e.g., example.com

#### Request Body
- **apikey** (string) - Required - Your API key.
- **secretapikey** (string) - Required - Your secret API key.

### Request Example
{
  "apikey": "your_api_key",
  "secretapikey": "your_secret_key"
}

### Response
#### Success Response (200)
- **avail** (string) - "yes" or "no" indicating availability.
- **price** (number) - Price in USD.

#### Response Example
{
  "avail": "yes",
  "price": 9.73
}
```

--------------------------------

### Idempotent domain creation with curl

Source: https://porkbun.com/api/json/v3/documentation/interactive

POST request to create a domain with an Idempotency-Key header. On retry with the same key and body, the original response is replayed with header Idempotent-Replayed: true. Different body returns 409 IDEMPOTENCY_KEY_MISMATCH; in-flight returns 409 IDEMPOTENCY_KEY_IN_USE.

```bash
curl -X POST https://api.porkbun.com/api/json/v3/domain/create/example.com \
  -H "Idempotency-Key: a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "X-API-Key: pk1_..." -H "X-Secret-API-Key: sk1_..." \
  -d '{"cost":973,"agreeToTerms":"yes"}'
```

--------------------------------

### Add DNS record with curl

Source: https://porkbun.com/api/json/v3/documentation/interactive

Creates a DNS record of type A with content and TTL.

```bash
curl -X POST https://api.porkbun.com/api/json/v3/dns/create/example.com \
  -H "Content-Type: application/json" \
  -d '{"apikey":"your_api_key","secretapikey":"your_secret_key","type":"A","content":"1.2.3.4","ttl":"600"}'

```

--------------------------------

### Test connectivity with curl

Source: https://porkbun.com/api/json/v3/documentation/interactive

Returns your public IP. No credentials required.

```bash
curl https://api.porkbun.com/api/json/v3/ip

```
Tokens:
Raw