Skip to main content
Version: v1.0+

Client API

The Client API allows users to perform actions on servers they have access to. This includes server management, file operations, database management, and more.

Base URL​

https://your-panel.com/api/client

Authentication​

All Client API requests require a Client API key passed in the Authorization header:

curl "https://your-panel.com/api/client" \
  -H "Authorization: Bearer ptlc_YOUR_CLIENT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: Application/vnd.pterodactyl.v1+json"

API Sections​

Account Management​

Manage your account details, API keys, and authentication settings.

Server Management​

Core server operations and information.

File Management​

Complete file system operations for your servers.

Database Management​

Manage server databases and users.

Scheduled Tasks​

Automate server operations with schedules.

Network & Allocations​

Manage server network allocations and ports.

User Management​

Manage subusers and permissions on servers.

Backups​

(Available in some Pterodactyl installations)

Common Parameters​

Many endpoints support these optional parameters:

Include Parameters​

Expand related resources in the response:

?include=egg,subusers,allocations

Pagination​

For list endpoints:

?page=2&per_page=50

Filtering​

Filter results by specific criteria:

?filter[name]=minecraft&filter[uuid]=1a7ce997

Sorting​

Sort results by specific fields:

?sort=-created_at&sort=name

Response Format​

All API responses follow this structure:

Single Resource​

{
  "object": "server",
  "attributes": {
    // Resource data
  },
  "meta": {
    // Optional metadata
  }
}

Resource Collection​

{
  "object": "list", 
  "data": [
    {
      "object": "server",
      "attributes": {
        // Resource data
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {}
    }
  }
}

Getting Started​

  1. Generate a Client API Key

    • Go to https://your-panel.com/account/api
    • Click "Create API Key"
    • Copy the generated key

  2. Make Your First Request

    curl "https://your-panel.com/api/client" \
      -H "Authorization: Bearer YOUR_CLIENT_API_KEY" \
      -H "Accept: Application/vnd.pterodactyl.v1+json"

  3. Explore Available Servers

    • Use the response to see servers you have access to
    • Note the server identifiers for subsequent requests

Rate Limits​

The Client API is limited to 240 requests per minute per API key. Monitor the rate limit headers in responses:

X-RateLimit-Limit: 240
X-RateLimit-Remaining: 235
X-RateLimit-Reset: 1640995200

Source Code References​

All Client API endpoints are implemented in the Pterodactyl Panel source code:

For detailed source code references, see our Source References Guide.

Next Steps​