PocketDNS Partner API

Welcome to the PocketDNS Partner API documentation. This interactive documentation allows you to explore all endpoints, test API calls, and understand the complete API structure.

v0.0.1

PocketDNS

Download OpenAPI Document

Quick Start

Get started with the PocketDNS Partner API in minutes:

Get API Key: Obtain your API key from the Partner Dashboard
Choose Environment: Use sandbox for testing, production for live applications
Authenticate: Use Bearer token authentication with your API key
Start Building: Begin with user session creation, then manage domains and DNS records

Authentication

All API requests require authentication using Bearer tokens:

http

Authorization: Bearer YOUR_API_KEY_HERE

To test endpoints in this documentation:

Click "Try it out" on any endpoint
Enter your API key in the authorization field
Configure parameters and execute the request

Environments

Environment	Base URL	Description
Sandbox	`https://api.sandbox.pocketdns.com`	For testing and development
Production	`https://api.pocketdns.com`	For live applications

API Operations

User Management

Manage user sessions and authentication flows.

Domain Management

Retrieve domain information and listings for users.

DNS Records

Complete CRUD operations for DNS record management.

Create DNS Record

Get DNS Record

Update DNS Record

Delete DNS Record

Data Models & Schemas

v0.0.1

PocketDNS

Download OpenAPI Document

Servers

https://api.pocketdns.com

https://api.sandbox.pocketdns.com

Default

Operations

POST/api/v1/users GET/api/v1/users/{user_id}/domains GET/api/v1/domains/{domain_id}POST/api/v1/dns_records GET/api/v1/dns_records/{id}DELETE/api/v1/dns_records/{id}PATCH/api/v1/dns_records/{id}

Find or create user and initialize a new session for them

POST

/api/v1/users

Authorizations

bearerAuth

TypeHTTP (bearer)

Request Body

application/json

JSON

{

"user_identifier": "string",

"email": "string"

}

Responses

User session initialized

Content-Type

application/json

JSON

{

"user_identifier": "string",

"login_url": "string"

}

POST

/api/v1/users

Playground

Server

Authorization

bearerAuth

Body

Samples

Retrieve a list of domains for a given user

GET

/api/v1/users/{user_id}/domains

Parameters

Path Parameters

user_id*

Typestring

Required

Responses

List of domains for the user

Content-Type

application/json

JSON

{

"domains": [

{

"id": "string",

"name": "string"

}

]

}

GET

/api/v1/users/{user_id}/domains

Playground

Server

Variables

Key

Value

user_id*

Samples

Retrieve details of a specific domain

GET

/api/v1/domains/{domain_id}

Parameters

Path Parameters

domain_id*

Typestring

Required

Responses

Domain details

Content-Type

application/json

JSON

{

"id": "string",

"name": "string"

}

GET

/api/v1/domains/{domain_id}

Playground

Server

Variables

Key

Value

domain_id*

Samples

Create a DNS record

POST

/api/v1/dns_records

Authorizations

bearerAuth

TypeHTTP (bearer)

Request Body

application/json

JSON

{

"domain_id": "string",

"type": "string",

"name": "string",

"value": "string",

"ttl": 0,

"priority": 0,

"weight": 0,

"port": 0,

"target": "string"

}

Responses

DNS record created successfully

Content-Type

application/json

JSON

{

"id": "string",

"type": "string",

"name": "string",

"value": "string",

"ttl": 0,

"priority": 0,

"weight": 0,

"port": 0,

"target": "string"

}

POST

/api/v1/dns_records

Playground

Server

Authorization

bearerAuth

Body

Samples

Retrieve a specific DNS record

GET

/api/v1/dns_records/{id}

Authorizations

bearerAuth

TypeHTTP (bearer)

Parameters

Path Parameters

id*

Typestring

Required

Responses

DNS record details

Content-Type

application/json

JSON

{

"id": "string",

"type": "string",

"name": "string",

"value": "string",

"ttl": 0,

"priority": 0,

"weight": 0,

"port": 0,

"target": "string"

}

GET

/api/v1/dns_records/{id}

Playground

Server

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

Delete a DNS record

DELETE

/api/v1/dns_records/{id}

Authorizations

bearerAuth

TypeHTTP (bearer)

Parameters

Path Parameters

id*

Typestring

Required

Responses

DNS record deleted successfully

DELETE

/api/v1/dns_records/{id}

Playground

Server

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

Update a DNS record

PATCH

/api/v1/dns_records/{id}

Authorizations

bearerAuth

TypeHTTP (bearer)

Parameters

Path Parameters

id*

Typestring

Required

Request Body

application/json

JSON

{

"type": "string",

"name": "string",

"value": "string",

"ttl": 0,

"priority": 0,

"weight": 0,

"port": 0,

"target": "string"

}

