Pendahuluan
Autentikasi, base URL, dan konvensi.
Di halaman ini
- Base URL
- Authentication
- API Sections
- Account Management
- Server Management
- File Management
- Database Management
- Scheduled Tasks
- Network & Allocations
- User Management
- Backups
- Common Parameters
- Include Parameters
- Pagination
- Filtering
- Sorting
- Response Format
- Getting Started
- 1. Generate a Client API Key
- 2. Make Your First Request
- 3. Explore Available Servers
- Rate Limits
Client API memungkinkan pengguna untuk melakukan tindakan pada server yang mereka miliki aksesnya. Ini mencakup Server Management, File Operations, Database Management, dan banyak lagi.
Base URL#
Semua request harus diarahkan ke URL berikut:
https://panel.arqonara.com/api/client
Authentication#
Semua request Client API memerlukan Client API Key yang dikirimkan melalui 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#
Berikut adalah kategori fitur yang tersedia dalam API ini:
Account Management#
Kelola detail akun Anda, API keys, dan pengaturan autentikasi.
- Account Details - Melihat dan memperbarui informasi akun.
- Two-Factor Authentication - Mengaktifkan/menonaktifkan 2FA.
- API Key Management - Membuat dan mengelola API keys.
- Password Management - Memperbarui kata sandi akun.
Server Management#
Operasi inti dan informasi mengenai server.
- List Servers - Mendapatkan daftar semua server yang Anda akses.
- Server Details - Mendapatkan informasi detail server tertentu.
- Server Resources - Melihat penggunaan resource (CPU/RAM/Disk).
- Power Management - Start, stop, dan restart server.
- Console Access - Koneksi WebSocket ke konsol server.
- Send Commands - Mengirim perintah (command) ke server.
File Management#
Operasi sistem file lengkap untuk server Anda.
- List Files - Menjelajahi file dan direktori server.
- File Contents - Membaca isi file.
- Upload Files - Mengunggah file ke server.
- Download Files - Mengunduh file dari server.
- Create Directory - Membuat folder baru.
- Delete Files - Menghapus file.
- Copy & Rename - Menyalin atau mengubah nama file dan direktori.
- Compress Files - Membuat arsip (zip/tar).
Database Management#
Kelola database server dan pengguna database.
- List Databases - Melihat semua database di server.
- Create Database - Membuat database baru.
- Rotate Password - Mengubah password database.
- Delete Database - Menghapus database.
Scheduled Tasks#
Otomatisasi operasi server dengan jadwal tertentu.
- List Schedules - Melihat semua tugas terjadwal.
- Create Schedule - Membuat jadwal baru.
- Manage Tasks - Menambah/edit/hapus tugas dalam jadwal.
- Execute Schedule - Memicu jadwal secara manual.
Network & Allocations#
Kelola alokasi jaringan server dan port.
- List Allocations - Melihat alokasi server.
- Assign Allocations - Mendapatkan alokasi baru.
- Primary Allocation - Mengatur alokasi utama.
User Management#
Kelola subusers dan izin akses pada server.
- List Users - Melihat subusers server.
- User Permissions - Mengelola izin user.
- Create Subuser - Mengundang subuser baru.
- Remove Subuser - Menghapus subuser.
Backups#
(Tersedia tergantung konfigurasi panel)
- List Backups - Melihat backup server.
- Create Backup - Membuat backup baru.
- Download Backup - Mengunduh file backup.
Common Parameters#
Banyak endpoint mendukung parameter opsional berikut:
Include Parameters#
Menampilkan resource terkait (relasi) dalam respons API.
?include=egg,subusers,allocations
Pagination#
Digunakan untuk endpoint yang menampilkan daftar (List endpoints).
?page=2&per_page=50
Filtering#
Menyaring hasil berdasarkan kriteria tertentu.
?filter[name]=minecraft&filter[uuid]=1a7ce997
Sorting#
Mengurutkan hasil berdasarkan kolom tertentu.
?sort=-created_at&sort=name
Response Format#
Semua respons API mengikuti struktur JSON berikut:
{
"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#
1. Generate a Client API Key#
- Pergi ke halaman Account API.
- Klik tombol Create API Key.
- Salin key yang dihasilkan (Simpan baik-baik, key tidak akan muncul lagi).
2. Make Your First Request#
Cobalah request sederhana untuk mengecek koneksi:
curl "https://panel.arqonara.com/api/client" \
-H "Authorization: Bearer YOUR_CLIENT_API_KEY" \
-H "Accept: Application/vnd.pterodactyl.v1+json"
3. Explore Available Servers#
Gunakan respons dari request di atas untuk melihat server yang Anda miliki aksesnya. Catat Server Identifier (UUID) untuk digunakan pada request selanjutnya.
Rate Limits#
Client API dibatasi hingga 240 requests per minute per API key. Pantau header berikut dalam respons API Anda:
