Introduction

The Client API allows users to perform actions on servers to which they have access. This includes Server Management, File Operations, Database Management, and much more.

Base URL#

All requests must be directed to the following URL:

https://panel.arqonara.com/api/client

Authentication#

All Client API requests require a Client API Key sent via the Authorization header.

curl "https://panel.arqonara.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#

Below are the feature categories available in this API:

Account Management#

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

• Account Details - View and update account information.
• Two-Factor Authentication - Enable/disable 2FA.
• API Key Management - Create and manage API keys.
• Password Management - Update your account password.

Server Management#

Core operations and information about servers.

• List Servers - Get a list of all servers you have access to.
• Server Details - Get detailed information about a specific server.
• Server Resources - View resource usage (CPU/RAM/Disk).
• Power Management - Start, stop, and restart servers.
• Console Access - WebSocket connection to the server console.
• Send Commands - Send commands to the server.

File Management#

Full file system operations for your servers.

• List Files - Browse server files and directories.
• File Contents - Read file contents.
• Upload Files - Upload files to the server.
• Download Files - Download files from the server.
• Create Directory - Create a new folder.
• Delete Files - Delete files.
• Copy & Rename - Copy or rename files and directories.
• Compress Files - Create archives (zip/tar).

Database Management#

Manage server databases and database users.

• List Databases - View all databases on the server.
• Create Database - Create a new database.
• Rotate Password - Change the database password.
• Delete Database - Delete a database.

Scheduled Tasks#

Automate server operations on a schedule.

• List Schedules - View all scheduled tasks.
• Create Schedule - Create a new schedule.
• Manage Tasks - Add/edit/delete tasks within a schedule.
• Execute Schedule - Trigger a schedule manually.

Network & Allocations#

Manage server network allocations and ports.

• List Allocations - View server allocations.
• Assign Allocations - Obtain new allocations.
• Primary Allocation - Set the primary allocation.

User Management#

Manage subusers and access permissions on servers.

• List Users - View server subusers.
• User Permissions - Manage user permissions.
• Create Subuser - Invite a new subuser.
• Remove Subuser - Remove a subuser.

Backups#

(Availability depends on the panel configuration)

• List Backups - View server backups.
• Create Backup - Create a new backup.
• Download Backup - Download backup files.

Common Parameters#

Many endpoints support the following optional parameters:

Include Parameters#

Display related resources (relationships) in the API response.

?include=egg,subusers,allocations

Pagination#

Used for endpoints that return lists (List endpoints).

?page=2&per_page=50

Filtering#

Filter results by specific criteria.

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

Sorting#

Sort results by a specific column.

?sort=-created_at&sort=name

Response Format#

All API responses follow the following JSON structure:

{
  "object": "server",
  "attributes": {
    // Data resource
  },
  "meta": {
    // Metadata opsional
  }
}```txt


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

Getting Started#

Generate a Client API Key#

1. Go to the Account API page.
2. Click the Create API Key button.
3. Copy the generated key (Save it somewhere safe, the key will not be shown again).

Make Your First Request#

Try a simple request to test your connection:

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

Explore Available Servers#

Use the response from the request above to see the servers you have access to. Note the Server Identifier (UUID) to use it in subsequent requests.

Rate Limits#

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

Next Steps#