Responses

DNS record updated successfully

Content-Type

application/json

JSON

{

"id": "string",

"type": "string",

"name": "string",

"value": "string",

"ttl": 0,

"priority": 0,

"weight": 0,

"port": 0,

"target": "string"

}

PATCH

/api/v1/dns_records/{id}

Playground

Server

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

Code Examples

Create User Session

javascript

const response = await fetch('https://api.pocketdns.com/api/v1/users', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    user_identifier: 'user123',
    email: '[email protected]'
  })
});

const session = await response.json();
console.log('Login URL:', session.login_url);

Create DNS Record

javascript

const record = await fetch('https://api.pocketdns.com/api/v1/dns_records', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    domain_id: 'domain123',
    type: 'A',
    name: 'www',
    value: '192.168.1.1',
    ttl: 300
  })
});

SDK Generation

Generate client libraries for your preferred programming language:

TypeScript/JavaScript

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://docs.pocketdns.com/partner-api.yml \
  -g typescript-fetch \
  -o ./pocketdns-sdk

Python

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://docs.pocketdns.com/partner-api.yml \
  -g python \
  -o ./pocketdns-sdk-python

Go

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://docs.pocketdns.com/partner-api.yml \
  -g go \
  -o ./pocketdns-sdk-go

View all supported languages →

Development Tools

Postman Collection

Import our API directly into Postman:

Open Postman
Click Import → Link
Enter: https://docs.pocketdns.com/partner-api.yml
Postman auto-generates a complete collection

Rate Limiting

Monitor your API usage with response headers:

Header	Description
`X-RateLimit-Limit`	Maximum requests per time window
`X-RateLimit-Remaining`	Requests remaining in current window
`X-RateLimit-Reset`	Unix timestamp when rate limit resets

Error Handling

All errors follow a consistent format:

json

{
  "errors": [
    "Domain not found",
    "Invalid DNS record type"
  ]
}

Common HTTP status codes:

400 - Bad Request: Invalid parameters
401 - Unauthorized: Missing or invalid API key
404 - Not Found: Resource doesn't exist
422 - Unprocessable Entity: Validation errors

Support & Resources

📚 Integration Guide - Step-by-step setup
🔧 Best Practices - Optimization tips
💬 Contact Support - Get help
📊 Status Page - Service status

PocketDNS Partner API ​

PocketDNS​

Quick Start ​

Authentication ​

Environments ​

API Operations ​

User Management ​

Domain Management ​

DNS Records ​

Create DNS Record ​

Get DNS Record ​

Update DNS Record ​

Delete DNS Record ​

Data Models & Schemas ​

PocketDNS​

Servers​

Default​

Operations​

Find or create user and initialize a new session for them​

Authorizations​

Request Body​

Responses​

Playground​

Samples​

Retrieve a list of domains for a given user​

Parameters​

Path Parameters

Responses​

Playground​

Samples​

Retrieve details of a specific domain​

Parameters​

Path Parameters

Responses​

Playground​

Samples​

Create a DNS record​

Authorizations​

Request Body​

Responses​

Playground​

Samples​

Retrieve a specific DNS record​

Authorizations​

Parameters​

Path Parameters

Responses​

Playground​

Samples​

Delete a DNS record​

Authorizations​

Parameters​

Path Parameters

Responses​

Playground​

Samples​

Update a DNS record​

Authorizations​

Parameters​

Path Parameters

Request Body​

Responses​

Playground​

Samples​

Code Examples ​

Create User Session ​

Create DNS Record ​

SDK Generation ​

TypeScript/JavaScript ​

Python ​

Go ​

Development Tools ​

Postman Collection ​

Rate Limiting ​

Error Handling ​

Support & Resources ​

PocketDNS Partner API

PocketDNS

Quick Start

Authentication

Environments

API Operations

User Management

Domain Management

DNS Records

Create DNS Record

Get DNS Record

Update DNS Record

Delete DNS Record

Data Models & Schemas

PocketDNS

Servers

Default

Operations

Find or create user and initialize a new session for them

Authorizations

Request Body

Responses

Playground

Samples

Retrieve a list of domains for a given user

Parameters

Responses

Playground

Samples

Retrieve details of a specific domain

Parameters

Responses

Playground

Samples

Create a DNS record

Authorizations

Request Body

Responses

Playground

Samples

Retrieve a specific DNS record

Authorizations

Parameters

Responses

Playground

Samples

Delete a DNS record

Authorizations

Parameters

Responses

Playground

Samples

Update a DNS record

Authorizations

Parameters

Request Body

Responses

Playground

Samples

Code Examples

Create User Session

Create DNS Record

SDK Generation

TypeScript/JavaScript

Python

Go

Development Tools

Postman Collection

Rate Limiting

Error Handling

Support & Resources