From 19ac7f0e20936e72b0c0c58545ecebe435363174 Mon Sep 17 00:00:00 2001 From: AjdinDev Date: Tue, 4 Aug 2026 09:48:25 +0000 Subject: [PATCH] Format admonition callouts in docs --- docs/api/application/databases.md | 2 +- docs/api/application/index.md | 2 +- docs/api/application/locations.md | 4 ++-- docs/api/application/nests-eggs.md | 2 +- docs/api/application/nodes.md | 2 +- docs/api/application/servers.md | 6 +++--- docs/api/application/users.md | 2 +- docs/api/client/account.md | 2 +- docs/api/client/backups.md | 4 ++-- docs/api/client/databases.md | 4 ++-- docs/api/client/files.md | 4 ++-- docs/api/client/network.md | 4 ++-- docs/api/client/schedules.md | 2 +- docs/api/client/servers.md | 6 +++--- docs/api/client/users.md | 6 +++--- docs/api/websocket.md | 2 +- docs/authentication.md | 2 +- versioned_docs/version-0.7/intro.md | 2 +- 18 files changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/api/application/databases.md b/docs/api/application/databases.md index 3d90b61..87843dc 100644 --- a/docs/api/application/databases.md +++ b/docs/api/application/databases.md @@ -11,7 +11,7 @@ import CodeTabs from '@site/src/components/CodeTabs'; The Application API Database Management endpoints allow administrators to manage databases for servers. These endpoints provide operations for creating, viewing, and managing MySQL databases associated with servers. -:::warning Administrative Access Required +:::warning[Administrative Access Required] These endpoints require administrative privileges and an Application API key with appropriate permissions. ::: diff --git a/docs/api/application/index.md b/docs/api/application/index.md index 5a2f652..d543b62 100644 --- a/docs/api/application/index.md +++ b/docs/api/application/index.md @@ -31,7 +31,7 @@ curl "https://your-panel.com/api/application/users" \ -H "Accept: Application/vnd.pterodactyl.v1+json" ``` -:::warning Administrative Access Required +:::warning[Administrative Access Required] These endpoints require administrative privileges and should only be used by trusted applications with proper authentication. Application API keys provide full panel access. ::: diff --git a/docs/api/application/locations.md b/docs/api/application/locations.md index caeee6b..e109b8f 100644 --- a/docs/api/application/locations.md +++ b/docs/api/application/locations.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; The Application API Location Management endpoints allow administrators to manage geographic locations in the panel. Locations are used to organize nodes by geographic regions or data centers for better server management and user experience. -:::warning Administrative Access Required +:::warning[Administrative Access Required] These endpoints require administrative privileges and should only be used by trusted applications with proper authentication. ::: @@ -997,7 +997,7 @@ Delete a location from the panel. This action is irreversible. DELETE /api/application/locations/{location} ``` -:::warning Dependencies Required +:::warning[Dependencies Required] A location can only be deleted if it has no associated nodes. Move or delete all nodes in the location before attempting to delete it. ::: diff --git a/docs/api/application/nests-eggs.md b/docs/api/application/nests-eggs.md index 354ec20..1e2ea47 100644 --- a/docs/api/application/nests-eggs.md +++ b/docs/api/application/nests-eggs.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; The Application API Nests & Eggs Management endpoints allow administrators to manage server types and configurations. Nests are categories that group similar server types (like "Minecraft" or "Discord Bots"), while eggs are specific server configurations within those nests (like "Vanilla Minecraft" or "Paper"). -:::warning Administrative Access Required +:::warning[Administrative Access Required] These endpoints require administrative privileges and should only be used by trusted applications with proper authentication. ::: diff --git a/docs/api/application/nodes.md b/docs/api/application/nodes.md index 4dd40e6..dab3aeb 100644 --- a/docs/api/application/nodes.md +++ b/docs/api/application/nodes.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; The Application API Node Management endpoints allow administrators to manage Wings daemon nodes in the panel. These endpoints provide comprehensive node lifecycle management including creation, configuration, allocation management, and deletion. -:::warning Administrative Access Required +:::warning[Administrative Access Required] These endpoints require administrative privileges and should only be used by trusted applications with proper authentication. ::: diff --git a/docs/api/application/servers.md b/docs/api/application/servers.md index 98b2857..250e5be 100644 --- a/docs/api/application/servers.md +++ b/docs/api/application/servers.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; The Application API Server Management endpoints allow administrators to manage all servers in the panel. These endpoints provide comprehensive server lifecycle management including creation, configuration, suspension, and deletion. -:::warning Administrative Access Required +:::warning[Administrative Access Required] These endpoints require administrative privileges and should only be used by trusted applications with proper authentication. ::: @@ -2463,7 +2463,7 @@ curl -X POST "https://your-panel.com/api/application/servers/2/databases/3/reset } ``` -:::warning Password Security +:::warning[Password Security] The new password is only returned in this response. Store it securely as it cannot be retrieved again through the API. ::: @@ -2485,7 +2485,7 @@ curl -X DELETE "https://your-panel.com/api/application/servers/2/databases/3" \ Returns empty response body with status code 204. -:::danger Warning +:::danger[Warning] Database deletion is **permanent and irreversible**. All data will be lost. ::: diff --git a/docs/api/application/users.md b/docs/api/application/users.md index dbd58f9..51ddb34 100644 --- a/docs/api/application/users.md +++ b/docs/api/application/users.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; The Application API User Management endpoints allow administrators to manage all users in the panel. These endpoints provide full CRUD (Create, Read, Update, Delete) operations for user accounts. -:::warning Administrative Access Required +:::warning[Administrative Access Required] These endpoints require administrative privileges and should only be used by trusted applications with proper authentication. ::: diff --git a/docs/api/client/account.md b/docs/api/client/account.md index 7f8551b..f36e780 100644 --- a/docs/api/client/account.md +++ b/docs/api/client/account.md @@ -670,7 +670,7 @@ curl -X POST "https://your-panel.com/api/client/account/api-keys" \ ``` -:::warning Important +:::warning[Important] The `secret_token` in the `meta` object is only returned once during creation. Store it securely as it cannot be retrieved again. ::: diff --git a/docs/api/client/backups.md b/docs/api/client/backups.md index 9cb653f..1ac028f 100644 --- a/docs/api/client/backups.md +++ b/docs/api/client/backups.md @@ -1676,7 +1676,7 @@ BackupManager.delete_backup('d3aac109', 'c3948f1a-67b2-4d89-8c45-a1b2c3d4e5f6') Returns empty response body with status code 204. -:::danger Warning +:::danger[Warning] Backup deletion is **permanent and irreversible**. Deleted backups cannot be recovered. ::: @@ -2047,7 +2047,7 @@ BackupManager.restore_backup('d3aac109', 'a4962fe6-90c8-4b89-ba62-a5d3b06426c0') Returns empty response body with status code 202 (Accepted). -:::warning Important +:::warning[Important] Backup restoration will **permanently replace all server files** with the backup contents. Make sure to create a backup of the current state if needed. ::: diff --git a/docs/api/client/databases.md b/docs/api/client/databases.md index fd4b7f2..5a70cf1 100644 --- a/docs/api/client/databases.md +++ b/docs/api/client/databases.md @@ -392,7 +392,7 @@ if ($httpCode === 200) { } ``` -:::warning Important +:::warning[Important] Password rotation immediately invalidates the old password. Update your application configuration before rotating passwords to avoid connection failures. ::: @@ -423,7 +423,7 @@ curl -X DELETE "https://your-panel.com/api/client/servers/d3aac109/databases/s4_ Returns empty response body with status code 204. -:::danger Permanent Deletion +:::danger[Permanent Deletion] Database deletion is irreversible and will permanently destroy all data. Always create backups before deleting databases. ::: diff --git a/docs/api/client/files.md b/docs/api/client/files.md index d20fd19..5c45eaa 100644 --- a/docs/api/client/files.md +++ b/docs/api/client/files.md @@ -1156,7 +1156,7 @@ curl -X POST "https://your-panel.com/api/client/servers/d3aac109/files/delete" \ Returns empty response body with status code 204. -:::warning Permanent Deletion +:::warning[Permanent Deletion] File deletion is permanent and cannot be undone. Always ensure you have backups before deleting important files. ::: @@ -1932,7 +1932,7 @@ puts "Files deleted successfully"` Returns empty response body with status code 204. -:::warning Important +:::warning[Important] Deleted files cannot be recovered. Always create backups before deleting important files. ::: diff --git a/docs/api/client/network.md b/docs/api/client/network.md index c96185f..7305a89 100644 --- a/docs/api/client/network.md +++ b/docs/api/client/network.md @@ -223,7 +223,7 @@ Request assignment of an available allocation to the server. This endpoint does not accept a request body. When client auto-allocation is enabled, Pterodactyl selects an available allocation using the server's primary allocation IP, or creates one from the configured auto-allocation port range. -:::tip Assigning Specific Allocations +:::tip[Assigning Specific Allocations] The Client API cannot request a specific IP address or port. To assign specific allocation IDs, use the [Application API server build configuration endpoint](../application/servers#update-server-build-configuration) with `add_allocations` or `remove_allocations`. ::: @@ -632,7 +632,7 @@ puts "Primary allocation set: #{data['attributes']}" ``` -:::info Primary Allocation +:::info[Primary Allocation] The primary allocation is the main IP:Port combination used for server connections. Only one allocation can be primary at a time. ::: diff --git a/docs/api/client/schedules.md b/docs/api/client/schedules.md index 50329cb..9b7bb08 100644 --- a/docs/api/client/schedules.md +++ b/docs/api/client/schedules.md @@ -1381,7 +1381,7 @@ end Returns empty response body with status code 204. -:::danger Warning +:::danger[Warning] Schedule deletion is **permanent and irreversible**. All associated tasks will also be deleted. ::: diff --git a/docs/api/client/servers.md b/docs/api/client/servers.md index 226c517..5e8c510 100644 --- a/docs/api/client/servers.md +++ b/docs/api/client/servers.md @@ -1184,7 +1184,7 @@ curl -X POST "https://your-panel.com/api/client/servers/d3aac109/settings/reinst Returns empty response body with status code 202. -:::warning Important +:::warning[Important] Reinstalling a server will just **rerun the install script** with all files still on the server. There is also no endpoint to delete all files. ::: @@ -1307,7 +1307,7 @@ Returns empty response body with status code 204. } ``` -:::info Available Images +:::info[Available Images] The available Docker images are defined by the server's egg configuration. Use the startup configuration endpoint to see available images in the `meta.docker_images` field. ::: @@ -2003,7 +2003,7 @@ Trigger a reinstallation of the server. This will stop the server and re-run the **`POST /api/client/servers/{server}/settings/reinstall`** -:::warning Important +:::warning[Important] Reinstalling a server will just **rerun the install script** with all files still on the server. There is also no endpoint to delete all files. ::: diff --git a/docs/api/client/users.md b/docs/api/client/users.md index 4884606..fb31b5d 100644 --- a/docs/api/client/users.md +++ b/docs/api/client/users.md @@ -1168,7 +1168,7 @@ puts "User permissions updated: #{data['attributes']}" ``` -:::info Permission Updates +:::info[Permission Updates] Permission updates completely replace the user's existing permissions. Include all permissions you want the user to have, not just the ones you're adding. ::: @@ -1378,7 +1378,7 @@ end Returns empty response body with status code 204. -:::warning Access Removal +:::warning[Access Removal] Removing a subuser immediately revokes all their access to the server. They will be logged out and unable to perform any actions. ::: @@ -1734,7 +1734,7 @@ User management operations require specific permissions: | `user.update` | Modify subuser permissions | | `user.delete` | Remove subusers | -:::info Server Owner Privileges +:::info[Server Owner Privileges] Server owners automatically have all permissions and can perform all user management operations regardless of explicit permission grants. ::: diff --git a/docs/api/websocket.md b/docs/api/websocket.md index 1f3a929..b928f55 100644 --- a/docs/api/websocket.md +++ b/docs/api/websocket.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; The WebSocket API enables real-time communication with Pterodactyl servers, providing live console access, log streaming, and power state monitoring. This API is essential for building interactive server management interfaces. -:::warning Client API Access Only +:::warning[Client API Access Only] WebSocket connections use Client API authentication and provide access only to servers the authenticated user owns or has permissions for. Users must have the `websocket.connect` permission to obtain tokens. ::: diff --git a/docs/authentication.md b/docs/authentication.md index e316157..3095d8e 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -87,7 +87,7 @@ curl "https://your-panel.com/api/application/users" \ ## API Key Security -:::warning Security Best Practices +:::warning[Security Best Practices] - **Never expose your API keys** in client-side code or public repositories - **Use IP restrictions** when possible to limit key usage - **Rotate keys regularly** for enhanced security diff --git a/versioned_docs/version-0.7/intro.md b/versioned_docs/version-0.7/intro.md index 364e255..9136ccc 100644 --- a/versioned_docs/version-0.7/intro.md +++ b/versioned_docs/version-0.7/intro.md @@ -6,7 +6,7 @@ sidebar_position: 1 Welcome to the **Pterodactyl v0.7** API documentation. This is a minimalistic version of the API reference for legacy installations. -:::warning Legacy Version +:::warning[Legacy Version] Pterodactyl v0.7 is **deprecated**. Please upgrade to the latest version as soon as possible. This documentation is provided for legacy installations only. :::