}]] c:["Account details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] d:["List API keys"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] e:["List SSH keys"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] f:["Create API key"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 10:["Create SSH key"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 11:["Disable 2FA"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 12:["Enable 2FA"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 13:["Remove SSH key"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 14:["Update email"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 15:["Update password"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 16:["Console details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 17:["Resource usage"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 18:["Server activity"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 19:["Server details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1a:["Change power state"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1b:["Send command"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1c:["Delete database"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 1d:["List databases"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 1e:["Create database"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 1f:["Rotate password"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 20:["Download file"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 21:["Get file contents"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 22:["List files"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 23:["Upload file"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 24:["Change file permissions"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 25:["Compress file"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 26:["Copy file"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 27:["Create folder"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 28:["Decompress file"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 29:["Delete file"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 2a:["Pull remote file"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 2b:["Write file"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 2c:["Rename file"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 2d:["Delete schedule"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 2e:["Delete task"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 2f:["List schedules"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 30:["Schedule details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 31:["Create schedule"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 32:["Create task"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 33:["Execute schedule"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 34:["Update schedule"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 35:["Update task"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 36:["Unassign allocation"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 37:["List allocations"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 38:["Assign allocation"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 39:["Set allocation note"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 3a:["Set primary allocation"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 3b:["Delete user"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 3c:["List Users"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 3d:["User details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 3e:["Create User"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 3f:["Update user"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 40:["Delete backup"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 41:["Backup details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 42:["Download backup"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 43:["List backups"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 44:["Create backup"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 45:["Restore backup"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 46:["Toggle backup lock"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 47:["List Variables"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 48:["Update Variable"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 49:["Reinstall server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 4a:["Rename server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 4b:["Update Docker image"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 4c:["Delete user"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 4d:["List users"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 4e:["User details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 4f:["User details by external ID"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 50:["Update user"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 51:["Create user"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 52:["Delete node"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 53:["List deployable nodes"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 54:["List nodes"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 55:["Node configuration"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 56:["Node details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 57:["Update node"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 58:["Create node"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 59:["Delete allocation"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 5a:["List allocations"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 5b:["Create allocations"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 5c:["Delete location"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 5d:["List locations"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 5e:["Location details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 5f:["Update location"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 60:["Create location"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 61:["Delete server"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 62:["Force delete server"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 63:["List servers"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 64:["Server details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 65:["Server details by external ID"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 66:["Update build"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 67:["Update details"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 68:["Update startup"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 69:["Create server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 6a:["Reinstall server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 6b:["Suspend server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 6c:["Unsuspend server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 6d:["Delete database"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 6e:["Database details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 6f:["List databases"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 70:["Create database"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 71:["Reset password"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 72:["List nests"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 73:["Nest details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 74:["Egg details"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 75:["List eggs"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 76:["List languages"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 77:["List extensions"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 78:["Install extension"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 79:["Get extension settings"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 7a:["Update extension settings"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 7b:["Enable extension"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 7c:["Disable extension"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 7d:["Remove extension"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 7e:["List users"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 7f:["Create user"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 80:["Get user by external ID"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 81:["Get user"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 82:["Delete user"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 83:["Disable user two-factor authentication"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 84:["Update user"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 85:["Get node system information"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 86:["Create node deploy token"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 87:["Get node utilization"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 88:["List server mounts"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 89:["Attach server mount"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 8a:["Detach server mount"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 8b:["List servers"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 8c:["Create server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 8d:["Get server by external ID"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 8e:["Get server"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 8f:["Delete server"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 90:["Update server details"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 91:["Update server build"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 92:["Update server startup"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 93:["Update server suspension"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 94:["Reinstall server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 95:["Rebuild server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 96:["Get server transfer progress"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 97:["Transfer server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 98:["Toggle server install state"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 99:["Force delete server"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 9a:["List server databases"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 9b:["Create server database"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 9c:["Get server database"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 9d:["Delete server database"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 9e:["Rotate server database password"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 9f:["List server backups"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] a0:["Toggle server backup lock"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] a1:["List nodes"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] a2:["Create node"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] a3:["Get node"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] a4:["Delete node"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] a5:["Get node configuration"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] a6:["Update node"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] a7:["Sync node game tags"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] a8:["Sync node deployment tags"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] a9:["List node allocations"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] aa:["Create node allocations"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] ab:["Bulk delete node allocations"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] ac:["List node allocation IPs"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] ad:["List available node allocations"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] ae:["Delete node allocation IP block"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] af:["Update node allocation"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] b0:["Delete node allocation"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] b1:["List locations"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] b2:["Create location"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] b3:["Get location"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] b4:["Delete location"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] b5:["List eligible location nodes"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] b6:["Update location"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] b7:["List mounts"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] b8:["Create mount"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] b9:["Get mount"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] ba:["Delete mount"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] bb:["Update mount"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] bc:["Attach eggs to mount"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] bd:["Detach egg from mount"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] be:["Attach nodes to mount"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] bf:["Detach node from mount"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] c0:["List egg catalog"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] c1:["Refresh egg catalog"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] c2:["Import catalog egg"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] c3:["List egg variables"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] c4:["Create egg variable"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] c5:["Reorder egg variables"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] c6:["Update egg variable"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] c7:["Delete egg variable"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] c8:["Get egg install script"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] c9:["Update egg install script"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] ca:["Export egg"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] cb:["Update egg from import"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] cc:["Sync egg tags"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] cd:["Import egg"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] ce:["List eggs"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] cf:["Create egg"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] d0:["Get egg"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] d1:["Delete egg"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] d2:["Update egg"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] d3:["List tags"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] d4:["Create tag"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] d5:["Get tag"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] d6:["Delete tag"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] d7:["Update tag"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] d8:["Get settings"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] d9:["Update general settings"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] da:["Update mail settings"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] db:["Send test mail"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] dc:["Update advanced settings"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] dd:["List database hosts"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] de:["Create database host"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] df:["Get database host"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] e0:["Delete database host"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] e1:["Update database host"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] e2:["List database host databases"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] e3:["List API keys"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] e4:["Create API key"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] e5:["Get API key"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] e6:["Delete API key"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] e7:["Update API key"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] e8:["Get version information"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] e9:["List users"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] ea:["Create user"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] eb:["Get user"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] ec:["Update user"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] ed:["Delete user"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] ee:["Get user by external ID"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] ef:["List nodes"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] f0:["Create node"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] f1:["List deployable nodes"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] f2:["Get node"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] f3:["Delete node"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] f4:["Get node configuration"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] f5:["Update node"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] f6:["List node allocations"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] f7:["Create node allocations"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] f8:["Delete node allocation"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] f9:["List locations"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] fa:["Create location"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] fb:["Get location"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] fc:["Update location"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] fd:["Delete location"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] fe:["List eggs"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] ff:["Get egg"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 100:["List tags"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 101:["Get tag"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 102:["List servers"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 103:["Create server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 104:["Get server"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 105:["Delete server"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 106:["Get server by external ID"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 107:["Update server details"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 108:["Update server build"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 109:["Update server startup"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 10a:["Suspend server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 10b:["Unsuspend server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 10c:["Reinstall server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 10d:["Delete server"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 10e:["List server databases"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 10f:["Create server database"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 110:["Get server database"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 111:["Delete server database"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 112:["Reset server database password"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 113:["Login"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 114:["Complete login checkpoint"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 115:["Request password reset email"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 116:["Reset password"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 117:["Logout"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 118:["List client servers"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 119:["List server permissions"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 11a:["Get account"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 11b:["Get two-factor setup"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 11c:["Enable two-factor authentication"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 11d:["Disable two-factor authentication"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 11e:["Update account email"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 11f:["Update account password"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 120:["List account activity"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 121:["List account API keys"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 122:["Create account API key"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 123:["Delete account API key"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 124:["List SSH keys"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 125:["Create SSH key"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 126:["Delete SSH key"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 127:["Get server"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 128:["Get websocket credentials"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 129:["Get server resources"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 12a:["List server activity"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 12b:["Send server command"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 12c:["Send power action"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 12d:["List server databases"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 12e:["Create server database"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 12f:["Rotate server database password"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 130:["Delete server database"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 131:["List files"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 132:["Get file contents"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 133:["Get file download URL"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 134:["Rename files"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 135:["Copy file"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 136:["Write file contents"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 137:["Compress files"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 138:["Decompress file"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 139:["Delete files"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 13a:["Create folder"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 13b:["Change file permissions"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 13c:["Pull remote file"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 13d:["Get file upload URL"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 13e:["List server schedules"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 13f:["Create server schedule"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 140:["Get server schedule"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 141:["Update server schedule"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 142:["Delete server schedule"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 143:["Execute server schedule"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 144:["Create schedule task"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 145:["Update schedule task"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 146:["Delete schedule task"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 147:["List server allocations"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 148:["Create server allocation"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 149:["Update allocation notes"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 14a:["Delete server allocation"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 14b:["Set primary allocation"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 14c:["List server subusers"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 14d:["Create server subuser"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 14e:["Get server subuser"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 14f:["Update server subuser"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 150:["Delete server subuser"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 151:["List server backups"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 152:["Create server backup"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 153:["Get server backup"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 154:["Delete server backup"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 155:["Get backup download URL"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 156:["Toggle backup lock"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 157:["Restore server backup"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 158:["Get startup configuration"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 159:["Update startup variable"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 15a:["Rename server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 15b:["Reinstall server"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 15c:["Set server Docker image"," ",["$","span",null,{"className":"font-mono font-medium text-yellow-600 dark:text-yellow-400 ms-auto text-xs text-nowrap","children":"PUT"}]] 15d:["Get CSRF cookie"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 15e:["$","span",null,{"className":"flex items-center gap-3","children":[["$","img",null,{"src":"/pterodactyl-lockup.svg","alt":"Pterodactyl","width":108,"height":20,"className":"h-5 w-auto"}],["$","span",null,{"className":"border-l border-hairline-strong pl-3 font-mono text-mono-md font-normal text-fg-subtle","children":"docs"}]]}] 15f:["$","$L4",null,{"parallelRouterKey":"children","error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L5",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":[[["$","title",null,{"children":"404: This page could not be found."}],["$","div",null,{"style":"$0:f:0:1:0:props:children:1:props:children:props:children:props:children:props:notFound:0:1:props:style","children":["$","div",null,{"children":[["$","style",null,{"dangerouslySetInnerHTML":{"__html":"body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}"}}],["$","h1",null,{"className":"next-error-h1","style":"$0:f:0:1:0:props:children:1:props:children:props:children:props:children:props:notFound:0:1:props:children:props:children:1:props:style","children":404}],["$","div",null,{"style":"$0:f:0:1:0:props:children:1:props:children:props:children:props:children:props:notFound:0:1:props:children:props:children:2:props:style","children":["$","h2",null,{"style":"$0:f:0:1:0:props:children:1:props:children:props:children:props:children:props:notFound:0:1:props:children:props:children:2:props:children:props:style","children":"This page could not be found."}]}]]}]}]],[]],"forbidden":"$undefined","unauthorized":"$undefined"}] 160:["$","$1","c",{"children":[null,["$","$L4",null,{"parallelRouterKey":"children","error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L5",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":"$undefined","forbidden":"$undefined","unauthorized":"$undefined"}]]}] 161:["$","$1","c",{"children":["$L167",[["$","script","script-0",{"src":"/_next/static/chunks/3a3og9pn9zkbe.js","async":true,"nonce":"$undefined"}],["$","script","script-1",{"src":"/_next/static/chunks/25e8f1mqr-x8t.js","async":true,"nonce":"$undefined"}]],["$","$L168",null,{"children":["$","$169",null,{"name":"Next.MetadataOutlet","children":"$@16a"}]}]]}] 163:["$","$1","h",{"children":[null,["$","$L16b",null,{"children":"$L16c"}],["$","div",null,{"hidden":true,"children":["$","$L16d",null,{"children":["$","$169",null,{"name":"Next.Metadata","children":"$L16e"}]}]}],["$","meta",null,{"name":"next-size-adjust","content":""}]]}] 165:["$","link","0",{"rel":"stylesheet","href":"/_next/static/chunks/43wma7xonha8m.css","precedence":"next","crossOrigin":"$undefined","nonce":"$undefined"}] 166:["$","link","1",{"rel":"stylesheet","href":"/_next/static/chunks/1bkaj2d4cogmd.css","precedence":"next","crossOrigin":"$undefined","nonce":"$undefined"}] 162:C 167:["$","$L16f",null,{"toc":[],"full":true,"children":[["$","$L170",null,{"children":"Get CSRF cookie"}],["$","$L171",null,{"children":"Initializes the Laravel Sanctum CSRF cookie required before browser-session authentication requests."}],["$","$L172",null,{"children":["$undefined","$L173"]}]]}] 173:["$","$L174",null,{"operations":[{"path":"/sanctum/csrf-cookie","method":"get"}],"payload":{"bundled":{"openapi":"3.2.0","info":{"title":"Pterodactyl 2.0 API Reference","description":"OpenAPI reference for the Application, Client, and Admin APIs.","version":"2.0.0-dev"},"servers":[{"url":"https://panel.example.com","description":"Replace with your panel URL"}],"tags":[{"name":"Admin API","description":"Root administrator endpoints for managing panel configuration and resources."},{"name":"Application API","description":"Root administrator endpoints for managing panel resources using application API tokens."},{"name":"Authentication","description":"Browser session authentication endpoints used by the panel frontend."},{"name":"Client API","description":"Endpoints authenticated as a panel user using a client API token."},{"name":"Endpoints","description":""}],"components":{"securitySchemes":{"default":{"type":"http","scheme":"bearer","description":"Application API requests require an application API token, or a client API token, that belongs to a root administrator. Admin API requests require a client API token that belongs to a root administrator, and reject application API tokens. Client API requests require a client API token."},"panelSession":{"type":"apiKey","in":"cookie","name":"pterodactyl_session","description":"Browser session cookie. This is the default name; SESSION_COOKIE or APP_NAME can change it for a deployment."}},"schemas":{"AdminAllocationAttributes":{"type":"object","required":["id","ip","alias","port","notes","server_id","server_name","assigned"],"properties":{"id":{"type":"integer","examples":[9864]},"ip":{"type":"string","examples":["43.197.122.240"]},"alias":{"type":["string","null"]},"port":{"type":"integer","examples":[23726]},"notes":{"type":["string","null"]},"server_id":{"type":["integer","null"]},"server_name":{"type":["string","null"]},"assigned":{"type":"boolean","examples":[false]}}},"AdminAllocationListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminAllocationResource"}}}},"AdminAllocationPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminAllocationResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminAllocationResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["allocation"]},"attributes":{"$ref":"#/components/schemas/AdminAllocationAttributes"}}},"AdminApiKeyAttributes":{"type":"object","required":["identifier","memo","created_by","last_used_at","created_at","r_servers","r_nodes","r_allocations","r_users","r_locations","r_eggs","r_database_hosts","r_server_databases"],"properties":{"identifier":{"type":"string","examples":["ptla_XXEfTMoV80W"]},"memo":{"type":"string","examples":["Test Function Key"]},"created_by":{"type":"object","required":["id","username","email"],"properties":{"id":{"type":"integer","examples":[1]},"username":{"type":"string","examples":["admin"]},"email":{"type":"string","examples":["admin@example.com"]}}},"last_used_at":{"type":["string","null"]},"created_at":{"type":"string","examples":["2026-09-22T14:45:26+00:00"]},"r_servers":{"type":"integer","examples":[0]},"r_nodes":{"type":"integer","examples":[0]},"r_allocations":{"type":"integer","examples":[0]},"r_users":{"type":"integer","examples":[0]},"r_locations":{"type":"integer","examples":[0]},"r_eggs":{"type":"integer","examples":[0]},"r_database_hosts":{"type":"integer","examples":[0]},"r_server_databases":{"type":"integer","examples":[0]}}},"AdminApiKeyPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminApiKeyResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminApiKeyResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["api_key"]},"attributes":{"$ref":"#/components/schemas/AdminApiKeyAttributes"},"meta":{"type":"object","required":["secret_token"],"properties":{"secret_token":{"type":"string","examples":["ptla_1234567890abcdef"]}}}}},"AdminBackupAttributes":{"type":"object","required":["uuid","name","ignored_files","checksum","bytes","is_successful","is_locked","created_at","completed_at"],"properties":{"uuid":{"type":"string","examples":["ce8a4c18-b8e3-4dbc-903c-c961df2b5f19"]},"name":{"type":"string","examples":["Odit et et modi."]},"ignored_files":{"type":"array","items":{"type":"string"}},"checksum":{"type":["string","null"]},"bytes":{"type":"integer","examples":[0]},"is_successful":{"type":"boolean","examples":[true]},"is_locked":{"type":"boolean","examples":[false]},"created_at":{"type":"string","examples":["2026-09-22T14:45:25+00:00"]},"completed_at":{"type":"string","examples":["2026-09-22T14:45:25+00:00"]}}},"AdminBackupPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminBackupResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminBackupResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["backup"]},"attributes":{"$ref":"#/components/schemas/AdminBackupAttributes"}}},"AdminDatabaseAttributes":{"type":"object","required":["server","name","username","connections_from","max_connections"],"properties":{"server":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","examples":[1]},"name":{"type":"string","examples":["Survival"]}}},"name":{"type":"string","examples":["s1_database"]},"username":{"type":"string","examples":["u1_database"]},"connections_from":{"type":"string","examples":["%"]},"max_connections":{"type":["integer","null"],"examples":[0]}}},"AdminDatabaseHostAttributes":{"type":"object","required":["id","name","host","port","username","max_databases","databases_count","node_id","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[1554]},"name":{"type":"string","examples":["LightPink"]},"host":{"type":"string","examples":["33.150.237.51"]},"port":{"type":"integer","examples":[3306]},"username":{"type":"string","examples":["Gold"]},"max_databases":{"type":["integer","null"],"examples":[50]},"databases_count":{"type":"integer","examples":[0]},"node_id":{"type":["integer","null"],"examples":[1]},"created_at":{"type":"string","examples":["2026-09-22T14:45:26+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:26+00:00"]},"relationships":{"type":"object","properties":{"node":{"oneOf":[{"$ref":"#/components/schemas/AdminNodeResource"},{"$ref":"#/components/schemas/NullResource"}]},"databases":{"oneOf":[{"$ref":"#/components/schemas/AdminDatabaseListResponse"},{"$ref":"#/components/schemas/NullResource"}]}}}}},"AdminDatabaseHostPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminDatabaseHostResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminDatabaseHostResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["database_host"]},"attributes":{"$ref":"#/components/schemas/AdminDatabaseHostAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.com/api/admin/database-hosts/1"]}}}}},"AdminDatabaseListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminDatabaseResource"}}}},"AdminDatabasePaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminDatabaseResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminDatabaseResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["database"]},"attributes":{"$ref":"#/components/schemas/AdminDatabaseAttributes"}}},"AdminEggAttributes":{"type":"object","required":["id","uuid","author","name","description","features","docker_image","docker_images","force_outgoing_ip","config","startup","script","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[9880]},"uuid":{"type":"string","examples":["f05076e2-3f79-44fe-b9c3-007df7879f42"]},"author":{"type":"string","examples":["support@pterodactyl.io"]},"name":{"type":"string","examples":["Mrs. Justina Gaylord"]},"description":{"type":["string","null"],"examples":["Mollitia modi deserunt aut ab provident perspiciatis quo. Nostrum aut adipisci quidem nostrum. Commodi incidunt iure odit."]},"features":{"type":["array","null"],"items":{"type":"string","examples":["eula"]}},"docker_image":{"type":"string","examples":["ghcr.io/pterodactyl/yolks:java_23"]},"docker_images":{"type":"object","additionalProperties":{"type":"string"},"examples":[{"Java 23":"ghcr.io/pterodactyl/yolks:java_23"}]},"force_outgoing_ip":{"type":["boolean","null"],"examples":[false]},"config":{"type":"object","required":["files","startup","stop","logs","file_denylist","extends"],"properties":{"files":{"$ref":"#/components/schemas/AdminEggConfigurationFiles"},"startup":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"examples":[{"done":["Done"]}]},"stop":{"type":"string","examples":["stop"]},"logs":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"examples":[{"custom":true,"location":"logs/latest.log"}]},"file_denylist":{"type":["array","null"],"items":{"type":"string"},"examples":[["secret.txt"]]},"extends":{"type":["integer","null"]}}},"startup":{"type":"string","examples":["java -jar test.jar"]},"script":{"type":"object","required":["privileged","install","entry","container","extends"],"properties":{"privileged":{"type":["boolean","null"],"examples":[true]},"install":{"type":["string","null"]},"entry":{"type":"string","examples":["ash"]},"container":{"type":"string","examples":["alpine:3.4"]},"extends":{"type":["integer","null"]}}},"created_at":{"type":"string","examples":["2026-09-22T14:45:26+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:26+00:00"]},"relationships":{"type":"object","properties":{"variables":{"oneOf":[{"$ref":"#/components/schemas/AdminEggVariableListResponse"},{"$ref":"#/components/schemas/NullResource"}]},"tags":{"oneOf":[{"$ref":"#/components/schemas/AdminTagListResponse"},{"$ref":"#/components/schemas/NullResource"}]},"servers":{"oneOf":[{"$ref":"#/components/schemas/AdminServerListResponse"},{"$ref":"#/components/schemas/NullResource"}]}}}}},"AdminEggConfigurationFile":{"type":"object","properties":{"parser":{"type":"string"},"find":{"$ref":"#/components/schemas/AdminEggConfigurationFind"}}},"AdminEggConfigurationFiles":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AdminEggConfigurationFile"},"examples":[{"server.properties":{"parser":"properties","find":{"server-port":"{{server.build.default.port}}"}}}]},"AdminEggConfigurationFind":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object","additionalProperties":{"type":"string"}}]}},"AdminEggListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminEggResource"}}}},"AdminEggPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminEggResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminEggResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["egg"]},"attributes":{"$ref":"#/components/schemas/AdminEggAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.com/api/admin/eggs/1"]}}}}},"AdminEggVariableAttributes":{"type":"object","required":["id","egg_id","name","description","env_variable","default_value","user_viewable","user_editable","rules","sort_order","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[3952]},"egg_id":{"type":"integer","examples":[9881]},"name":{"type":"string","examples":["Payton"]},"description":{"type":"string","examples":["Ipsum nostrum omnis autem et consequatur aut dolores enim."]},"env_variable":{"type":"string","examples":["NON_FACERE"]},"default_value":{"type":"string","examples":["GoldenRod"]},"user_viewable":{"type":"boolean","examples":[false]},"user_editable":{"type":"boolean","examples":[false]},"rules":{"type":"string","examples":["required|string"]},"sort_order":{"type":["integer","null"],"examples":[0]},"created_at":{"type":"string","examples":["2026-09-22T14:45:26+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:26+00:00"]}}},"AdminEggVariableListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminEggVariableResource"}}}},"AdminEggVariableResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["egg_variable"]},"attributes":{"$ref":"#/components/schemas/AdminEggVariableAttributes"}}},"AdminExtensionSettingField":{"type":"object","required":["input","label","help","field","options","value"],"properties":{"input":{"type":"string","examples":["curseforge_api_key"]},"label":{"type":"string","examples":["CurseForge API Key"]},"help":{"type":["string","null"],"examples":["Leave blank to keep the stored key."]},"field":{"type":"string","enum":["text","password","number","toggle","select"],"examples":["password"]},"options":{"type":"array","items":{"$ref":"#/components/schemas/AdminExtensionSettingOption"}},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"nullable":true}}},"AdminExtensionSettingOption":{"type":"object","required":["value","label"],"properties":{"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"label":{"type":"string","examples":["Recommended"]}}},"AdminLanguagesResponse":{"type":"object","description":"Available panel locales keyed by locale code.","additionalProperties":{"type":"string"},"examples":[{"en":"English"}]},"AdminLocationAttributes":{"type":"object","required":["id","short","long","nodes_count","servers_count","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[16053]},"short":{"type":"string","examples":["yXYh3ig7"]},"long":{"type":"string","examples":["DtTf5dbTXXUq1fV3VBHWMKFch7pKkxN4"]},"nodes_count":{"type":"integer","examples":[0]},"servers_count":{"type":"integer","examples":[0]},"created_at":{"type":"string","examples":["2026-09-22T14:45:26+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:26+00:00"]},"relationships":{"type":"object","properties":{"nodes":{"oneOf":[{"$ref":"#/components/schemas/AdminNodeListResponse"},{"$ref":"#/components/schemas/NullResource"}]}}}}},"AdminLocationPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminLocationResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminLocationResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["location"]},"attributes":{"$ref":"#/components/schemas/AdminLocationAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.com/api/admin/locations/1"]}}}}},"AdminMountAttributes":{"type":"object","required":["id","uuid","name","description","source","target","read_only","user_mountable","eggs_count","nodes_count","servers_count"],"properties":{"id":{"type":"integer","examples":[1]},"uuid":{"type":"string","examples":["1b19cf3f-2f89-4f88-a81e-321e7fe326bc"]},"name":{"type":"string","examples":["Shared Mods"]},"description":{"type":"string","examples":["Shared mod files for servers."]},"source":{"type":"string","examples":["/mnt/shared-mods"]},"target":{"type":"string","examples":["/home/container/mods"]},"read_only":{"type":"boolean","examples":[true]},"user_mountable":{"type":"boolean","examples":[false]},"eggs_count":{"type":"integer","examples":[1]},"nodes_count":{"type":"integer","examples":[1]},"servers_count":{"type":"integer","examples":[0]},"mounted":{"type":["boolean","null"],"description":"Present only when listed in the context of a server.","examples":[true]},"relationships":{"type":"object","properties":{"eggs":{"oneOf":[{"$ref":"#/components/schemas/AdminEggListResponse"},{"$ref":"#/components/schemas/NullResource"}]},"nodes":{"oneOf":[{"$ref":"#/components/schemas/AdminNodeListResponse"},{"$ref":"#/components/schemas/NullResource"}]},"servers":{"oneOf":[{"$ref":"#/components/schemas/AdminServerListResponse"},{"$ref":"#/components/schemas/NullResource"}]}}}}},"AdminMountListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminMountResource"}}}},"AdminMountPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminMountResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminMountResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["mount"]},"attributes":{"$ref":"#/components/schemas/AdminMountAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.com/api/admin/mounts/1"]}}}}},"AdminNodeAttributes":{"type":"object","required":["id","uuid","public","name","description","location_id","fqdn","scheme","behind_proxy","maintenance_mode","memory","memory_overallocate","disk","disk_overallocate","upload_size","daemon_listen","daemon_sftp","daemon_base","created_at","updated_at","allocated_resources"],"properties":{"id":{"type":"integer","examples":[13380]},"uuid":{"type":"string","examples":["0c8baf15-4a20-49b5-b738-109796b553e1"]},"public":{"type":"boolean","examples":[true]},"name":{"type":"string","examples":["FactoryNode_K98YXFAsPq"]},"description":{"type":["string","null"]},"location_id":{"type":"integer","examples":[16046]},"fqdn":{"type":"string","examples":["74.174.140.253"]},"scheme":{"type":"string","examples":["http"]},"behind_proxy":{"type":"boolean","examples":[false]},"maintenance_mode":{"type":"boolean","examples":[false]},"memory":{"type":"integer","examples":[1024]},"memory_overallocate":{"type":"integer","examples":[0]},"disk":{"type":"integer","examples":[10240]},"disk_overallocate":{"type":"integer","examples":[0]},"upload_size":{"type":"integer","examples":[100]},"daemon_listen":{"type":"integer","examples":[8080]},"daemon_sftp":{"type":"integer","examples":[2022]},"daemon_base":{"type":"string","examples":["/var/lib/pterodactyl/volumes"]},"created_at":{"type":"string","examples":["2026-09-22T14:45:25+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:25+00:00"]},"servers_count":{"type":"integer","description":"Present when the endpoint loads server counts.","examples":[0]},"allocated_resources":{"type":"object","required":["memory","disk"],"properties":{"memory":{"type":"integer","examples":[0]},"disk":{"type":"integer","examples":[0]}}},"relationships":{"type":"object","properties":{"location":{"oneOf":[{"$ref":"#/components/schemas/AdminLocationResource"},{"$ref":"#/components/schemas/NullResource"}]}}}}},"AdminNodeConfigurationResponse":{"type":"object","required":["debug","uuid","token_id","token","api","system","allowed_mounts","remote"],"properties":{"debug":{"type":"boolean","examples":[false]},"uuid":{"type":"string","examples":["1b19cf3f-2f89-4f88-a81e-321e7fe326bc"]},"token_id":{"type":"string","examples":["abcd1234"]},"token":{"type":"string","examples":["secret"]},"api":{"type":"object","required":["host","port","ssl","upload_limit"],"properties":{"host":{"type":"string","examples":["0.0.0.0"]},"port":{"type":"integer","examples":[8080]},"ssl":{"type":"object","required":["enabled","cert","key"],"properties":{"enabled":{"type":"boolean","examples":[true]},"cert":{"type":"string","examples":["/etc/letsencrypt/live/node.example.com/fullchain.pem"]},"key":{"type":"string","examples":["/etc/letsencrypt/live/node.example.com/privkey.pem"]}}},"upload_limit":{"type":"integer","examples":[100]}}},"system":{"type":"object","required":["data","sftp"],"properties":{"data":{"type":"string","examples":["/var/lib/pterodactyl/volumes"]},"sftp":{"type":"object","required":["bind_port"],"properties":{"bind_port":{"type":"integer","examples":[2022]}}}}},"allowed_mounts":{"type":"array","items":{"type":"string","examples":["/mnt/shared"]}},"remote":{"type":"string","examples":["https://panel.example.com"]}}},"AdminNodeDeployTokenResponse":{"type":"object","required":["node","token","panel_url","allow_insecure"],"properties":{"node":{"type":"integer","examples":[1]},"token":{"type":"string","examples":["ptla_1234567890abcdef"]},"panel_url":{"type":"string","examples":["https://panel.example.com"]},"allow_insecure":{"type":"boolean","examples":[false]}}},"AdminNodeListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminNodeResource"}}}},"AdminNodePaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminNodeResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminNodeResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["node"]},"attributes":{"$ref":"#/components/schemas/AdminNodeAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.com/api/admin/nodes/1"]}}}}},"AdminNodeSystemInformationResponse":{"type":"object","required":["architecture","cpu_count","kernel_version","os","version"],"properties":{"architecture":{"type":"string","examples":["amd64"]},"cpu_count":{"type":"integer","examples":[8]},"kernel_version":{"type":"string","examples":["6.8.0"]},"os":{"type":"string","examples":["linux"]},"version":{"type":"string","examples":["1.11.0"]}}},"AdminNodeUtilizationResponse":{"type":"object","required":["disk","memory"],"properties":{"disk":{"type":"object","required":["value","max","percent","css"],"properties":{"value":{"type":"string","examples":["1,024"]},"max":{"type":"string","examples":["102,400"]},"percent":{"type":"number","examples":[1]},"css":{"type":"string","examples":["green"]}}},"memory":{"type":"object","required":["value","max","percent","css"],"properties":{"value":{"type":"string","examples":["1,024"]},"max":{"type":"string","examples":["102,400"]},"percent":{"type":"number","examples":[1]},"css":{"type":"string","examples":["green"]}}}}},"AdminServerAttributes":{"type":"object","required":["id","external_id","uuid","identifier","name","description","status","suspended","limits","feature_limits","user","node","allocation","egg","container","updated_at","created_at"],"properties":{"id":{"type":"integer","examples":[8140]},"external_id":{"type":["string","null"]},"uuid":{"type":"string","examples":["e5628a06-7ba6-4206-8a87-c2aeb91669ec"]},"identifier":{"type":"string","examples":["kqhvptzk"]},"name":{"type":"string","examples":["Leo"]},"description":{"type":["string","null"],"examples":["Et modi ipsum nostrum omnis autem et consequatur. Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci."]},"status":{"type":["string","null"]},"suspended":{"type":"boolean","examples":[false]},"limits":{"type":"object","required":["memory","swap","disk","io","cpu","threads","oom_disabled"],"properties":{"memory":{"type":"integer","examples":[512]},"swap":{"type":"integer","examples":[0]},"disk":{"type":"integer","examples":[512]},"io":{"type":"integer","examples":[500]},"cpu":{"type":"integer","examples":[0]},"threads":{"type":["string","null"]},"oom_disabled":{"type":"boolean","examples":[false]}}},"feature_limits":{"type":"object","required":["databases","allocations","backups"],"properties":{"databases":{"type":["integer","null"],"examples":[0]},"allocations":{"type":["integer","null"],"examples":[0]},"backups":{"type":"integer","examples":[0]}}},"user":{"type":"integer","examples":[22139]},"node":{"type":"integer","examples":[13361]},"allocation":{"type":"integer","examples":[9849]},"egg":{"type":"integer","examples":[9866]},"container":{"type":"object","required":["startup_command","image","skip_scripts","installed","environment"],"properties":{"startup_command":{"type":"string","examples":["/bin/bash echo \"hello world\""]},"image":{"type":"string","examples":["foo/bar:latest"]},"skip_scripts":{"type":"boolean","examples":[false]},"installed":{"type":"integer","examples":[1]},"environment":{"type":"object","additionalProperties":{"nullable":true,"oneOf":[{"type":"string"},{"type":"number"}]},"examples":[{"SERVER_JARFILE":"server.jar"}]}}},"updated_at":{"type":"string","examples":["2026-09-22T14:45:24+00:00"]},"created_at":{"type":"string","examples":["2026-09-22T14:45:24+00:00"]},"relationships":{"type":"object","properties":{"allocation":{"oneOf":[{"$ref":"#/components/schemas/AdminAllocationResource"},{"$ref":"#/components/schemas/NullResource"}]},"allocations":{"oneOf":[{"$ref":"#/components/schemas/AdminAllocationListResponse"},{"$ref":"#/components/schemas/NullResource"}]},"user":{"oneOf":[{"$ref":"#/components/schemas/AdminUserResource"},{"$ref":"#/components/schemas/NullResource"}]},"egg":{"oneOf":[{"$ref":"#/components/schemas/AdminEggResource"},{"$ref":"#/components/schemas/NullResource"}]},"variables":{"oneOf":[{"$ref":"#/components/schemas/AdminServerVariableListResponse"},{"$ref":"#/components/schemas/NullResource"}]},"node":{"oneOf":[{"$ref":"#/components/schemas/AdminNodeResource"},{"$ref":"#/components/schemas/NullResource"}]}}}}},"AdminServerDatabaseAttributes":{"type":"object","required":["id","host","name","username","connections_from","max_connections"],"properties":{"id":{"type":"string","examples":["kB0dVl28"]},"host":{"type":"object","required":["address","port"],"properties":{"address":{"type":"string","examples":["15.159.33.109"]},"port":{"type":"integer","examples":[3306]}}},"name":{"type":"string","examples":["jcPmkfpoBm"]},"username":{"type":"string","examples":["AQ4MUxEC4L"]},"connections_from":{"type":"string","examples":["%"]},"max_connections":{"type":["integer","null"],"examples":[0]},"relationships":{"type":"object","properties":{"password":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["database_password"]},"attributes":{"type":"object","required":["password"],"properties":{"password":{"type":"string","examples":["test123"]}}}}}}}}},"AdminServerDatabaseListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminServerDatabaseResource"}}}},"AdminServerDatabaseResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["server_database"]},"attributes":{"$ref":"#/components/schemas/AdminServerDatabaseAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.com/api/admin/servers/1/databases/Lk3jx4pQ"]}}}}},"AdminServerListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminServerResource"}}}},"AdminServerPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminServerResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminServerResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["server"]},"attributes":{"$ref":"#/components/schemas/AdminServerAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.com/api/admin/servers/1"]}}}}},"AdminServerTransferAttributes":{"type":"object","required":["id","server_id","old_node","new_node","old_allocation","new_allocation","successful","archived","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[76]},"server_id":{"type":"integer","examples":[8147]},"old_node":{"type":"integer","examples":[13368]},"new_node":{"type":"integer","examples":[13369]},"old_allocation":{"type":"integer","examples":[9856]},"new_allocation":{"type":"integer","examples":[9857]},"successful":{"type":["boolean","null"]},"archived":{"type":"boolean","examples":[false]},"created_at":{"type":"string","examples":["2026-09-22T14:45:25+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:25+00:00"]}}},"AdminServerTransferResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["server_transfer"]},"attributes":{"$ref":"#/components/schemas/AdminServerTransferAttributes"}}},"AdminServerVariableAttributes":{"type":"object","required":["id","egg_id","name","description","env_variable","default_value","server_value","user_viewable","user_editable","rules","sort_order","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[1]},"egg_id":{"type":"integer","examples":[1]},"name":{"type":"string","examples":["Server Jar File"]},"description":{"type":"string","examples":["The jar file to run."]},"env_variable":{"type":"string","examples":["SERVER_JARFILE"]},"default_value":{"type":"string","examples":["server.jar"]},"server_value":{"type":["string","null"],"examples":["server.jar"]},"user_viewable":{"type":"boolean","examples":[true]},"user_editable":{"type":"boolean","examples":[true]},"rules":{"type":"string","examples":["required|string"]},"required":{"type":"boolean","examples":[true]},"sort_order":{"type":["integer","null"],"examples":[1]},"created_at":{"type":"string","examples":["2026-01-01T00:00:00+00:00"]},"updated_at":{"type":"string","examples":["2026-01-01T00:00:00+00:00"]}}},"AdminServerVariableListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminServerVariableResource"}}}},"AdminServerVariableResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["server_variable"]},"attributes":{"$ref":"#/components/schemas/AdminServerVariableAttributes"}}},"AdminSettingsResponse":{"type":"object","required":["general","mail","advanced","meta"],"properties":{"general":{"type":"object","required":["app:name","pterodactyl:auth:2fa_required","app:locale"],"properties":{"app:name":{"type":"string","examples":["Pterodactyl"]},"pterodactyl:auth:2fa_required":{"type":"integer","enum":[0,1,2],"examples":[0]},"app:locale":{"type":"string","examples":["en"]}}},"mail":{"type":"object","required":["mail:default","mail:mailers:smtp:host","mail:mailers:smtp:port","mail:mailers:smtp:encryption","mail:mailers:smtp:username","mail:mailers:smtp:password","mail:from:address","mail:from:name"],"properties":{"mail:default":{"type":"string","examples":["smtp"]},"mail:mailers:smtp:host":{"type":"string","examples":["mail.example.com"]},"mail:mailers:smtp:port":{"type":"integer","examples":[587]},"mail:mailers:smtp:encryption":{"type":["string","null"],"enum":["tls","ssl",null],"examples":["tls"]},"mail:mailers:smtp:username":{"type":["string","null"],"examples":["panel@example.com"]},"mail:mailers:smtp:password":{"type":"string","examples":[""]},"mail:from:address":{"type":"string","examples":["panel@example.com"]},"mail:from:name":{"type":["string","null"],"examples":["Pterodactyl"]}}},"advanced":{"type":"object","required":["recaptcha:enabled","recaptcha:secret_key","recaptcha:website_key","pterodactyl:guzzle:timeout","pterodactyl:guzzle:connect_timeout","pterodactyl:client_features:allocations:enabled","pterodactyl:client_features:allocations:range_start","pterodactyl:client_features:allocations:range_end"],"properties":{"recaptcha:enabled":{"type":"boolean","examples":[false]},"recaptcha:secret_key":{"type":"string","examples":["secret"]},"recaptcha:website_key":{"type":"string","examples":["website"]},"pterodactyl:guzzle:timeout":{"type":"integer","examples":[15]},"pterodactyl:guzzle:connect_timeout":{"type":"integer","examples":[5]},"pterodactyl:client_features:allocations:enabled":{"type":"boolean","examples":[false]},"pterodactyl:client_features:allocations:range_start":{"type":["integer","null"],"examples":[null]},"pterodactyl:client_features:allocations:range_end":{"type":["integer","null"],"examples":[null]}}},"meta":{"type":"object","required":["load_environment_only","show_recaptcha_warning"],"properties":{"load_environment_only":{"type":"boolean","examples":[false]},"show_recaptcha_warning":{"type":"boolean","examples":[false]}}}}},"AdminTagAttributes":{"type":"object","required":["id","name","slug","color","is_predefined","legacy_nest_id","eggs_count","nodes_count","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[510]},"name":{"type":"string","examples":["fugiat sunt"]},"slug":{"type":"string","examples":["fugiat-sunt"]},"color":{"type":["string","null"],"examples":["#54db8e"]},"is_predefined":{"type":"boolean","examples":[false]},"legacy_nest_id":{"type":["integer","null"],"examples":[1]},"eggs_count":{"type":"integer","examples":[0]},"nodes_count":{"type":"integer","examples":[0]},"created_at":{"type":"string","examples":["2026-09-22T14:45:25+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:25+00:00"]}}},"AdminTagListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminTagResource"}}}},"AdminTagPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminTagResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminTagResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["tag"]},"attributes":{"$ref":"#/components/schemas/AdminTagAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.com/api/admin/tags/1"]}}}}},"AdminUserAttributes":{"type":"object","required":["id","external_id","uuid","username","email","first_name","last_name","language","root_admin","2fa","image","servers_count","subuser_of_count","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[22129]},"external_id":{"type":["string","null"]},"uuid":{"type":"string","examples":["39ff92cf-453d-43be-ac47-89569dfba75e"]},"username":{"type":"string","examples":["alayna44_cuxzkyiji9"]},"email":{"type":"string","examples":["fH5CgIzyfZdjWwRpGKqjaSOifVbb0BlH@example.com"]},"first_name":{"type":"string","examples":["Kenyatta"]},"last_name":{"type":"string","examples":["O'Keefe"]},"language":{"type":"string","examples":["en"]},"root_admin":{"type":"boolean","examples":[false]},"2fa":{"type":"boolean","examples":[false]},"image":{"type":"string","examples":["https://gravatar.com/avatar/7dd464c5201a58aafc8fa80660971d52"]},"servers_count":{"type":"integer","examples":[0]},"subuser_of_count":{"type":"integer","examples":[0]},"created_at":{"type":"string","examples":["2026-09-22T14:45:24+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:24+00:00"]},"relationships":{"type":"object","properties":{"servers":{"oneOf":[{"$ref":"#/components/schemas/AdminServerListResponse"},{"$ref":"#/components/schemas/NullResource"}]}}}}},"AdminUserPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/AdminUserResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"AdminUserResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["user"]},"attributes":{"$ref":"#/components/schemas/AdminUserAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.com/api/admin/users/1"]}}}}},"AdminVersionInformationResponse":{"type":"object","required":["current","latest","is_latest","daemon","discord","donations"],"properties":{"current":{"type":"string","examples":["1.0.0"]},"latest":{"type":"string","examples":["1.0.0"]},"is_latest":{"type":"boolean","examples":[true]},"daemon":{"type":"string","examples":["1.0.0"]},"discord":{"type":"string","examples":["https://pterodactyl.io/discord"]},"donations":{"type":"string","examples":["https://github.com/sponsors/pterodactyl"]}}},"ApplicationAllocationAttributes":{"type":"object","required":["id","ip","alias","port","notes","assigned"],"properties":{"id":{"type":"integer","examples":[9811]},"ip":{"type":"string","examples":["11.234.99.225"]},"alias":{"type":["string","null"]},"port":{"type":"integer","examples":[1098]},"notes":{"type":["string","null"]},"assigned":{"type":"boolean","examples":[false]}}},"ApplicationAllocationPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationAllocationResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"ApplicationAllocationResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["allocation"]},"attributes":{"$ref":"#/components/schemas/ApplicationAllocationAttributes"}}},"ApplicationEggAttributes":{"type":"object","required":["id","uuid","name","author","description","docker_image","docker_images","config","startup","script","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[9829]},"uuid":{"type":"string","examples":["d4ee260c-fe89-48ac-b3e1-370bb4c028c6"]},"name":{"type":"string","examples":["Alanis McLaughlin"]},"author":{"type":"string","examples":["support@pterodactyl.io"]},"description":{"type":["string","null"],"examples":["Modi ipsum nostrum omnis autem et. Aut dolores enim non facere tempora ex voluptatem. Praesentium quis adipisci molestias fugit."]},"docker_image":{"type":"string","examples":["ghcr.io/pterodactyl/yolks:java_23"]},"docker_images":{"type":"object","additionalProperties":{"type":"string"},"examples":[{"Java 23":"ghcr.io/pterodactyl/yolks:java_23"}]},"config":{"type":"object","required":["files","startup","stop","logs","file_denylist","extends"],"properties":{"files":{"$ref":"#/components/schemas/AdminEggConfigurationFiles"},"startup":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"examples":[{"done":["Done"]}]},"stop":{"type":"string","examples":["stop"]},"logs":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"examples":[{"custom":true,"location":"logs/latest.log"}]},"file_denylist":{"type":["array","null"],"items":{"type":"string"},"examples":[["secret.txt"]]},"extends":{"type":["integer","null"]}}},"startup":{"type":"string","examples":["java -jar test.jar"]},"script":{"type":"object","required":["privileged","install","entry","container","extends"],"properties":{"privileged":{"type":"boolean","examples":[true]},"install":{"type":["string","null"]},"entry":{"type":"string","examples":["ash"]},"container":{"type":"string","examples":["alpine:3.4"]},"extends":{"type":["integer","null"]}}},"created_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]}}},"ApplicationEggPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationEggResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"ApplicationEggResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["egg"]},"attributes":{"$ref":"#/components/schemas/ApplicationEggAttributes"}}},"ApplicationLocationAttributes":{"type":"object","required":["id","short","long","updated_at","created_at"],"properties":{"id":{"type":"integer","examples":[15984]},"short":{"type":"string","examples":["eHbH77iS"]},"long":{"type":"string","examples":["t4KJRY3dIAr1bcIU6bC3lfXrtlpmzZje"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]},"created_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]}}},"ApplicationLocationPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationLocationResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"ApplicationLocationResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["location"]},"attributes":{"$ref":"#/components/schemas/ApplicationLocationAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.test/api/application/locations/1"]}}}}},"ApplicationNodeAttributes":{"type":"object","required":["id","uuid","public","name","description","location_id","fqdn","scheme","behind_proxy","maintenance_mode","memory","memory_overallocate","disk","disk_overallocate","upload_size","daemon_listen","daemon_sftp","daemon_base","created_at","updated_at","allocated_resources"],"properties":{"id":{"type":"integer","examples":[13316]},"uuid":{"type":"string","examples":["187b8d09-e808-4cfb-83d2-99913dff8daa"]},"public":{"type":"boolean","examples":[true]},"name":{"type":"string","examples":["FactoryNode_z0EUCKodf8"]},"description":{"type":["string","null"]},"location_id":{"type":"integer","examples":[15978]},"fqdn":{"type":"string","examples":["17.170.141.175"]},"scheme":{"type":"string","examples":["http"]},"behind_proxy":{"type":"boolean","examples":[false]},"maintenance_mode":{"type":"boolean","examples":[false]},"memory":{"type":"integer","examples":[1024]},"memory_overallocate":{"type":"integer","examples":[0]},"disk":{"type":"integer","examples":[10240]},"disk_overallocate":{"type":"integer","examples":[0]},"upload_size":{"type":"integer","examples":[100]},"daemon_listen":{"type":"integer","examples":[8080]},"daemon_sftp":{"type":"integer","examples":[2022]},"daemon_base":{"type":"string","examples":["/var/lib/pterodactyl/volumes"]},"created_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]},"allocated_resources":{"type":"object","required":["memory","disk"],"properties":{"memory":{"type":"integer","examples":[0]},"disk":{"type":"integer","examples":[0]}}}}},"ApplicationNodeListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationNodeResource"}}}},"ApplicationNodePaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationNodeResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"ApplicationNodeResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["node"]},"attributes":{"$ref":"#/components/schemas/ApplicationNodeAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.test/api/application/nodes/1"]}}}}},"ApplicationServerAttributes":{"type":"object","required":["id","external_id","uuid","identifier","name","description","status","suspended","limits","feature_limits","user","node","allocation","egg","container","updated_at","created_at"],"properties":{"id":{"type":"integer","examples":[8107]},"external_id":{"type":["string","null"]},"uuid":{"type":"string","examples":["c248d6eb-38d1-4067-acd6-7acc8c6cfd60"]},"identifier":{"type":"string","examples":["q2xiw8r8"]},"name":{"type":"string","examples":["Asia"]},"description":{"type":["string","null"],"examples":["Accusantium harum mollitia modi deserunt aut ab. Perspiciatis quo omnis nostrum aut adipisci quidem nostrum qui. Incidunt iure odit et et modi ipsum."]},"status":{"type":["string","null"]},"suspended":{"type":"boolean","examples":[false]},"limits":{"type":"object","required":["memory","swap","disk","io","cpu","threads","oom_disabled"],"properties":{"memory":{"type":"integer","examples":[512]},"swap":{"type":"integer","examples":[0]},"disk":{"type":"integer","examples":[512]},"io":{"type":"integer","examples":[500]},"cpu":{"type":"integer","examples":[0]},"threads":{"type":["string","null"]},"oom_disabled":{"type":"boolean","examples":[false]}}},"feature_limits":{"type":"object","required":["databases","allocations","backups"],"properties":{"databases":{"type":["integer","null"],"examples":[0]},"allocations":{"type":["integer","null"],"examples":[0]},"backups":{"type":["integer","null"],"examples":[0]}}},"user":{"type":"integer","examples":[22043]},"node":{"type":"integer","examples":[13322]},"allocation":{"type":"integer","examples":[9812]},"egg":{"type":"integer","examples":[9831]},"container":{"type":"object","required":["startup_command","image","installed","environment"],"properties":{"startup_command":{"type":"string","examples":["/bin/bash echo \"hello world\""]},"image":{"type":"string","examples":["foo/bar:latest"]},"installed":{"type":"integer","examples":[1]},"environment":{"type":"object","additionalProperties":{"nullable":true,"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"examples":[{"SERVER_JARFILE":"server.jar"}]}}},"updated_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]},"created_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]}}},"ApplicationServerDatabaseAttributes":{"type":"object","required":["id","server","host","database","username","remote","max_connections","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[1253]},"server":{"type":"integer","examples":[8114]},"host":{"type":"integer","examples":[1544]},"database":{"type":"string","examples":["1E8CdMJTdo"]},"username":{"type":"string","examples":["eEAKifNuaL"]},"remote":{"type":"string","examples":["%"]},"max_connections":{"type":["integer","null"],"examples":[0]},"created_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]}}},"ApplicationServerDatabaseListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationServerDatabaseResource"}}}},"ApplicationServerDatabaseResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["server_database"]},"attributes":{"$ref":"#/components/schemas/ApplicationServerDatabaseAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.test/api/application/servers/1/databases/1"]}}}}},"ApplicationServerPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationServerResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"ApplicationServerResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["server"]},"attributes":{"$ref":"#/components/schemas/ApplicationServerAttributes"}}},"ApplicationTagAttributes":{"type":"object","required":["id","name","slug","color","is_predefined","legacy_nest_id","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[517]},"name":{"type":"string","examples":["iure odit"]},"slug":{"type":"string","examples":["iure-odit"]},"color":{"type":["string","null"],"examples":["#559641"]},"is_predefined":{"type":"boolean","examples":[false]},"legacy_nest_id":{"type":["integer","null"],"examples":[1]},"created_at":{"type":"string","examples":["2026-10-01T18:29:25+00:00"]},"updated_at":{"type":"string","examples":["2026-10-01T18:29:25+00:00"]}}},"ApplicationTagPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationTagResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"ApplicationTagResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["tag"]},"attributes":{"$ref":"#/components/schemas/ApplicationTagAttributes"}}},"ApplicationUserAttributes":{"type":"object","required":["id","external_id","uuid","username","email","first_name","last_name","language","root_admin","2fa","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[22021]},"external_id":{"type":["string","null"]},"uuid":{"type":"string","examples":["e0dcf339-0bc7-4561-ab00-369ac65ab880"]},"username":{"type":"string","examples":["floy88_afzdiebpaq"]},"email":{"type":"string","examples":["aj8DWx3bCoaWNHAMfxJg8EB87TrwWAbM@example.com"]},"first_name":{"type":"string","examples":["Cruz"]},"last_name":{"type":"string","examples":["Adams"]},"language":{"type":"string","examples":["en"]},"root_admin":{"type":"boolean","examples":[false]},"2fa":{"type":"boolean","examples":[false]},"created_at":{"type":"string","examples":["2026-09-22T14:45:22+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:22+00:00"]}}},"ApplicationUserPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUserResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"ApplicationUserResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["user"]},"attributes":{"$ref":"#/components/schemas/ApplicationUserAttributes"},"meta":{"type":"object","required":["resource"],"properties":{"resource":{"type":"string","examples":["https://panel.example.test/api/application/users/1"]}}}}},"AuthLoginCheckpointResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["complete","confirmation_token"],"properties":{"complete":{"type":"boolean","enum":[false],"examples":[false]},"confirmation_token":{"type":"string","examples":["b6e22f85d63c4d9db9739f9ab0a27a48f51f7ad38ef8c12fd157c4c6f4b2e51d"]}}}}},"AuthLoginCompleteResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["complete","intended","user"],"properties":{"complete":{"type":"boolean","enum":[true],"examples":[true]},"intended":{"type":"string","examples":["/"]},"user":{"$ref":"#/components/schemas/AuthUser"}}}}},"AuthLoginResponse":{"oneOf":[{"$ref":"#/components/schemas/AuthLoginCompleteResponse"},{"$ref":"#/components/schemas/AuthLoginCheckpointResponse"}]},"AuthPasswordResetEmailResponse":{"type":"object","required":["status"],"properties":{"status":{"type":"string","examples":["We have emailed your password reset link."]}}},"AuthResetPasswordResponse":{"type":"object","required":["success","redirect_to","send_to_login"],"properties":{"success":{"type":"boolean","enum":[true],"examples":[true]},"redirect_to":{"type":["string","null"],"examples":["/"]},"send_to_login":{"type":"boolean","examples":[false]}}},"AuthUser":{"type":"object","required":["uuid","username","email","name_first","name_last","language","root_admin","use_totp","gravatar","created_at","updated_at","identifier"],"properties":{"uuid":{"type":"string","format":"uuid","examples":["9a8b7c6d-5e4f-4321-9876-123456789abc"]},"username":{"type":"string","examples":["admin"]},"email":{"type":"string","format":"email","examples":["admin@example.com"]},"name_first":{"type":["string","null"],"examples":["Admin"]},"name_last":{"type":["string","null"],"examples":["User"]},"language":{"type":"string","examples":["en"]},"root_admin":{"type":"boolean","examples":[true]},"use_totp":{"type":"boolean","examples":[false]},"gravatar":{"type":"boolean","examples":[true]},"created_at":{"type":"string","format":"date-time","examples":["2026-06-29T12:00:00+00:00"]},"updated_at":{"type":"string","format":"date-time","examples":["2026-06-29T12:00:00+00:00"]},"identifier":{"type":"string","pattern":"^usr_[a-zA-Z0-9]+$","examples":["usr_1a2b3c4d"]}}},"ClientActivityLogAttributes":{"type":"object","required":["id","batch","event","is_api","ip","description","properties","has_additional_metadata","timestamp"],"properties":{"id":{"type":"string","examples":["3032a4beba0cc85ba637566923b54c9addc94b63"]},"batch":{"type":["string","null"]},"event":{"type":"string","examples":["user:account.email-changed"]},"is_api":{"type":"boolean","examples":[false]},"ip":{"type":["string","null"],"examples":["192.0.2.10"]},"description":{"type":["string","null"],"examples":["Changed account email address."]},"properties":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"object","additionalProperties":{"type":"string"}}]},"example":{"old":"old-user@example.com","new":"new-user@example.com"}},"has_additional_metadata":{"type":"boolean","examples":[false]},"timestamp":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]},"relationships":{"type":"object","properties":{"actor":{"oneOf":[{"$ref":"#/components/schemas/ClientUserResource"},{"$ref":"#/components/schemas/NullResource"}]}}}}},"ClientActivityLogPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientActivityLogResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"ClientActivityLogResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["activity_log"]},"attributes":{"$ref":"#/components/schemas/ClientActivityLogAttributes"}}},"ClientAllocationAttributes":{"type":"object","required":["id","ip","ip_alias","port","notes","is_default"],"properties":{"id":{"type":"integer","examples":[9834]},"ip":{"type":"string","examples":["54.95.112.197"]},"ip_alias":{"type":["string","null"]},"port":{"type":"integer","examples":[8189]},"notes":{"type":["string","null"],"examples":["Primary game port"]},"is_default":{"type":"boolean","examples":[false]}}},"ClientAllocationListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientAllocationResource"}}}},"ClientAllocationResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["allocation"]},"attributes":{"$ref":"#/components/schemas/ClientAllocationAttributes"}}},"ClientApiKeyAttributes":{"type":"object","required":["identifier","description","allowed_ips","last_used_at","created_at"],"properties":{"identifier":{"type":"string","examples":["ptla_GWGCd8Mb1Mp"]},"description":{"type":"string","examples":["Test Function Key"]},"allowed_ips":{"type":["array","null"],"items":{"type":"string"},"examples":[["127.0.0.1"]]},"last_used_at":{"type":["string","null"]},"created_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]}}},"ClientApiKeyListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientApiKeyResource"}}}},"ClientApiKeyResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["api_key"]},"attributes":{"$ref":"#/components/schemas/ClientApiKeyAttributes"},"meta":{"type":"object","required":["secret_token"],"properties":{"secret_token":{"type":"string","examples":["ptlc_1234567890abcdef1234567890abcdef1234567890abcdef"]}}}}},"ClientBackupAttributes":{"type":"object","required":["uuid","is_successful","is_locked","name","ignored_files","checksum","bytes","created_at","completed_at"],"properties":{"uuid":{"type":"string","examples":["b1ad97bf-3ae6-43f0-bd9f-623cf9482785"]},"is_successful":{"type":"boolean","examples":[true]},"is_locked":{"type":"boolean","examples":[false]},"name":{"type":"string","examples":["Sunt nihil accusantium harum mollitia."]},"ignored_files":{"type":"array","items":{"type":"string"}},"checksum":{"type":["string","null"],"examples":["sha256:0123456789abcdef"]},"bytes":{"type":"integer","examples":[0]},"created_at":{"type":"string","examples":["2026-09-22T14:45:24+00:00"]},"completed_at":{"type":["string","null"],"examples":["2026-06-29T12:05:00+00:00"]}}},"ClientBackupPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientBackupResource"}},"meta":{"type":"object","required":["pagination","backup_count"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"},"backup_count":{"type":"integer","examples":[1]}}}}},"ClientBackupResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["backup"]},"attributes":{"$ref":"#/components/schemas/ClientBackupAttributes"}}},"ClientEggVariableAttributes":{"type":"object","required":["name","description","env_variable","default_value","server_value","is_editable","rules"],"properties":{"name":{"type":"string","examples":["Leo"]},"description":{"type":"string","examples":["Et modi ipsum nostrum omnis autem et consequatur."]},"env_variable":{"type":"string","examples":["AUT_DOLORES"]},"default_value":{"type":"string","examples":["OldLace"]},"server_value":{"type":["string","null"]},"is_editable":{"type":"boolean","examples":[true]},"rules":{"type":"string","examples":["required|string"]}}},"ClientEggVariableListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientEggVariableResource"}},"meta":{"type":"object","required":["startup_command","docker_images","raw_startup_command"],"properties":{"startup_command":{"type":"string","examples":["java -Xms128M -Xmx1024M -jar paper.jar"]},"docker_images":{"type":"object","additionalProperties":{"type":"string"},"examples":[{"Java 23":"ghcr.io/pterodactyl/yolks:java_23"}]},"raw_startup_command":{"type":"string","examples":["java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}"]}}}}},"ClientEggVariableResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["egg_variable"]},"attributes":{"$ref":"#/components/schemas/ClientEggVariableAttributes"},"meta":{"type":"object","required":["startup_command","raw_startup_command"],"properties":{"startup_command":{"type":"string","examples":["java -Xms128M -Xmx1024M -jar paper.jar"]},"raw_startup_command":{"type":"string","examples":["java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}"]}}}}},"ClientFileObjectAttributes":{"type":"object","required":["name","mode","mode_bits","size","is_file","is_symlink","mimetype","created_at","modified_at"],"properties":{"name":{"type":"string","examples":["server.properties"]},"mode":{"type":["string","null"],"examples":["-rw-r--r--"]},"mode_bits":{"type":["string","null"],"examples":["0644"]},"size":{"type":["integer","null"],"examples":[1024]},"is_file":{"type":"boolean","examples":[true]},"is_symlink":{"type":"boolean","examples":[false]},"mimetype":{"type":"string","examples":["text/plain"]},"created_at":{"type":"string","examples":["2026-06-29T12:00:00+00:00"]},"modified_at":{"type":"string","examples":["2026-06-29T12:00:00+00:00"]}}},"ClientFileObjectListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientFileObjectResource"}}}},"ClientFileObjectResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["file_object"]},"attributes":{"$ref":"#/components/schemas/ClientFileObjectAttributes"}}},"ClientRecoveryTokensAttributes":{"type":"object","required":["tokens"],"properties":{"tokens":{"type":"array","items":{"type":"string","examples":["r1a2b3c4d5"]}}}},"ClientRecoveryTokensResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["recovery_tokens"]},"attributes":{"$ref":"#/components/schemas/ClientRecoveryTokensAttributes"}}},"ClientScheduleTaskAttributes":{"type":"object","required":["id","sequence_id","action","payload","time_offset","is_queued","continue_on_failure","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[151]},"sequence_id":{"type":"integer","examples":[4]},"action":{"type":"string","enum":["power","command","backup"],"examples":["power"]},"payload":{"type":"string","examples":["test command"]},"time_offset":{"type":"integer","examples":[120]},"is_queued":{"type":"boolean","examples":[false]},"continue_on_failure":{"type":"boolean","examples":[false]},"created_at":{"type":"string","examples":["2026-09-22T14:45:24+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:24+00:00"]}}},"ClientScheduleTaskListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientScheduleTaskResource"}}}},"ClientScheduleTaskResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["schedule_task"]},"attributes":{"$ref":"#/components/schemas/ClientScheduleTaskAttributes"}}},"ClientServerAttributes":{"type":"object","required":["server_owner","identifier","__deprecated_uuid_short","server_identifier","internal_id","uuid","name","node","is_node_under_maintenance","sftp_details","description","limits","invocation","docker_image","egg_features","feature_limits","status","is_suspended","is_installing","is_transferring"],"properties":{"server_owner":{"type":"boolean","examples":[false]},"identifier":{"type":"string","examples":["dmjkuwbo"]},"__deprecated_uuid_short":{"type":"string","examples":["dmjkuwbo"]},"server_identifier":{"type":"string","pattern":"^serv_[a-zA-Z0-9]+$","examples":["serv_1a2b3c4d"]},"internal_id":{"type":"integer","examples":[8117]},"uuid":{"type":"string","examples":["b4775bce-7333-4ebc-aa89-115fb04a9d51"]},"name":{"type":"string","examples":["Leo"]},"node":{"type":"string","examples":["FactoryNode_bbRqrPBYOG"]},"is_node_under_maintenance":{"type":"boolean","examples":[false]},"sftp_details":{"type":"object","required":["ip","port"],"properties":{"ip":{"type":"string","examples":["246.107.107.140"]},"port":{"type":"integer","examples":[2022]}}},"description":{"type":["string","null"],"examples":["Survival world"]},"limits":{"type":"object","required":["memory","swap","disk","io","cpu","threads","oom_disabled"],"properties":{"memory":{"type":"integer","examples":[512]},"swap":{"type":"integer","examples":[0]},"disk":{"type":"integer","examples":[512]},"io":{"type":"integer","examples":[500]},"cpu":{"type":"integer","examples":[0]},"threads":{"type":["string","null"],"examples":["1,2"]},"oom_disabled":{"type":"boolean","examples":[false]}}},"invocation":{"type":"string","examples":["/bin/bash echo \"hello world\""]},"docker_image":{"type":"string","examples":["foo/bar:latest"]},"egg_features":{"type":["array","null"],"items":{"type":"string"},"examples":[["eula"]]},"feature_limits":{"type":"object","required":["databases","allocations","backups"],"properties":{"databases":{"type":["integer","null"],"examples":[5]},"allocations":{"type":["integer","null"],"examples":[5]},"backups":{"type":["integer","null"],"examples":[5]}}},"status":{"type":["string","null"],"enum":["installing","install_failed","reinstall_failed","suspended","restoring_backup",null],"examples":[null]},"is_suspended":{"type":"boolean","examples":[false]},"is_installing":{"type":"boolean","examples":[false]},"is_transferring":{"type":"boolean","examples":[false]},"relationships":{"type":"object","properties":{"allocations":{"oneOf":[{"$ref":"#/components/schemas/ClientAllocationListResponse"},{"$ref":"#/components/schemas/NullResource"}]},"variables":{"oneOf":[{"$ref":"#/components/schemas/ClientEggVariableListResponse"},{"$ref":"#/components/schemas/NullResource"}]}}}}},"ClientServerDatabaseAttributes":{"type":"object","required":["id","host","name","username","connections_from","max_connections"],"properties":{"id":{"type":"string","examples":["y7YRVKYq"]},"host":{"type":"object","required":["address","port"],"properties":{"address":{"type":"string","examples":["116.159.58.249"]},"port":{"type":"integer","examples":[3306]}}},"name":{"type":"string","examples":["ORsU8T3D8G"]},"username":{"type":"string","examples":["XLygD0lH1D"]},"connections_from":{"type":"string","examples":["%"]},"max_connections":{"type":["integer","null"],"examples":[0]},"relationships":{"type":"object","properties":{"password":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["database_password"]},"attributes":{"type":"object","required":["password"],"properties":{"password":{"type":"string","examples":["test123"]}}}}}}}}},"ClientServerDatabaseListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientServerDatabaseResource"}}}},"ClientServerDatabaseResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["server_database"]},"attributes":{"$ref":"#/components/schemas/ClientServerDatabaseAttributes"}}},"ClientServerPaginatedResponse":{"type":"object","required":["object","data","meta"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientServerResource"}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/PaginationMeta"}}}}},"ClientServerResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["server"]},"attributes":{"$ref":"#/components/schemas/ClientServerAttributes"},"meta":{"type":"object","required":["is_server_owner","user_permissions"],"properties":{"is_server_owner":{"type":"boolean","examples":[true]},"user_permissions":{"type":"array","items":{"type":"string","examples":["websocket.connect"]}}}}}},"ClientServerScheduleAttributes":{"type":"object","required":["id","name","cron","is_active","is_processing","only_when_online","last_run_at","next_run_at","created_at","updated_at"],"properties":{"id":{"type":"integer","examples":[448]},"name":{"type":"string","examples":["Leo"]},"cron":{"type":"object","required":["day_of_week","day_of_month","month","hour","minute"],"properties":{"day_of_week":{"type":"string","examples":["*"]},"day_of_month":{"type":"string","examples":["*"]},"month":{"type":"string","examples":["*"]},"hour":{"type":"string","examples":["*"]},"minute":{"type":"string","examples":["*"]}}},"is_active":{"type":"boolean","examples":[true]},"is_processing":{"type":"boolean","examples":[false]},"only_when_online":{"type":"boolean","examples":[false]},"last_run_at":{"type":["string","null"]},"next_run_at":{"type":["string","null"],"examples":["2026-06-30T04:00:00+00:00"]},"created_at":{"type":"string","examples":["2026-09-22T14:45:24+00:00"]},"updated_at":{"type":"string","examples":["2026-09-22T14:45:24+00:00"]},"relationships":{"type":"object","properties":{"tasks":{"oneOf":[{"$ref":"#/components/schemas/ClientScheduleTaskListResponse"},{"$ref":"#/components/schemas/NullResource"}]}}}}},"ClientServerScheduleListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientServerScheduleResource"}}}},"ClientServerScheduleResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["server_schedule"]},"attributes":{"$ref":"#/components/schemas/ClientServerScheduleAttributes"}}},"ClientServerSubuserAttributes":{"type":"object","required":["uuid","identifier","username","email","image","2fa_enabled","created_at","permissions"],"properties":{"uuid":{"type":"string","examples":["eb246353-0e44-41d7-8024-9627af5f94e4"]},"identifier":{"type":"string","examples":["user_5msgguyoira5pabesyt26x4u4q"]},"username":{"type":"string","examples":["cynthia21_gqxb5rujzb"]},"email":{"type":"string","examples":["raWqFTdP8d2S32844Q0XdoB0EjMxfecO@example.com"]},"image":{"type":"string","examples":["https://gravatar.com/avatar/9fed602415b3f371132a674c63351ee4"]},"2fa_enabled":{"type":"boolean","examples":[false]},"created_at":{"type":"string","examples":["2026-09-22T14:45:24+00:00"]},"permissions":{"type":"array","items":{"type":"string","enum":["websocket.connect","control.console","control.start","control.stop","control.restart","user.create","user.read","user.update","user.delete","file.create","file.read","file.read-content","file.update","file.delete","file.archive","file.sftp","backup.create","backup.read","backup.delete","backup.download","backup.restore","allocation.read","allocation.create","allocation.update","allocation.delete","startup.read","startup.update","startup.docker-image","database.create","database.read","database.update","database.delete","database.view_password","schedule.create","schedule.read","schedule.update","schedule.delete","settings.rename","settings.reinstall","activity.read"]},"examples":[["websocket.connect","control.console"]]}}},"ClientServerSubuserListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientServerSubuserResource"}}}},"ClientServerSubuserResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["server_subuser"]},"attributes":{"$ref":"#/components/schemas/ClientServerSubuserAttributes"}}},"ClientSignedUrlAttributes":{"type":"object","required":["url"],"properties":{"url":{"type":"string","examples":["https://node.example.test/download/file?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.example.signature"]}}},"ClientSignedUrlResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["signed_url"]},"attributes":{"$ref":"#/components/schemas/ClientSignedUrlAttributes"}}},"ClientSshKeyAttributes":{"type":"object","required":["name","fingerprint","public_key","created_at"],"properties":{"name":{"type":"string","examples":["Alanis McLaughlin"]},"fingerprint":{"type":"string","examples":["T2b3VnvHWUmfhDOFLqzZg2VfLgqJhWxzrMUy8WZ+V8M"]},"public_key":{"type":"string","examples":["-----BEGIN PUBLIC KEY-----\r\nMCowBQYDK2VwAyEA5pcirT00fhr3cRV2u8diJnrtaP4YEQFD2i7hbSpJibY=\r\n-----END PUBLIC KEY-----"]},"created_at":{"type":"string","examples":["2026-09-22T14:45:23+00:00"]}}},"ClientSshKeyListResponse":{"type":"object","required":["object","data"],"properties":{"object":{"type":"string","examples":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientSshKeyResource"}}}},"ClientSshKeyResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["ssh_key"]},"attributes":{"$ref":"#/components/schemas/ClientSshKeyAttributes"}}},"ClientStatsAttributes":{"type":"object","required":["current_state","is_suspended","resources"],"properties":{"current_state":{"type":"string","enum":["offline","stopped","starting","running","stopping"],"examples":["running"]},"is_suspended":{"type":"boolean","examples":[false]},"resources":{"type":"object","required":["memory_bytes","cpu_absolute","disk_bytes","network_rx_bytes","network_tx_bytes","uptime"],"properties":{"memory_bytes":{"type":"integer","examples":[536870912]},"cpu_absolute":{"type":"number","examples":[12.5]},"disk_bytes":{"type":"integer","examples":[2147483648]},"network_rx_bytes":{"type":"integer","examples":[102400]},"network_tx_bytes":{"type":"integer","examples":[204800]},"uptime":{"type":"integer","examples":[3600000]}}}}},"ClientStatsResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["stats"]},"attributes":{"$ref":"#/components/schemas/ClientStatsAttributes"}}},"ClientSystemPermissionsResponse":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["system_permissions"]},"attributes":{"type":"object","required":["permissions"],"properties":{"permissions":{"type":"object","additionalProperties":{"type":"object","required":["description","keys"],"properties":{"description":{"type":"string"},"keys":{"type":"object","additionalProperties":{"type":"string"}}}}}}}}},"ClientTwoFactorSetupResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["image_url_data","secret"],"properties":{"image_url_data":{"type":"string","examples":["otpauth://totp/Pterodactyl:user@example.com?secret=EXAMPLESECRET&issuer=Pterodactyl"]},"secret":{"type":"string","examples":["EXAMPLESECRET"]}}}}},"ClientUserAttributes":{"type":"object","required":["id","admin","username","email","first_name","last_name","language"],"properties":{"id":{"type":"integer","examples":[22065]},"admin":{"type":"boolean","examples":[false]},"username":{"type":"string","examples":["vernon82_i4mrjhg3wq"]},"email":{"type":"string","examples":["wsZFzoMBqBMwc1lUkJvm45oUab6Ng21b@example.com"]},"first_name":{"type":"string","examples":["Skye"]},"last_name":{"type":"string","examples":["Rogahn"]},"language":{"type":"string","examples":["en"]}}},"ClientUserResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","examples":["user"]},"attributes":{"$ref":"#/components/schemas/ClientUserAttributes"}}},"ErrorEnvelope":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["code","status","detail"],"properties":{"code":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"}}}}}},"NullResource":{"type":"object","required":["object","attributes"],"properties":{"object":{"type":"string","enum":["null_resource"],"examples":["null_resource"]},"attributes":{"nullable":true,"enum":[null]}}},"PaginationMeta":{"type":"object","required":["total","count","per_page","current_page","total_pages"],"properties":{"total":{"type":"integer","examples":[1]},"count":{"type":"integer","examples":[1]},"per_page":{"type":"integer","examples":[50]},"current_page":{"type":"integer","examples":[1]},"total_pages":{"type":"integer","examples":[1]},"links":{"type":"object","additionalProperties":{"type":"string"}}}},"ValidationErrorEnvelope":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["code","status","detail"],"properties":{"code":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"},"source":{"type":"object","required":["field"],"properties":{"field":{"type":"string"}}}}}}}},"AdminInstallExtensionRequest":{"type":"object","properties":{"package":{"type":"string","description":"Extension archive to install.","contentMediaType":"application/octet-stream"},"enable":{"type":"boolean","description":"Enable the extension after installing it.","examples":[false]}},"required":["package"]},"AdminUpdateExtensionSettingsRequest":{"type":"object","properties":{"settings":{"type":"object","description":"Field values keyed by input name, as described by the settings schema.","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"nullable":true},"examples":[{"curseforge_api_key":"cf-key","enabled":true,"result_limit":25}]}},"required":["settings"]},"AdminCreateUserRequest":{"type":"object","properties":{"external_id":{"type":["string","null"],"description":"An external identifier for this resource. Must not be greater than 191 characters.","examples":["example"]},"email":{"type":"string","description":"The user email address. Must be a valid email address. Must be between 1 and 191 characters.","examples":["admin@example.com"]},"username":{"type":"string","description":"The username. Must be between 1 and 191 characters.","examples":["example"]},"password":{"type":["string","null"],"description":"The password.","examples":["correct horse battery staple"]},"root_admin":{"type":"boolean","description":"Whether the user has administrator privileges.","examples":[true]},"name_first":{"type":"string","description":"The name first. Must be between 1 and 191 characters.","examples":["example"]},"name_last":{"type":"string","description":"The name last. Must be between 1 and 191 characters.","examples":["example"]},"preferences":{"type":"object","description":"","properties":{"language":{"type":"string","description":"The preferences language.","examples":["en"]}},"examples":["example"]}},"required":["email","username","name_first","name_last"]},"AdminUpdateUserRequest":{"type":"object","properties":{"external_id":{"type":["string","null"],"description":"An external identifier for this resource. Must not be greater than 191 characters.","examples":["example"]},"email":{"type":"string","description":"The user email address. Must be a valid email address. Must be between 1 and 191 characters.","examples":["admin@example.com"]},"username":{"type":"string","description":"The username. Must be between 1 and 191 characters.","examples":["example"]},"password":{"type":["string","null"],"description":"The password.","examples":["correct horse battery staple"]},"root_admin":{"type":"boolean","description":"Whether the user has administrator privileges.","examples":[true]},"name_first":{"type":"string","description":"The name first. Must be between 1 and 191 characters.","examples":["example"]},"name_last":{"type":"string","description":"The name last. Must be between 1 and 191 characters.","examples":["example"]},"preferences":{"type":"object","description":"","properties":{"language":{"type":"string","description":"The preferences language.","examples":["en"]}},"examples":["example"]}},"required":["email","username","name_first","name_last"]},"AdminAttachServerMountRequest":{"type":"object","properties":{"mount_id":{"type":"integer","description":"The mount ID. Must match an existing stored value.","examples":[1]}},"required":["mount_id"]},"AdminCreateServerRequest":{"type":"object","properties":{"external_id":{"type":["string","null"],"description":"An external identifier for this resource. Must be between 1 and 191 characters.","examples":["example"]},"name":{"type":"string","description":"The display name. Must be at least 1 character. Must not be greater than 191 characters.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]},"owner_id":{"type":"integer","description":"The owner user ID. Must match an existing stored value.","examples":[1]},"egg_id":{"type":"integer","description":"The egg ID. Must match an existing stored value.","examples":[1]},"docker_image":{"type":"string","description":"The Docker image to use. Must match the regex /^~?[\\w\\.\\/\\-:@ ]*$/. Must not be greater than 191 characters.","examples":["ghcr.io/pterodactyl/yolks:java_21"]},"startup":{"type":"string","description":"The startup command.","examples":["java -Xms128M -XX:MaxRAMPercentage=95.0 -jar {{SERVER_JARFILE}}"]},"environment":{"type":"object","description":"Environment variables for the server.","additionalProperties":{"type":"string"},"examples":[{"SERVER_JARFILE":"server.jar"}]},"skip_scripts":{"type":"boolean","description":"Whether install scripts should be skipped.","examples":[true]},"oom_disabled":{"type":"boolean","description":"Whether the OOM killer is disabled.","examples":[true]},"memory":{"type":"number","description":"The memory limit in megabytes. Must be at least 0.","examples":[1.5]},"swap":{"type":"number","description":"The swap limit in megabytes. Must be at least -1.","examples":[1.5]},"disk":{"type":"number","description":"The disk limit in megabytes. Must be at least 0.","examples":[1.5]},"io":{"type":"number","description":"The block IO weight. Must be between 10 and 1000.","examples":[1.5]},"threads":{"type":["string","null"],"description":"CPU threads available to the server. Must match the regex /^[0-9-,]+$/.","examples":["example"]},"cpu":{"type":"number","description":"The CPU limit percentage. Must be at least 0.","examples":[1.5]},"database_limit":{"type":["integer","null"],"description":"The maximum number of databases allowed. Must be at least 0.","examples":[1]},"allocation_limit":{"type":["integer","null"],"description":"The maximum number of allocations allowed. Must be at least 0.","examples":[1]},"backup_limit":{"type":["integer","null"],"description":"The maximum number of backups allowed. Must be at least 0.","examples":[1]},"primary_allocation_id":{"type":"integer","description":"The primary allocation ID.","examples":[1]},"deploy":{"type":"object","description":"The deploy.","properties":{"locations":{"type":"array","description":"Must be at least 1.","items":{"type":"integer"},"examples":[[1]]},"dedicated_ip":{"type":"string","description":"The deploy dedicated ip. This field is required when deploy or boolean is present.","examples":["example"]},"port_range":{"type":"array","description":"","items":{"type":"string"},"examples":[["25565-25570"]]},"tags":{"type":"array","description":"","items":{"type":"string"},"examples":[["example"]]}},"examples":["example"]},"start_on_completion":{"type":"boolean","description":"Whether the server should start when the operation completes.","examples":[true]},"secondary_allocations_ids":{"type":"array","description":"","items":{"type":"integer"},"examples":[[1,2]]}},"required":["name","owner_id","egg_id","docker_image","startup","memory","swap","disk","io","cpu","primary_allocation_id"]},"AdminUpdateServerDetailsRequest":{"type":"object","properties":{"external_id":{"type":["string","null"],"description":"An external identifier for this resource. Must be between 1 and 191 characters.","examples":["example"]},"name":{"type":"string","description":"The display name. Must be at least 1 character. Must not be greater than 191 characters.","examples":["Example Resource"]},"owner_id":{"type":"integer","description":"The owner user ID. Must match an existing stored value.","examples":[1]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]}},"required":["name","owner_id"]},"AdminUpdateServerBuildRequest":{"type":"object","properties":{"allocation_id":{"type":"integer","description":"The allocation ID. Must match an existing stored value.","examples":[1]},"oom_disabled":{"type":"boolean","description":"Whether the OOM killer is disabled.","examples":[true]},"memory":{"type":"number","description":"The memory limit in megabytes. This field is required when limits is not present. Must be at least 0.","examples":[1.5]},"swap":{"type":"number","description":"The swap limit in megabytes. This field is required when limits is not present. Must be at least -1.","examples":[1.5]},"io":{"type":"number","description":"The block IO weight. This field is required when limits is not present. Must be between 10 and 1000.","examples":[1.5]},"cpu":{"type":"number","description":"The CPU limit percentage. This field is required when limits is not present. Must be at least 0.","examples":[1.5]},"threads":{"type":["string","null"],"description":"CPU threads available to the server. Must match the regex /^[0-9-,]+$/.","examples":["example"]},"disk":{"type":"number","description":"The disk limit in megabytes. This field is required when limits is not present. Must be at least 0.","examples":[1.5]},"add_allocation_ids":{"type":"array","description":"","items":{"type":"integer"},"examples":[[1,2]]},"remove_allocation_ids":{"type":"array","description":"","items":{"type":"integer"},"examples":[[1,2]]},"database_limit":{"type":["integer","null"],"description":"The maximum number of databases allowed. Must be at least 0.","examples":[1]},"allocation_limit":{"type":["integer","null"],"description":"The maximum number of allocations allowed. Must be at least 0.","examples":[1]},"backup_limit":{"type":["integer","null"],"description":"The maximum number of backups allowed. Must be at least 0.","examples":[1]}},"required":["allocation_id"]},"AdminUpdateServerStartupRequest":{"type":"object","properties":{"startup":{"type":"string","description":"The startup command.","examples":["java -Xms128M -XX:MaxRAMPercentage=95.0 -jar {{SERVER_JARFILE}}"]},"environment":{"type":"object","description":"Environment variables for the server.","additionalProperties":{"type":"string"},"examples":[{"SERVER_JARFILE":"server.jar"}]},"egg_id":{"type":"integer","description":"The egg ID. Must match an existing stored value.","examples":[1]},"docker_image":{"type":"string","description":"The Docker image to use. Must match the regex /^~?[\\w\\.\\/\\-:@ ]*$/. Must not be greater than 191 characters.","examples":["ghcr.io/pterodactyl/yolks:java_21"]},"skip_scripts":{"type":"boolean","description":"Whether install scripts should be skipped.","examples":[true]}},"required":["startup","egg_id","docker_image"]},"AdminUpdateServerSuspensionRequest":{"type":"object","properties":{"suspended":{"type":["boolean","null"],"description":"The suspended.","examples":[true]}}},"AdminTransferServerRequest":{"type":"object","properties":{"node_id":{"type":"integer","description":"The destination node ID.","examples":[2]},"allocation_id":{"type":"integer","description":"The primary allocation ID on the destination node.","examples":[10]},"allocation_additional":{"type":"array","description":"Additional allocation IDs on the destination node.","items":{"type":"integer"},"examples":[[11,12]]}},"required":["node_id","allocation_id"]},"AdminCreateServerDatabaseRequest":{"type":"object","properties":{"database":{"type":"string","description":"The database. Must contain only letters, numbers, dashes and underscores. Must be at least 1 character. Must not be greater than 48 characters.","examples":["example"]},"remote":{"type":"string","description":"The remote database address. Must match the regex /^[0-9%.]{1,15}$/.","examples":["127.0.0.1"]},"database_host_id":{"type":"integer","description":"The database host ID. Must match an existing stored value.","examples":[1]},"max_connections":{"type":["integer","null"],"description":"The maximum number of connections allowed. Must be at least 0.","examples":[1]}},"required":["database","remote","database_host_id"]},"AdminCreateNodeRequest":{"type":"object","properties":{"public":{"type":"boolean","description":"The public.","examples":[true]},"name":{"type":"string","description":"The display name. Must match the regex /^([\\w .-]{1,100})$/.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]},"location_id":{"type":"integer","description":"The location ID. Must match an existing stored value.","examples":[1]},"fqdn":{"type":"string","description":"The fully qualified domain name.","examples":["node.example.com"]},"scheme":{"type":"string","description":"The scheme.","examples":["example"]},"behind_proxy":{"type":"boolean","description":"Whether the node is behind a proxy.","examples":[true]},"maintenance_mode":{"type":"boolean","description":"The maintenance mode.","examples":[true]},"memory":{"type":"number","description":"The memory limit in megabytes. Must be at least 1.","examples":[1.5]},"memory_overallocate":{"type":"number","description":"The memory overallocate. Must be at least -1.","examples":[1.5]},"disk":{"type":"number","description":"The disk limit in megabytes. Must be at least 1.","examples":[1.5]},"disk_overallocate":{"type":"number","description":"The disk overallocate. Must be at least -1.","examples":[1.5]},"upload_size":{"type":"integer","description":"The upload size. Must be at least 1.","examples":[1]},"daemon_listen":{"type":"number","description":"The daemon listen. Must be between 1 and 65535.","examples":[1.5]},"daemon_sftp":{"type":"number","description":"The daemon sftp. Must be between 1 and 65535.","examples":[1.5]},"daemon_base":{"type":"string","description":"The daemon base. Must match the regex /^([\\/][\\d\\w.\\-\\/]+)$/.","examples":["example"]}},"required":["name","location_id","fqdn","scheme","memory","memory_overallocate","disk","disk_overallocate","daemon_listen","daemon_sftp"]},"AdminUpdateNodeRequest":{"type":"object","properties":{"public":{"type":"boolean","description":"The public.","examples":[true]},"name":{"type":"string","description":"The display name. Must match the regex /^([\\w .-]{1,100})$/.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]},"location_id":{"type":"integer","description":"The location ID. Must match an existing stored value.","examples":[1]},"fqdn":{"type":"string","description":"The fully qualified domain name.","examples":["node.example.com"]},"scheme":{"type":"string","description":"The scheme.","examples":["example"]},"behind_proxy":{"type":"boolean","description":"Whether the node is behind a proxy.","examples":[true]},"maintenance_mode":{"type":"boolean","description":"The maintenance mode.","examples":[true]},"memory":{"type":"number","description":"The memory limit in megabytes. Must be at least 1.","examples":[1.5]},"memory_overallocate":{"type":"number","description":"The memory overallocate. Must be at least -1.","examples":[1.5]},"disk":{"type":"number","description":"The disk limit in megabytes. Must be at least 1.","examples":[1.5]},"disk_overallocate":{"type":"number","description":"The disk overallocate. Must be at least -1.","examples":[1.5]},"upload_size":{"type":"integer","description":"The upload size. Must be at least 1.","examples":[1]},"daemon_listen":{"type":"number","description":"The daemon listen. Must be between 1 and 65535.","examples":[1.5]},"daemon_sftp":{"type":"number","description":"The daemon sftp. Must be between 1 and 65535.","examples":[1.5]},"daemon_base":{"type":"string","description":"The daemon base. Must match the regex /^([\\/][\\d\\w.\\-\\/]+)$/.","examples":["example"]},"reset_secret":{"type":"boolean","description":"Whether to rotate the daemon secret.","examples":[false]}},"required":["name","location_id","fqdn","scheme","memory","memory_overallocate","disk","disk_overallocate","daemon_listen","daemon_sftp"]},"AdminSyncNodeGameTagsRequest":{"type":"object","properties":{"tags":{"type":"array","description":"Must not be greater than 191 characters.","items":{"type":"string"},"examples":[["example"]]}}},"AdminSyncNodeDeploymentTagsRequest":{"type":"object","properties":{"tags":{"type":"array","description":"Must not be greater than 191 characters.","items":{"type":"string"},"examples":[["example"]]}}},"AdminCreateNodeAllocationsRequest":{"type":"object","properties":{"ip":{"type":"array","description":"","items":{"type":"string"},"examples":[["example"]]},"alias":{"type":["string","null"],"description":"An optional alias for this resource. Must not be greater than 255 characters.","examples":["example"]},"ports":{"type":"array","description":"","items":{"type":"string"},"examples":[["25565-25570"]]}}},"AdminBulkDeleteNodeAllocationsRequest":{"type":"object","properties":{"ids":{"type":"array","description":"","items":{"type":"integer"},"examples":[["example"]]}}},"AdminDeleteNodeAllocationIPBlockRequest":{"type":"object","properties":{"ip":{"type":"string","description":"The IP address.","examples":["192.0.2.10"]}},"required":["ip"]},"AdminUpdateNodeAllocationRequest":{"type":"object","properties":{"alias":{"type":["string","null"],"description":"An optional alias for this resource.","examples":["example"]}}},"AdminCreateLocationRequest":{"type":"object","properties":{"short":{"type":"string","description":"The short. Must be between 1 and 60 characters.","examples":["example"]},"long":{"type":["string","null"],"description":"The long. Must be between 1 and 191 characters.","examples":["example"]}},"required":["short"]},"AdminUpdateLocationRequest":{"type":"object","properties":{"short":{"type":"string","description":"The short. Must be between 1 and 60 characters.","examples":["example"]},"long":{"type":["string","null"],"description":"The long. Must be between 1 and 191 characters.","examples":["example"]}},"required":["short"]},"AdminCreateMountRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must be at least 2 characters. Must not be greater than 64 characters.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource. Must not be greater than 191 characters.","examples":["A short description."]},"source":{"type":"string","description":"The source path. Must not be one of /etc/pterodactyl, /var/lib/pterodactyl/volumes, or /srv/daemon-data.","examples":["/server.properties"]},"target":{"type":"string","description":"The target path. Must not be one of /home/container.","examples":["/server.properties"]},"read_only":{"type":"boolean","description":"The read only.","examples":[true]},"user_mountable":{"type":"boolean","description":"Whether users can mount this resource.","examples":[true]}},"required":["name","source","target"]},"AdminUpdateMountRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must be at least 2 characters. Must not be greater than 64 characters.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource. Must not be greater than 191 characters.","examples":["A short description."]},"source":{"type":"string","description":"The source path. Must not be one of /etc/pterodactyl, /var/lib/pterodactyl/volumes, or /srv/daemon-data.","examples":["/server.properties"]},"target":{"type":"string","description":"The target path. Must not be one of /home/container.","examples":["/server.properties"]},"read_only":{"type":"boolean","description":"The read only.","examples":[true]},"user_mountable":{"type":"boolean","description":"Whether users can mount this resource.","examples":[true]}},"required":["name","source","target"]},"AdminAttachEggsToMountRequest":{"type":"object","properties":{"eggs":{"type":"array","description":"","items":{"type":"integer"},"examples":[["example"]]}},"required":["eggs"]},"AdminAttachNodesToMountRequest":{"type":"object","properties":{"nodes":{"type":"array","description":"","items":{"type":"integer"},"examples":[["example"]]}},"required":["nodes"]},"AdminImportCatalogEggRequest":{"type":"object","properties":{"catalog_id":{"type":"string","description":"The catalog id. Must not be greater than 255 characters.","examples":["example"]}},"required":["catalog_id"]},"AdminCreateEggVariableRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must be at least 1 character. Must not be greater than 191 characters.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]},"env_variable":{"type":"string","description":"The environment variable name. Must match the regex /^[\\w]{1,191}$/. Must not be one of SERVER_MEMORY, SERVER_IP, SERVER_PORT, ENV, HOME, USER, STARTUP, SERVER_UUID, or UUID.","examples":["SERVER_JARFILE"]},"options":{"type":"array","description":"","items":{"type":"string"},"examples":[["user_viewable","user_editable"]]},"rules":{"type":"string","description":"Laravel validation rules applied to user-submitted values.","examples":["required|string|max:64"]},"default_value":{"type":"string","description":"The default value.","examples":["server.jar"]}},"required":["name","env_variable","rules"]},"AdminReorderEggVariablesRequest":{"type":"object","properties":{"order":{"type":"array","description":"","items":{"type":"integer"},"examples":[[3,1,2]]}}},"AdminUpdateEggVariableRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must be at least 1 character. Must not be greater than 191 characters.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]},"env_variable":{"type":"string","description":"The environment variable name. Must match the regex /^[\\w]{1,191}$/. Must not be one of SERVER_MEMORY, SERVER_IP, SERVER_PORT, ENV, HOME, USER, STARTUP, SERVER_UUID, or UUID.","examples":["SERVER_JARFILE"]},"options":{"type":"array","description":"","items":{"type":"string"},"examples":[["user_viewable","user_editable"]]},"rules":{"type":"string","description":"Laravel validation rules applied to user-submitted values.","examples":["required|string|max:64"]},"default_value":{"type":"string","description":"The default value.","examples":["server.jar"]}},"required":["name","env_variable","rules"]},"AdminUpdateEggInstallScriptRequest":{"type":"object","properties":{"script_install":{"type":["string","null"],"description":"The install script body.","examples":["example"]},"script_is_privileged":{"type":"boolean","description":"Whether the install script runs in privileged mode.","examples":[true]},"script_entry":{"type":"string","description":"The install container entrypoint.","examples":["example"]},"script_container":{"type":"string","description":"The install container image.","examples":["example"]},"copy_script_from":{"type":["number","null"],"description":"Another egg ID to copy the install script from.","examples":[1.5]}}},"AdminUpdateEggFromImportRequest":{"type":"object","properties":{"import_file":{"type":"string","description":"The file to import. Must be a file. Must not be greater than 1000 kilobytes.","contentMediaType":"application/octet-stream"}},"required":["import_file"]},"AdminSyncEggTagsRequest":{"type":"object","properties":{"tags":{"type":"array","description":"Must not be greater than 191 characters.","items":{"type":"string"},"examples":[["example"]]}}},"AdminImportEggRequest":{"type":"object","properties":{"import_file":{"type":"string","description":"The file to import. Must be a file. Must not be greater than 1000 kilobytes.","contentMediaType":"application/octet-stream"}},"required":["import_file"]},"AdminCreateEggRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must not be greater than 191 characters.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]},"docker_images":{"type":"string","description":"Docker images available to this resource. Must match the regex /^[\\w#\\.\\/\\- ]*\\|?~?[\\w\\.\\/\\-:@ ]*$/im.","examples":["example"]},"force_outgoing_ip":{"type":"boolean","description":"Whether servers should use their allocation IP for outgoing traffic.","examples":[true]},"file_denylist":{"type":"array","description":"File patterns denied by the file manager.","items":{"type":"string"},"examples":[["/server.properties"]]},"features":{"type":"array","description":"Feature flags enabled for this resource.","items":{"type":"string"},"examples":[["example"]]},"startup":{"type":"string","description":"The startup command.","examples":["java -Xms128M -XX:MaxRAMPercentage=95.0 -jar {{SERVER_JARFILE}}"]},"config_from":{"type":["integer","null"],"description":"The config from. Must match an existing stored value.","examples":[1]},"config_stop":{"type":["string","null"],"description":"The config stop. This field is required when config_from is not present. Must not be greater than 191 characters.","examples":["example"]},"config_startup":{"type":["string","null"],"description":"The config startup. This field is required when config_from is not present. Must be a valid JSON string.","examples":["example"]},"config_logs":{"type":["string","null"],"description":"The config logs. This field is required when config_from is not present. Must be a valid JSON string.","examples":["example"]},"config_files":{"type":["string","null"],"description":"The config files. This field is required when config_from is not present. Must be a valid JSON string.","examples":["example"]}},"required":["name","docker_images","startup"]},"AdminUpdateEggRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must not be greater than 191 characters.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]},"docker_images":{"type":"string","description":"Docker images available to this resource. Must match the regex /^[\\w#\\.\\/\\- ]*\\|?~?[\\w\\.\\/\\-:@ ]*$/im.","examples":["example"]},"force_outgoing_ip":{"type":"boolean","description":"Whether servers should use their allocation IP for outgoing traffic.","examples":[true]},"file_denylist":{"type":"array","description":"File patterns denied by the file manager.","items":{"type":"string"},"examples":[["/server.properties"]]},"features":{"type":"array","description":"Feature flags enabled for this resource.","items":{"type":"string"},"examples":[["example"]]},"startup":{"type":"string","description":"The startup command.","examples":["java -Xms128M -XX:MaxRAMPercentage=95.0 -jar {{SERVER_JARFILE}}"]},"config_from":{"type":["integer","null"],"description":"The config from. Must match an existing stored value.","examples":[1]},"config_stop":{"type":["string","null"],"description":"The config stop. This field is required when config_from is not present. Must not be greater than 191 characters.","examples":["example"]},"config_startup":{"type":["string","null"],"description":"The config startup. This field is required when config_from is not present. Must be a valid JSON string.","examples":["example"]},"config_logs":{"type":["string","null"],"description":"The config logs. This field is required when config_from is not present. Must be a valid JSON string.","examples":["example"]},"config_files":{"type":["string","null"],"description":"The config files. This field is required when config_from is not present. Must be a valid JSON string.","examples":["example"]}},"required":["name","docker_images","startup"]},"AdminCreateTagRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must be between 1 and 191 characters.","examples":["Example Resource"]},"slug":{"type":"string","description":"The slug. Must be between 1 and 191 characters.","examples":["example"]},"color":{"type":["string","null"],"description":"The color.","examples":["example"]}},"required":["name","slug"]},"AdminUpdateTagRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must be between 1 and 191 characters.","examples":["Example Resource"]},"slug":{"type":"string","description":"The slug. Must be between 1 and 191 characters.","examples":["example"]},"color":{"type":["string","null"],"description":"The color.","examples":["example"]}},"required":["name","slug"]},"AdminUpdateGeneralSettingsRequest":{"type":"object","properties":{"branding":{"type":"object","description":"","properties":{"name":{"type":"string","description":"The branding name. Must not be greater than 191 characters.","examples":["example"]}},"required":["name"],"examples":["example"]},"misc":{"type":"object","description":"","properties":{"required_2fa":{"type":"integer","description":"The misc required 2fa.","enum":[0,1,2],"examples":[1]}},"required":["required_2fa"],"examples":["example"]},"default_locale":{"type":"string","description":"The default locale.","examples":["en"]}},"required":["default_locale"]},"AdminUpdateMailSettingsRequest":{"type":"object","properties":{"smtp":{"type":"object","description":"","properties":{"host":{"type":"string","description":"The smtp host.","examples":["smtp.example.com"]},"port":{"type":"integer","description":"The smtp port. Must be between 1 and 65535.","examples":[587]},"encryption":{"type":["string","null"],"enum":["tls","ssl",null],"description":"The smtp encryption.","examples":["tls"]},"username":{"type":["string","null"],"description":"The smtp username. Must not be greater than 191 characters.","examples":["example"]},"password":{"type":["string","null"],"description":"The smtp password. Must not be greater than 191 characters.","examples":["correct horse battery staple"]},"from_address":{"type":"string","description":"The smtp from address. Must be a valid email address.","examples":["example"]},"from_name":{"type":["string","null"],"description":"The smtp from name. Must not be greater than 191 characters.","examples":["example"]}},"required":["host","port","from_address"],"examples":["example"]}}},"AdminUpdateAdvancedSettingsRequest":{"type":"object","properties":{"recaptcha:enabled":{"type":"string","description":"The recaptcha:enabled.","enum":["true","false"],"examples":["example"]},"recaptcha:secret_key":{"type":"string","description":"The recaptcha:secret key. Must not be greater than 191 characters.","examples":["example"]},"recaptcha:website_key":{"type":"string","description":"The recaptcha:website key. Must not be greater than 191 characters.","examples":["example"]},"pterodactyl:guzzle:timeout":{"type":"integer","description":"The pterodactyl:guzzle:timeout. Must be between 1 and 60.","examples":[1]},"pterodactyl:guzzle:connect_timeout":{"type":"integer","description":"The pterodactyl:guzzle:connect timeout. Must be between 1 and 60.","examples":[1]},"pterodactyl:client_features:allocations:enabled":{"type":"string","description":"The pterodactyl:client features:allocations:enabled.","enum":["true","false"],"examples":[1]},"pterodactyl:client_features:allocations:range_start":{"type":["integer","null"],"description":"The pterodactyl:client features:allocations:range start. This field is required when pterodactyl:client_features:allocations:enabled is true. Must be between 1024 and 65535.","examples":[1]},"pterodactyl:client_features:allocations:range_end":{"type":["integer","null"],"description":"The pterodactyl:client features:allocations:range end. This field is required when pterodactyl:client_features:allocations:enabled is true. Must be between 1024 and 65535.","examples":[1]}},"required":["recaptcha:enabled","recaptcha:secret_key","recaptcha:website_key","pterodactyl:guzzle:timeout","pterodactyl:guzzle:connect_timeout","pterodactyl:client_features:allocations:enabled"]},"AdminCreateDatabaseHostRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must not be greater than 191 characters.","examples":["Example Resource"]},"host":{"type":"string","description":"The database host address. Must match the regex /^[\\w\\-\\.]+$/.","examples":["127.0.0.1"]},"port":{"type":"number","description":"The port number. Must be between 1 and 65535.","examples":[1.5]},"username":{"type":"string","description":"The username. Must not be greater than 32 characters.","examples":["example"]},"password":{"type":["string","null"],"description":"The password.","examples":["correct horse battery staple"]},"node_id":{"type":["integer","null"],"description":"The node ID. Must match an existing stored value.","examples":[1]}},"required":["name","host","port","username"]},"AdminUpdateDatabaseHostRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must not be greater than 191 characters.","examples":["Example Resource"]},"host":{"type":"string","description":"The database host address. Must match the regex /^[\\w\\-\\.]+$/.","examples":["127.0.0.1"]},"port":{"type":"number","description":"The port number. Must be between 1 and 65535.","examples":[1.5]},"username":{"type":"string","description":"The username. Must not be greater than 32 characters.","examples":["example"]},"password":{"type":["string","null"],"description":"The password.","examples":["correct horse battery staple"]},"node_id":{"type":["integer","null"],"description":"The node ID. Must match an existing stored value.","examples":[1]}},"required":["name","host","port","username"]},"AdminCreateAPIKeyRequest":{"type":"object","properties":{"memo":{"type":"string","description":"The memo. Must not be greater than 500 characters.","examples":["example"]},"r_servers":{"type":"integer","description":"The r servers. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_nodes":{"type":"integer","description":"The r nodes. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_allocations":{"type":"integer","description":"The r allocations. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_users":{"type":"integer","description":"The r users. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_locations":{"type":"integer","description":"The r locations. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_eggs":{"type":"integer","description":"The r eggs. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_database_hosts":{"type":"integer","description":"The r database hosts. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_server_databases":{"type":"integer","description":"The r server databases. Must be at least 0. Must not be greater than 3.","examples":[1]}},"required":["memo"]},"AdminUpdateAPIKeyRequest":{"type":"object","properties":{"memo":{"type":"string","description":"The memo. Must not be greater than 500 characters.","examples":["example"]},"r_servers":{"type":"integer","description":"The r servers. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_nodes":{"type":"integer","description":"The r nodes. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_allocations":{"type":"integer","description":"The r allocations. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_users":{"type":"integer","description":"The r users. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_locations":{"type":"integer","description":"The r locations. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_eggs":{"type":"integer","description":"The r eggs. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_database_hosts":{"type":"integer","description":"The r database hosts. Must be at least 0. Must not be greater than 3.","examples":[1]},"r_server_databases":{"type":"integer","description":"The r server databases. Must be at least 0. Must not be greater than 3.","examples":[1]}},"required":["memo"]},"ApplicationCreateUserRequest":{"type":"object","properties":{"external_id":{"type":["string","null"],"description":"An external identifier for this resource. Must not be greater than 191 characters.","examples":["example"]},"email":{"type":"string","description":"The user email address. Must be a valid email address. Must be between 1 and 191 characters.","examples":["admin@example.com"]},"username":{"type":"string","description":"The username. Must be between 1 and 191 characters.","examples":["example"]},"password":{"type":["string","null"],"description":"The password.","examples":["correct horse battery staple"]},"language":{"type":"string","description":"The locale code.","enum":["en"],"examples":["example"]},"root_admin":{"type":"boolean","description":"Whether the user has administrator privileges.","examples":[true]},"first_name":{"type":"string","description":"The first name. Must be between 1 and 191 characters.","examples":["example"]},"last_name":{"type":"string","description":"The last name. Must be between 1 and 191 characters.","examples":["example"]}},"required":["email","username","first_name","last_name"]},"ApplicationUpdateUserRequest":{"type":"object","properties":{"external_id":{"type":["string","null"],"description":"An external identifier for this resource. Must not be greater than 191 characters.","examples":["example"]},"email":{"type":"string","description":"The user email address. Must be a valid email address. Must be between 1 and 191 characters.","examples":["admin@example.com"]},"username":{"type":"string","description":"The username. Must be between 1 and 191 characters.","examples":["example"]},"password":{"type":["string","null"],"description":"The password.","examples":["correct horse battery staple"]},"language":{"type":"string","description":"The locale code.","enum":["en"],"examples":["example"]},"root_admin":{"type":"boolean","description":"Whether the user has administrator privileges.","examples":[true]},"first_name":{"type":"string","description":"The first name. Must be between 1 and 191 characters.","examples":["example"]},"last_name":{"type":"string","description":"The last name. Must be between 1 and 191 characters.","examples":["example"]}},"required":["email","username","first_name","last_name"]},"ApplicationCreateNodeRequest":{"type":"object","properties":{"public":{"type":"boolean","description":"The public.","examples":[true]},"name":{"type":"string","description":"The display name. Must match the regex /^([\\w .-]{1,100})$/.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]},"location_id":{"type":"integer","description":"The location ID. Must match an existing stored value.","examples":[1]},"fqdn":{"type":"string","description":"The fully qualified domain name.","examples":["node.example.com"]},"scheme":{"type":"string","description":"The scheme.","examples":["example"]},"behind_proxy":{"type":"boolean","description":"Whether the node is behind a proxy.","examples":[true]},"maintenance_mode":{"type":"boolean","description":"The maintenance mode.","examples":[true]},"memory":{"type":"number","description":"The memory limit in megabytes. Must be at least 1.","examples":[1.5]},"memory_overallocate":{"type":"number","description":"The memory overallocate. Must be at least -1.","examples":[1.5]},"disk":{"type":"number","description":"The disk limit in megabytes. Must be at least 1.","examples":[1.5]},"disk_overallocate":{"type":"number","description":"The disk overallocate. Must be at least -1.","examples":[1.5]},"upload_size":{"type":"integer","description":"The upload size. Must be at least 1.","examples":[1]},"daemon_listen":{"type":"number","description":"The daemon listen. Must be between 1 and 65535.","examples":[1.5]},"daemon_sftp":{"type":"number","description":"The daemon sftp. Must be between 1 and 65535.","examples":[1.5]},"daemon_base":{"type":"string","description":"The daemon base. Must match the regex /^([\\/][\\d\\w.\\-\\/]+)$/.","examples":["example"]}},"required":["name","location_id","fqdn","scheme","memory","memory_overallocate","disk","disk_overallocate","daemon_listen","daemon_sftp"]},"ApplicationUpdateNodeRequest":{"type":"object","properties":{"public":{"type":"boolean","description":"The public.","examples":[true]},"name":{"type":"string","description":"The display name. Must match the regex /^([\\w .-]{1,100})$/.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]},"location_id":{"type":"integer","description":"The location ID. Must match an existing stored value.","examples":[1]},"fqdn":{"type":"string","description":"The fully qualified domain name.","examples":["node.example.com"]},"scheme":{"type":"string","description":"The scheme.","examples":["example"]},"behind_proxy":{"type":"boolean","description":"Whether the node is behind a proxy.","examples":[true]},"maintenance_mode":{"type":"boolean","description":"The maintenance mode.","examples":[true]},"memory":{"type":"number","description":"The memory limit in megabytes. Must be at least 1.","examples":[1.5]},"memory_overallocate":{"type":"number","description":"The memory overallocate. Must be at least -1.","examples":[1.5]},"disk":{"type":"number","description":"The disk limit in megabytes. Must be at least 1.","examples":[1.5]},"disk_overallocate":{"type":"number","description":"The disk overallocate. Must be at least -1.","examples":[1.5]},"upload_size":{"type":"integer","description":"The upload size. Must be at least 1.","examples":[1]},"daemon_listen":{"type":"number","description":"The daemon listen. Must be between 1 and 65535.","examples":[1.5]},"daemon_sftp":{"type":"number","description":"The daemon sftp. Must be between 1 and 65535.","examples":[1.5]},"daemon_base":{"type":"string","description":"The daemon base. Must match the regex /^([\\/][\\d\\w.\\-\\/]+)$/.","examples":["example"]},"reset_secret":{"type":"boolean","description":"The reset secret.","examples":[true]}},"required":["name","location_id","fqdn","scheme","memory","memory_overallocate","disk","disk_overallocate","daemon_listen","daemon_sftp"]},"ApplicationCreateNodeAllocationsRequest":{"type":"object","properties":{"ip":{"type":"string","description":"The IP address.","examples":["192.0.2.10"]},"alias":{"type":["string","null"],"description":"An optional alias for this resource. Must not be greater than 191 characters.","examples":["example"]},"ports":{"type":"array","description":"","items":{"type":"string"},"examples":[["25565-25570"]]}},"required":["ip"]},"ApplicationCreateLocationRequest":{"type":"object","properties":{"short":{"type":"string","description":"The short. Must be between 1 and 60 characters.","examples":["example"]},"long":{"type":["string","null"],"description":"The long. Must be between 1 and 191 characters.","examples":["example"]}},"required":["short"]},"ApplicationUpdateLocationRequest":{"type":"object","properties":{"short":{"type":"string","description":"The short. Must be between 1 and 60 characters.","examples":["example"]},"long":{"type":["string","null"],"description":"The long. Must be between 1 and 191 characters.","examples":["example"]}},"required":["short"]},"ApplicationCreateServerRequest":{"type":"object","properties":{"external_id":{"type":["string","null"],"description":"An external identifier for this resource. Must be between 1 and 191 characters.","examples":["example"]},"name":{"type":"string","description":"The display name. Must be at least 1 character. Must not be greater than 191 characters.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]},"user":{"type":"integer","description":"The user ID. Must match an existing stored value.","examples":[1]},"egg":{"type":"string","description":"The egg. Must match an existing stored value.","examples":["example"]},"docker_image":{"type":"string","description":"The Docker image to use. Must match the regex /^~?[\\w\\.\\/\\-:@ ]*$/. Must not be greater than 191 characters.","examples":["ghcr.io/pterodactyl/yolks:java_21"]},"startup":{"type":"string","description":"The startup command.","examples":["java -Xms128M -XX:MaxRAMPercentage=95.0 -jar {{SERVER_JARFILE}}"]},"environment":{"type":"object","description":"Environment variables for the server.","additionalProperties":{"type":"string"},"examples":[{"SERVER_JARFILE":"server.jar"}]},"skip_scripts":{"type":"boolean","description":"Whether install scripts should be skipped.","examples":[true]},"oom_disabled":{"type":"boolean","description":"Whether the OOM killer is disabled.","examples":[true]},"limits":{"type":"object","description":"The limits.","properties":{"memory":{"type":"number","description":"The limits memory. Must be at least 0.","examples":[1]},"swap":{"type":"number","description":"The limits swap. Must be at least -1.","examples":[1]},"disk":{"type":"number","description":"The limits disk. Must be at least 0.","examples":[1]},"io":{"type":"number","description":"The limits io. Must be between 10 and 1000.","examples":[1]},"threads":{"type":["string","null"],"description":"The limits threads. Must match the regex /^[0-9-,]+$/.","examples":[1]},"cpu":{"type":"number","description":"The limits cpu. Must be at least 0.","examples":[1]}},"required":["memory","swap","disk","io","cpu"],"examples":["example"]},"feature_limits":{"type":"object","description":"The feature limits.","properties":{"databases":{"type":["integer","null"],"description":"The maximum number of databases allowed. Must be at least 0.","examples":[1]},"allocations":{"type":["integer","null"],"description":"The maximum number of allocations allowed. Must be at least 0.","examples":[1]},"backups":{"type":["integer","null"],"description":"The maximum number of backups allowed. Must be at least 0.","examples":[1]}},"examples":["example"]},"allocation":{"type":"object","description":"","properties":{"default":{"type":"integer","description":"The allocation default.","examples":[1]},"additional":{"type":"array","description":"","items":{"type":"integer"},"examples":[[1,2]]}},"required":["default"],"examples":[1]},"deploy":{"type":"object","description":"The deploy.","properties":{"locations":{"type":"array","description":"Must be at least 1.","items":{"type":"integer"},"examples":[[1]]},"dedicated_ip":{"type":"boolean","description":"The deploy dedicated ip.","examples":[false]},"port_range":{"type":"array","description":"","items":{"type":"string"},"examples":[["25565-25570"]]},"tags":{"type":"array","description":"The deploy tags.","items":{"oneOf":[{"type":"integer"},{"type":"string"}]},"examples":[["minecraft",1]]}},"examples":["example"]},"start_on_completion":{"type":"boolean","description":"Whether the server should start when the operation completes.","examples":[true]}},"required":["name","user","egg","docker_image","startup","limits","feature_limits"]},"ApplicationUpdateServerDetailsRequest":{"type":"object","properties":{"external_id":{"type":["string","null"],"description":"An external identifier for this resource. Must be between 1 and 191 characters.","examples":["example"]},"name":{"type":"string","description":"The display name. Must be at least 1 character. Must not be greater than 191 characters.","examples":["Example Resource"]},"user":{"type":"integer","description":"The user ID. Must match an existing stored value.","examples":[1]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]}},"required":["name","user"]},"ApplicationUpdateServerBuildRequest":{"type":"object","properties":{"allocation":{"type":"string","description":"The allocation ID. Must match an existing stored value.","examples":[1]},"oom_disabled":{"type":"boolean","description":"Whether the OOM killer is disabled.","examples":[true]},"limits":{"type":"object","description":"The limits.","properties":{"memory":{"type":"number","description":"The limits memory. This field is required when limits is present. Must be at least 0.","examples":[1]},"swap":{"type":"number","description":"The limits swap. This field is required when limits is present. Must be at least -1.","examples":[1]},"io":{"type":"number","description":"The limits io. This field is required when limits is present. Must be between 10 and 1000.","examples":[1]},"cpu":{"type":"number","description":"The limits cpu. This field is required when limits is present. Must be at least 0.","examples":[1]},"threads":{"type":["string","null"],"description":"The limits threads. Must match the regex /^[0-9-,]+$/.","examples":[1]},"disk":{"type":"number","description":"The limits disk. This field is required when limits is present. Must be at least 0.","examples":[1]}},"examples":["example"]},"memory":{"type":"number","description":"The memory limit in megabytes. This field is required when limits is not present. Must be at least 0.","examples":[1.5]},"swap":{"type":"number","description":"The swap limit in megabytes. This field is required when limits is not present. Must be at least -1.","examples":[1.5]},"io":{"type":"number","description":"The block IO weight. This field is required when limits is not present. Must be between 10 and 1000.","examples":[1.5]},"cpu":{"type":"number","description":"The CPU limit percentage. This field is required when limits is not present. Must be at least 0.","examples":[1.5]},"threads":{"type":["string","null"],"description":"CPU threads available to the server. Must match the regex /^[0-9-,]+$/.","examples":["example"]},"disk":{"type":"number","description":"The disk limit in megabytes. This field is required when limits is not present. Must be at least 0.","examples":[1.5]},"add_allocations":{"type":"array","description":"","items":{"type":"integer"},"examples":[[1,2]]},"remove_allocations":{"type":"array","description":"","items":{"type":"integer"},"examples":[[1,2]]},"feature_limits":{"type":"object","description":"The feature limits.","properties":{"databases":{"type":["integer","null"],"description":"The maximum number of databases allowed. Must be at least 0.","examples":[1]},"allocations":{"type":["integer","null"],"description":"The maximum number of allocations allowed. Must be at least 0.","examples":[1]},"backups":{"type":["integer","null"],"description":"The maximum number of backups allowed. Must be at least 0.","examples":[1]}},"examples":["example"]}},"required":["allocation","feature_limits"]},"ApplicationUpdateServerStartupRequest":{"type":"object","properties":{"startup":{"type":"string","description":"The startup command.","examples":["java -Xms128M -XX:MaxRAMPercentage=95.0 -jar {{SERVER_JARFILE}}"]},"environment":{"type":"object","description":"Environment variables for the server.","additionalProperties":{"type":"string"},"examples":[{"SERVER_JARFILE":"server.jar"}]},"egg":{"type":"string","description":"The egg. Must match an existing stored value.","examples":["example"]},"image":{"type":"string","description":"The image. Must match the regex /^~?[\\w\\.\\/\\-:@ ]*$/. Must not be greater than 191 characters.","examples":["example"]},"skip_scripts":{"type":"boolean","description":"Whether install scripts should be skipped.","examples":[true]}},"required":["startup","egg","image"]},"ApplicationCreateServerDatabaseRequest":{"type":"object","properties":{"database":{"type":"string","description":"The database. Must contain only letters, numbers, dashes and underscores. Must be at least 1 character. Must not be greater than 48 characters.","examples":["example"]},"remote":{"type":"string","description":"The remote database address. Must match the regex /^[0-9%.]{1,15}$/.","examples":["127.0.0.1"]},"host":{"type":"integer","description":"The database host address. Must match an existing stored value.","examples":[1]}},"required":["database","remote","host"]},"AuthLoginRequest":{"type":"object","properties":{"user":{"type":"string","description":"The account username or email address.","examples":["admin"]},"password":{"type":"string","description":"The account password.","examples":["correct-horse-battery-staple"]},"g-recaptcha-response":{"type":["string","null"],"description":"The reCAPTCHA token when reCAPTCHA is enabled.","examples":["03AFcWeA..."]}},"required":["user","password"]},"AuthCompleteLoginCheckpointRequest":{"type":"object","properties":{"confirmation_token":{"type":"string","description":"The confirmation token returned by the login endpoint.","examples":["b6e22f85d63c4d9db9739f9ab0a27a48f51f7ad38ef8c12fd157c4c6f4b2e51d"]},"authentication_code":{"type":["string","null"],"description":"The six-digit TOTP code. Required when recovery_token is not provided.","examples":["123456"]},"recovery_token":{"type":["string","null"],"description":"A recovery token. Required when authentication_code is not provided.","examples":["r1a2b3c4d5"]}},"required":["confirmation_token"]},"AuthRequestPasswordResetEmailRequest":{"type":"object","properties":{"email":{"type":"string","description":"The account email address.","examples":["admin@example.com"]},"g-recaptcha-response":{"type":["string","null"],"description":"The reCAPTCHA token when reCAPTCHA is enabled.","examples":["03AFcWeA..."]}},"required":["email"]},"AuthResetPasswordRequest":{"type":"object","properties":{"token":{"type":"string","description":"The password reset token.","examples":["b6e22f85d63c4d9db9739f9ab0a27a48f51f7ad38ef8c12fd157c4c6f4b2e51d"]},"email":{"type":"string","description":"The account email address.","examples":["admin@example.com"]},"password":{"type":"string","description":"The new account password. Must be at least eight characters.","examples":["correct-horse-battery-staple"]},"password_confirmation":{"type":"string","description":"Confirmation matching the new account password.","examples":["correct-horse-battery-staple"]}},"required":["token","email","password","password_confirmation"]},"ClientEnableTwoFactorAuthenticationRequest":{"type":"object","properties":{"code":{"type":"string","description":"The six-digit TOTP code generated by the authenticator app.","examples":["123456"]},"password":{"type":"string","description":"The current account password.","examples":["current-password"]}},"required":["code","password"]},"ClientDisableTwoFactorAuthenticationRequest":{"type":"object","properties":{"password":{"type":"string","description":"The current account password.","examples":["current-password"]}},"required":["password"]},"ClientUpdateAccountEmailRequest":{"type":"object","properties":{"email":{"type":"string","description":"The user email address. Must be a valid email address. Must be between 1 and 191 characters.","examples":["admin@example.com"]},"password":{"type":"string","description":"The current account password.","examples":["current-password"]}},"required":["email","password"]},"ClientUpdateAccountPasswordRequest":{"type":"object","properties":{"password":{"type":"string","description":"The password. Must be at least 8 characters.","examples":["correct horse battery staple"]},"current_password":{"type":"string","description":"The current account password.","examples":["current-password"]},"password_confirmation":{"type":"string","description":"Confirmation matching the new password.","examples":["correct-horse-battery-staple"]}},"required":["password","current_password","password_confirmation"]},"ClientCreateAccountAPIKeyRequest":{"type":"object","properties":{"description":{"type":"string","description":"A description for this resource. Must not be greater than 500 characters.","examples":["A short description."]},"allowed_ips":{"type":"array","description":"","items":{"type":"string"},"examples":[["example"]]}},"required":["description"]},"ClientCreateSSHKeyRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name.","examples":["Example Resource"]},"public_key":{"type":"string","description":"The SSH public key.","examples":["ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIExampleKey user@example.com"]}},"required":["name","public_key"]},"ClientDeleteSSHKeyRequest":{"type":"object","properties":{"fingerprint":{"type":"string","description":"The SSH key fingerprint.","examples":["example"]}},"required":["fingerprint"]},"ClientSendServerCommandRequest":{"type":"object","properties":{"command":{"type":"string","description":"The console command to send. Must be at least 1 character.","examples":["say Server restarting in 5 minutes"]}},"required":["command"]},"ClientSendPowerActionRequest":{"type":"object","properties":{"signal":{"type":"string","description":"The power signal.","enum":["start","stop","restart","kill"],"examples":["start"]}},"required":["signal"]},"ClientCreateServerDatabaseRequest":{"type":"object","properties":{"database":{"type":"string","description":"The database. Must contain only letters, numbers, dashes and underscores. Must be at least 3 characters. Must not be greater than 48 characters.","examples":["example"]},"remote":{"type":"string","description":"The remote database address. Must match the regex /^[\\w\\-\\/.%:]+$/.","examples":["127.0.0.1"]}},"required":["database","remote"]},"ClientRenameFilesRequest":{"type":"object","properties":{"root":{"type":"string","description":"The root.","examples":["example"]},"files":{"type":"array","description":"","items":{"type":"object","properties":{"to":{"type":"string","description":"","examples":["example"]},"from":{"type":"string","description":"","examples":["example"]}},"required":["to","from"]},"examples":[["/server.properties"]]}},"required":["root"]},"ClientCopyFileRequest":{"type":"object","properties":{"location":{"type":"string","description":"The location.","examples":["example"]}},"required":["location"]},"ClientWriteFileContentsRequest":{"type":"string","description":"Raw file contents to write.","examples":["motd=A Minecraft Server\nserver-port=25565"]},"ClientCompressFilesRequest":{"type":"object","properties":{"root":{"type":["string","null"],"description":"The root.","examples":["example"]},"files":{"type":"array","description":"","items":{"type":"string"},"examples":[["/server.properties"]]}}},"ClientDecompressFileRequest":{"type":"object","properties":{"root":{"type":["string","null"],"description":"The root.","examples":["example"]},"file":{"type":"string","description":"The file path.","examples":["/server.properties"]}},"required":["file"]},"ClientDeleteFilesRequest":{"type":"object","properties":{"root":{"type":"string","description":"The root.","examples":["example"]},"files":{"type":"array","description":"","items":{"type":"string"},"examples":[["/server.properties"]]}},"required":["root"]},"ClientCreateFolderRequest":{"type":"object","properties":{"root":{"type":["string","null"],"description":"The root.","examples":["example"]},"name":{"type":"string","description":"The display name.","examples":["Example Resource"]}},"required":["name"]},"ClientChangeFilePermissionsRequest":{"type":"object","properties":{"root":{"type":"string","description":"The root.","examples":["example"]},"files":{"type":"array","description":"File paths affected by the operation.","items":{"type":"object","properties":{"file":{"type":"string","description":"","examples":["example"]},"mode":{"type":"number","description":"","examples":[1.5]}},"required":["file","mode"]},"examples":[["/server.properties"]]}},"required":["root","files"]},"ClientPullRemoteFileRequest":{"type":"object","properties":{"url":{"type":"string","description":"The URL. Must be a valid URL.","examples":["https://example.com/server.jar"]},"directory":{"type":["string","null"],"description":"The directory path.","examples":["/config"]},"filename":{"type":["string","null"],"description":"The file name.","examples":["server.properties"]},"use_header":{"type":"boolean","description":"The use header.","examples":[true]},"foreground":{"type":"boolean","description":"The foreground.","examples":[true]}},"required":["url"]},"ClientCreateServerScheduleRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must not be greater than 191 characters.","examples":["Example Resource"]},"is_active":{"type":"boolean","description":"Whether the resource is active.","examples":[true]},"minute":{"type":"string","description":"The minute.","examples":["example"]},"hour":{"type":"string","description":"The hour.","examples":["example"]},"day_of_month":{"type":"string","description":"The day of month.","examples":["example"]},"month":{"type":"string","description":"The month.","examples":["*"]},"day_of_week":{"type":"string","description":"The day of week.","examples":["example"]},"only_when_online":{"type":"boolean","description":"Whether the schedule should run only when the server is online.","examples":[true]}},"required":["name","minute","hour","day_of_month","month","day_of_week"]},"ClientUpdateServerScheduleRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must not be greater than 191 characters.","examples":["Example Resource"]},"is_active":{"type":"boolean","description":"Whether the resource is active.","examples":[true]},"minute":{"type":"string","description":"The minute.","examples":["example"]},"hour":{"type":"string","description":"The hour.","examples":["example"]},"day_of_month":{"type":"string","description":"The day of month.","examples":["example"]},"month":{"type":"string","description":"The month.","examples":["*"]},"day_of_week":{"type":"string","description":"The day of week.","examples":["example"]},"only_when_online":{"type":"boolean","description":"Whether the schedule should run only when the server is online.","examples":[true]}},"required":["name","minute","hour","day_of_month","month","day_of_week"]},"ClientCreateScheduleTaskRequest":{"type":"object","properties":{"action":{"type":"string","description":"The action to perform.","enum":["command","power","backup"],"examples":["example"]},"payload":{"type":["string","null"],"description":"The payload. This field is required unless action is in backup.","examples":["example"]},"time_offset":{"type":"number","description":"The delay before this task runs. Must be at least 0. Must not be greater than 900.","examples":[1.5]},"sequence_id":{"type":"number","description":"The task execution order. Must be at least 1.","examples":[1.5]},"continue_on_failure":{"type":"boolean","description":"Whether the schedule continues when this task fails.","examples":[true]}},"required":["action","time_offset"]},"ClientUpdateScheduleTaskRequest":{"type":"object","properties":{"action":{"type":"string","description":"The action to perform.","enum":["command","power","backup"],"examples":["example"]},"payload":{"type":["string","null"],"description":"The payload. This field is required unless action is in backup.","examples":["example"]},"time_offset":{"type":"number","description":"The delay before this task runs. Must be at least 0. Must not be greater than 900.","examples":[1.5]},"sequence_id":{"type":"number","description":"The task execution order. Must be at least 1.","examples":[1.5]},"continue_on_failure":{"type":"boolean","description":"Whether the schedule continues when this task fails.","examples":[true]}},"required":["action","time_offset"]},"ClientUpdateAllocationNotesRequest":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Notes for this resource. Must not be greater than 256 characters.","examples":["example"]}}},"ClientCreateServerSubuserRequest":{"type":"object","properties":{"email":{"type":"string","description":"The user email address. Must be a valid email address. Must be between 1 and 191 characters.","examples":["admin@example.com"]},"permissions":{"type":"array","items":{"type":"string","enum":["websocket.connect","control.console","control.start","control.stop","control.restart","user.create","user.read","user.update","user.delete","file.create","file.read","file.read-content","file.update","file.delete","file.archive","file.sftp","backup.create","backup.read","backup.delete","backup.download","backup.restore","allocation.read","allocation.create","allocation.update","allocation.delete","startup.read","startup.update","startup.docker-image","database.create","database.read","database.update","database.delete","database.view_password","schedule.create","schedule.read","schedule.update","schedule.delete","settings.rename","settings.reinstall","activity.read"]},"description":"Permissions granted to the user.","examples":[["websocket.connect","control.console"]]}},"required":["email"]},"ClientUpdateServerSubuserRequest":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"string","enum":["websocket.connect","control.console","control.start","control.stop","control.restart","user.create","user.read","user.update","user.delete","file.create","file.read","file.read-content","file.update","file.delete","file.archive","file.sftp","backup.create","backup.read","backup.delete","backup.download","backup.restore","allocation.read","allocation.create","allocation.update","allocation.delete","startup.read","startup.update","startup.docker-image","database.create","database.read","database.update","database.delete","database.view_password","schedule.create","schedule.read","schedule.update","schedule.delete","settings.rename","settings.reinstall","activity.read"]},"description":"Permissions granted to the user.","examples":[["websocket.connect","control.console"]]}}},"ClientCreateServerBackupRequest":{"type":"object","properties":{"name":{"type":["string","null"],"description":"The display name. Must not be greater than 191 characters.","examples":["Example Resource"]},"is_locked":{"type":["boolean","null"],"description":"Whether the resource is locked.","examples":[true]},"ignored":{"type":["string","null"],"description":"Whether this item should be ignored.","examples":["example"]}}},"ClientRestoreServerBackupRequest":{"type":"object","properties":{"truncate":{"type":"boolean","description":"The truncate.","examples":[true]}},"required":["truncate"]},"ClientUpdateStartupVariableRequest":{"type":"object","properties":{"key":{"type":"string","description":"The key.","examples":["example"]},"value":{"type":"string","description":"The value.","examples":["example"]}},"required":["key"]},"ClientRenameServerRequest":{"type":"object","properties":{"name":{"type":"string","description":"The display name. Must be at least 1 character. Must not be greater than 191 characters.","examples":["Example Resource"]},"description":{"type":["string","null"],"description":"A description for this resource.","examples":["A short description."]}},"required":["name"]},"ClientSetServerDockerImageRequest":{"type":"object","properties":{"docker_image":{"type":"string","description":"The Docker image to use.","examples":["ghcr.io/pterodactyl/yolks:java_21"]}},"required":["docker_image"]},"AdminListExtensionsResponseBody":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","examples":["example-extension"]},"name":{"type":"string","examples":["Example Extension"]},"version":{"type":"string","examples":["1.0.0"]},"description":{"type":["string","null"],"examples":["Example extension"]},"author":{"type":["string","null"],"examples":["Pterodactyl"]},"provider":{"type":["string","null"],"examples":["ExampleExtension\\Provider"]},"has_ui":{"type":"boolean","examples":[true]},"ui_entry":{"type":["string","null"],"examples":["dist/client.js"]},"ui_mode":{"type":"string","examples":["native"]},"frontend_entry":{"type":["string","null"],"examples":["/assets/extensions/example-extension/client.js?v=100"]},"installed":{"type":"boolean","examples":[true]},"enabled":{"type":"boolean","examples":[true]},"state":{"type":"string","examples":["enabled"]},"error":{"type":["string","null"],"examples":[null]}},"required":["description","author","provider","ui_entry","frontend_entry"]},"examples":[[{"id":"example-extension","name":"Example Extension","version":"1.0.0","description":"Example extension","author":"Pterodactyl","provider":"ExampleExtension\\Provider","has_ui":true,"ui_entry":"dist/client.js","ui_mode":"native","frontend_entry":"/assets/extensions/example-extension/client.js?v=100","installed":true,"enabled":true,"state":"enabled","error":null}]]},"meta":{"type":"object","properties":{"enabled":{"type":"boolean","examples":[true]},"directory":{"type":"string","examples":["/var/www/pterodactyl/extensions"]}}}},"examples":[{"data":[{"id":"example-extension","name":"Example Extension","version":"1.0.0","description":"Example extension","author":"Pterodactyl","provider":"ExampleExtension\\Provider","has_ui":true,"ui_entry":"dist/client.js","ui_mode":"native","frontend_entry":"/assets/extensions/example-extension/client.js?v=100","installed":true,"enabled":true,"state":"enabled","error":null}],"meta":{"enabled":true,"directory":"/var/www/pterodactyl/extensions"}}]},"AdminInstallExtensionResponseBody":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","examples":["example-extension"]},"name":{"type":"string","examples":["Example Extension"]},"version":{"type":"string","examples":["1.0.0"]},"description":{"type":["string","null"],"examples":["Example extension"]},"author":{"type":["string","null"],"examples":["Pterodactyl"]},"provider":{"type":["string","null"],"examples":["ExampleExtension\\Provider"]},"has_ui":{"type":"boolean","examples":[true]},"ui_entry":{"type":["string","null"],"examples":["dist/client.js"]},"ui_mode":{"type":"string","examples":["native"]},"frontend_entry":{"type":["string","null"],"examples":["/assets/extensions/example-extension/client.js?v=100"]},"installed":{"type":"boolean","examples":[true]},"enabled":{"type":"boolean","examples":[true]},"state":{"type":"string","examples":["enabled"]},"error":{"type":["string","null"],"examples":[null]}},"required":["description","author","provider","ui_entry","frontend_entry"]}},"examples":[{"data":{"id":"example-extension","name":"Example Extension","version":"1.0.0","description":"Example extension","author":"Pterodactyl","provider":"ExampleExtension\\Provider","has_ui":true,"ui_entry":"dist/client.js","ui_mode":"native","frontend_entry":"/assets/extensions/example-extension/client.js?v=100","installed":true,"enabled":true,"state":"enabled","error":null}}]},"AdminGetExtensionSettingsResponseBody":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["registered","schema"],"properties":{"registered":{"type":"boolean","examples":[true]},"schema":{"type":"array","items":{"$ref":"#/components/schemas/AdminExtensionSettingField"}}}}}},"AdminUpdateExtensionSettingsResponseBody":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["registered","schema"],"properties":{"registered":{"type":"boolean","examples":[true]},"schema":{"type":"array","items":{"$ref":"#/components/schemas/AdminExtensionSettingField"}}}}}},"AdminEnableExtensionResponseBody":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","examples":["example-extension"]},"name":{"type":"string","examples":["Example Extension"]},"version":{"type":"string","examples":["1.0.0"]},"description":{"type":["string","null"],"examples":["Example extension"]},"author":{"type":["string","null"],"examples":["Pterodactyl"]},"provider":{"type":["string","null"],"examples":["ExampleExtension\\Provider"]},"has_ui":{"type":"boolean","examples":[true]},"ui_entry":{"type":["string","null"],"examples":["dist/client.js"]},"ui_mode":{"type":"string","examples":["native"]},"frontend_entry":{"type":["string","null"],"examples":["/assets/extensions/example-extension/client.js?v=100"]},"installed":{"type":"boolean","examples":[true]},"enabled":{"type":"boolean","examples":[true]},"state":{"type":"string","examples":["enabled"]},"error":{"type":["string","null"],"examples":[null]}},"required":["description","author","provider","ui_entry","frontend_entry"]}},"examples":[{"data":{"id":"example-extension","name":"Example Extension","version":"1.0.0","description":"Example extension","author":"Pterodactyl","provider":"ExampleExtension\\Provider","has_ui":true,"ui_entry":"dist/client.js","ui_mode":"native","frontend_entry":"/assets/extensions/example-extension/client.js?v=100","installed":true,"enabled":true,"state":"enabled","error":null}}]},"AdminDisableExtensionResponseBody":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","examples":["example-extension"]},"name":{"type":"string","examples":["Example Extension"]},"version":{"type":"string","examples":["1.0.0"]},"description":{"type":["string","null"],"examples":["Example extension"]},"author":{"type":["string","null"],"examples":["Pterodactyl"]},"provider":{"type":["string","null"],"examples":["ExampleExtension\\Provider"]},"has_ui":{"type":"boolean","examples":[true]},"ui_entry":{"type":["string","null"],"examples":["dist/client.js"]},"ui_mode":{"type":"string","examples":["native"]},"frontend_entry":{"type":["string","null"],"examples":["/assets/extensions/example-extension/client.js?v=100"]},"installed":{"type":"boolean","examples":[true]},"enabled":{"type":"boolean","examples":[true]},"state":{"type":"string","examples":["enabled"]},"error":{"type":["string","null"],"examples":[null]}},"required":["description","author","provider","ui_entry","frontend_entry"]}},"examples":[{"data":{"id":"example-extension","name":"Example Extension","version":"1.0.0","description":"Example extension","author":"Pterodactyl","provider":"ExampleExtension\\Provider","has_ui":true,"ui_entry":"dist/client.js","ui_mode":"native","frontend_entry":"/assets/extensions/example-extension/client.js?v=100","installed":true,"enabled":true,"state":"enabled","error":null}}]},"AdminListNodeAllocationIPsResponseBody":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"},"examples":[["10.0.0.8","10.0.0.9"]]}},"examples":[{"data":["10.0.0.8","10.0.0.9"]}]},"AdminListEggCatalogResponseBody":{"type":"object","properties":{"data":{"type":"array","description":"The available catalog entries.","items":{"type":"object","properties":{"id":{"type":"string","description":"The catalog identifier used to import this egg.","examples":["games-minecraft-paper"]},"name":{"type":"string","description":"The egg name.","examples":["Paper"]},"description":{"type":"string","description":"The egg description, or an empty string.","examples":["High performance Minecraft server."]},"category":{"type":"string","description":"The catalog category, or an empty string.","examples":["games"]},"source_url":{"type":"string","description":"The egg page on eggs.pterodactyl.io.","examples":["https://eggs.pterodactyl.io/egg/games-minecraft-paper"]}},"required":["id","name","description","category","source_url"]},"examples":[[{"id":"games-minecraft-paper","name":"Paper","description":"High performance Minecraft server.","category":"games","source_url":"https://eggs.pterodactyl.io/egg/games-minecraft-paper"}]]}},"required":["data"],"examples":[{"data":[{"id":"games-minecraft-paper","name":"Paper","description":"High performance Minecraft server.","category":"games","source_url":"https://eggs.pterodactyl.io/egg/games-minecraft-paper"}]}]},"AdminExportEggResponseBody":{"type":"string","description":"Raw egg export JSON document returned as a text download.","examples":["{\"_comment\":\"DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL\",\"meta\":{\"version\":\"PTDL_v2\"}}"]},"ApplicationGetNodeConfigurationResponseBody":{"type":"object","properties":{"debug":{"type":"boolean","examples":[false]},"uuid":{"type":"string","examples":["3d8dd7f9-07a1-4d65-8db0-8c8921f2f4f7"]},"token_id":{"type":"string","examples":["abcdefghijklmnop"]},"token":{"type":"string","examples":["example-node-token"]},"api":{"type":"object","properties":{"host":{"type":"string","examples":["0.0.0.0"]},"port":{"type":"integer","examples":[8080]},"ssl":{"type":"object","properties":{"enabled":{"type":"boolean","examples":[true]},"cert":{"type":"string","examples":["/etc/letsencrypt/live/node.example.com/fullchain.pem"]},"key":{"type":"string","examples":["/etc/letsencrypt/live/node.example.com/privkey.pem"]}}},"upload_limit":{"type":"integer","examples":[100]}}},"system":{"type":"object","properties":{"data":{"type":"string","examples":["/var/lib/pterodactyl/volumes"]},"sftp":{"type":"object","properties":{"bind_port":{"type":"integer","examples":[2022]}}}}},"allowed_mounts":{"type":"array","items":{"type":"string"},"examples":[["/mnt/shared"]]},"remote":{"type":"string","examples":["https://panel.example.test"]}},"examples":[{"debug":false,"uuid":"3d8dd7f9-07a1-4d65-8db0-8c8921f2f4f7","token_id":"abcdefghijklmnop","token":"example-node-token","api":{"host":"0.0.0.0","port":8080,"ssl":{"enabled":true,"cert":"/etc/letsencrypt/live/node.example.com/fullchain.pem","key":"/etc/letsencrypt/live/node.example.com/privkey.pem"},"upload_limit":100},"system":{"data":"/var/lib/pterodactyl/volumes","sftp":{"bind_port":2022}},"allowed_mounts":["/mnt/shared"],"remote":"https://panel.example.test"}]},"ClientGetWebsocketCredentialsResponseBody":{"type":"object","properties":{"data":{"type":"object","properties":{"token":{"type":"string","examples":["eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.example.signature"]},"socket":{"type":"string","examples":["wss://node.example.test/api/servers/4fcb1f44-0f90-4a1a-a8bf-7cc8a14d0f26/ws"]}}}},"examples":[{"data":{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.example.signature","socket":"wss://node.example.test/api/servers/4fcb1f44-0f90-4a1a-a8bf-7cc8a14d0f26/ws"}}]},"ClientGetFileContentsResponseBody":{"type":"string","examples":["motd=A Minecraft Server\nserver-port=25565"]},"AdminGetExtensionSettingsExtensionPathParameter":{"type":"string"},"AdminUpdateExtensionSettingsExtensionIdPathParameter":{"type":"string"},"AdminEnableExtensionExtensionPathParameter":{"type":"string"},"AdminDisableExtensionExtensionPathParameter":{"type":"string"},"AdminRemoveExtensionExtensionPathParameter":{"type":"string"},"AdminListUsersPageQueryParameter":{"type":"integer","description":"Page number to retrieve.","examples":[1]},"AdminListUsersPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminListUsersFilterEmailQueryParameter":{"type":"string","description":"Filter users by email address.","examples":["admin@example.com"]},"AdminListUsersFilterUuidQueryParameter":{"type":"string","description":"Filter users by UUID.","examples":["1b19cf3f-2f89-4f88-a81e-321e7fe326bc"]},"AdminListUsersFilterUsernameQueryParameter":{"type":"string","description":"Filter users by username.","examples":["admin"]},"AdminListUsersFilterExternalIdQueryParameter":{"type":"string","description":"Filter users by external identifier.","examples":["remote-123"]},"AdminListUsersFilterSearchQueryParameter":{"type":"string","description":"Search users by username, email, or UUID.","examples":["admin"]},"AdminListUsersSortQueryParameter":{"type":"string","description":"Sort users by id, uuid, email, username, or creation date. Prefix with a hyphen for descending order.","examples":["-created_at"]},"AdminGetUserByExternalIDExternalIdPathParameter":{"type":"string"},"AdminGetUserIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports servers.","examples":["servers"]},"AdminGetUserUserIdPathParameter":{"type":"integer"},"AdminDisableUserTwoFactorAuthenticationUserIdPathParameter":{"type":"integer"},"AdminUpdateUserIdPathParameter":{"type":"integer"},"AdminGetNodeSystemInformationNodeIdPathParameter":{"type":"integer"},"AdminCreateNodeDeployTokenNodeIdPathParameter":{"type":"integer"},"AdminGetNodeUtilizationNodeIdPathParameter":{"type":"integer"},"AdminListServerMountsServerAdminIdentifierPathParameter":{"type":"string"},"AdminDetachServerMountServerAdminIdentifierPathParameter":{"type":"string"},"AdminDetachServerMountMountIdPathParameter":{"type":"integer"},"AdminListServersFilterWildcardQueryParameter":{"type":"string","description":"Search servers by UUID, name, owner, node, allocation, or external identifier.","examples":["Survival"]},"AdminListServersFilterUuidQueryParameter":{"type":"string","description":"Filter servers by UUID.","examples":["1b19cf3f-2f89-4f88-a81e-321e7fe326bc"]},"AdminListServersFilterUuidShortQueryParameter":{"type":"string","description":"Filter servers by short UUID identifier.","examples":["1b19cf3f"]},"AdminListServersFilterNameQueryParameter":{"type":"string","description":"Filter servers by name.","examples":["Survival"]},"AdminListServersFilterExternalIdQueryParameter":{"type":"string","description":"Filter servers by external identifier.","examples":["remote-123"]},"AdminListServersFilterImageQueryParameter":{"type":"string","description":"Filter servers by Docker image.","examples":["ghcr.io/pterodactyl/yolks:java_21"]},"AdminListServersFilterNodeIdQueryParameter":{"type":"integer","description":"Filter servers by node ID.","examples":[1]},"AdminListServersFilterOwnerIdQueryParameter":{"type":"integer","description":"Filter servers by owner user ID.","examples":[1]},"AdminListServersSortQueryParameter":{"type":"string","description":"Sort servers by id, uuid, name, or creation time. Prefix with a hyphen for descending order.","examples":["-created_at"]},"AdminListServersIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports allocation, allocations, user, subusers, egg, variables, location, node, and databases.","examples":["user,node,allocation"]},"AdminListServersPageQueryParameter":{"type":"integer","description":"Page number to retrieve.","examples":[1]},"AdminListServersPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminGetServerByExternalIDExternalIdPathParameter":{"type":"string"},"AdminGetServerIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports allocation, allocations, user, subusers, egg, variables, location, node, and databases.","examples":["allocations,user,node,egg,variables"]},"AdminGetServerServerAdminIdentifierPathParameter":{"type":"string"},"AdminUpdateServerDetailsServerAdminIdentifierPathParameter":{"type":"string"},"AdminUpdateServerBuildServerAdminIdentifierPathParameter":{"type":"string"},"AdminUpdateServerStartupServerAdminIdentifierPathParameter":{"type":"string"},"AdminUpdateServerSuspensionServerAdminIdentifierPathParameter":{"type":"string"},"AdminReinstallServerServerAdminIdentifierPathParameter":{"type":"string"},"AdminRebuildServerServerAdminIdentifierPathParameter":{"type":"string"},"AdminGetServerTransferProgressServerAdminIdentifierPathParameter":{"type":"string"},"AdminTransferServerServerAdminIdentifierPathParameter":{"type":"string"},"AdminToggleServerInstallStateServerAdminIdentifierPathParameter":{"type":"string"},"AdminForceDeleteServerServerAdminIdentifierPathParameter":{"type":"string"},"AdminListServerDatabasesIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"password\".","enum":["password"],"examples":["password"]},"AdminListServerDatabasesServerAdminIdentifierPathParameter":{"type":"string"},"AdminGetServerDatabaseIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"password\".","enum":["password"],"examples":["password"]},"AdminGetServerDatabaseServerAdminIdentifierPathParameter":{"type":"string"},"AdminGetServerDatabaseDatabaseIdPathParameter":{"type":"string"},"AdminRotateServerDatabasePasswordServerAdminIdentifierPathParameter":{"type":"string"},"AdminRotateServerDatabasePasswordDatabaseIdPathParameter":{"type":"string"},"AdminListServerBackupsFilterUuidQueryParameter":{"type":"string","description":"Filter backups by UUID.","examples":["1b19cf3f-2f89-4f88-a81e-321e7fe326bc"]},"AdminListServerBackupsFilterNameQueryParameter":{"type":"string","description":"Filter backups by name.","examples":["Before Update"]},"AdminListServerBackupsSortQueryParameter":{"type":"string","description":"Sort backups by id, bytes, or created_at. Prefix with a hyphen for descending order.","examples":["-created_at"]},"AdminListServerBackupsPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[25]},"AdminListServerBackupsServerAdminIdentifierPathParameter":{"type":"string"},"AdminToggleServerBackupLockServerAdminIdentifierPathParameter":{"type":"string"},"AdminToggleServerBackupLockBackupIdPathParameter":{"type":"string"},"AdminListNodesFilterUuidQueryParameter":{"type":"string","description":"Filter nodes by UUID.","examples":["1b19cf3f-2f89-4f88-a81e-321e7fe326bc"]},"AdminListNodesFilterNameQueryParameter":{"type":"string","description":"Filter nodes by name.","examples":["node-1"]},"AdminListNodesFilterFqdnQueryParameter":{"type":"string","description":"Filter nodes by FQDN.","examples":["node.example.com"]},"AdminListNodesSortQueryParameter":{"type":"string","description":"Sort nodes by id, uuid, name, memory, disk, or creation time. Prefix with a hyphen for descending order.","examples":["-created_at"]},"AdminListNodesPageQueryParameter":{"type":"integer","description":"Page number to return.","examples":[1]},"AdminListNodesPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminListNodesIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"allocations\", \"location\", and \"servers\".","enum":["allocations","location","servers","allocations,location","location,servers"],"examples":["location"]},"AdminGetNodeIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"allocations\", \"location\", and \"servers\".","enum":["allocations","location","servers","allocations,location","location,servers"],"examples":["location"]},"AdminGetNodeNodeIdPathParameter":{"type":"integer"},"AdminGetNodeConfigurationNodeIdPathParameter":{"type":"integer"},"AdminUpdateNodeIdPathParameter":{"type":"integer"},"AdminSyncNodeGameTagsNodeIdPathParameter":{"type":"integer"},"AdminSyncNodeDeploymentTagsNodeIdPathParameter":{"type":"integer"},"AdminListNodeAllocationsFilterIpQueryParameter":{"type":"string","description":"Filter allocations by exact IP address.","examples":["192.168.1.1"]},"AdminListNodeAllocationsFilterPortQueryParameter":{"type":"integer","description":"Filter allocations by exact port.","examples":[25565]},"AdminListNodeAllocationsFilterIpAliasQueryParameter":{"type":"string","description":"Filter allocations by IP alias.","examples":["game.example.com"]},"AdminListNodeAllocationsFilterServerIdQueryParameter":{"type":"string","description":"Filter allocations by server ID, or pass an empty value to return unassigned allocations.","examples":["42"]},"AdminListNodeAllocationsSortQueryParameter":{"type":"string","description":"Sort allocations by id, ip, or port. Prefix with a hyphen for descending order.","examples":["port"]},"AdminListNodeAllocationsPageQueryParameter":{"type":"integer","description":"Page number to return.","examples":[1]},"AdminListNodeAllocationsPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminListNodeAllocationsNodeIdPathParameter":{"type":"integer"},"AdminListNodeAllocationIPsNodeIdPathParameter":{"type":"integer"},"AdminListAvailableNodeAllocationsFilterIpQueryParameter":{"type":"string","description":"Filter allocations by exact IP address.","examples":["192.168.1.1"]},"AdminListAvailableNodeAllocationsFilterPortQueryParameter":{"type":"integer","description":"Filter allocations by exact port.","examples":[25565]},"AdminListAvailableNodeAllocationsFilterIpAliasQueryParameter":{"type":"string","description":"Filter allocations by IP alias.","examples":["game.example.com"]},"AdminListAvailableNodeAllocationsSortQueryParameter":{"type":"string","description":"Sort allocations by id, ip, or port. Prefix with a hyphen for descending order.","examples":["port"]},"AdminListAvailableNodeAllocationsPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminListAvailableNodeAllocationsNodeIdPathParameter":{"type":"integer"},"AdminDeleteNodeAllocationIPBlockNodeIdPathParameter":{"type":"integer"},"AdminUpdateNodeAllocationNodeIdPathParameter":{"type":"integer"},"AdminUpdateNodeAllocationIdPathParameter":{"type":"integer"},"AdminDeleteNodeAllocationNodeIdPathParameter":{"type":"integer"},"AdminDeleteNodeAllocationAllocationIdPathParameter":{"type":"integer"},"AdminListLocationsFilterShortQueryParameter":{"type":"string","description":"Filter locations by short identifier.","examples":["us-east"]},"AdminListLocationsFilterLongQueryParameter":{"type":"string","description":"Filter locations by long description.","examples":["US East"]},"AdminListLocationsSortQueryParameter":{"type":"string","description":"Sort locations by ID, short identifier, or creation date. Prefix with a hyphen for descending order.","examples":["short"]},"AdminListLocationsPageQueryParameter":{"type":"integer","description":"Page number to return.","examples":[1]},"AdminListLocationsPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminGetLocationIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"nodes\" and \"servers\".","enum":["nodes","servers","nodes,servers"],"examples":["nodes"]},"AdminGetLocationLocationIdPathParameter":{"type":"integer"},"AdminListEligibleLocationNodesLocationIdPathParameter":{"type":"integer"},"AdminUpdateLocationIdPathParameter":{"type":"integer"},"AdminListMountsFilterNameQueryParameter":{"type":"string","description":"Filter mounts by name.","examples":["Shared Mods"]},"AdminListMountsSortQueryParameter":{"type":"string","description":"Sort mounts by id or name. Prefix with a hyphen for descending order.","examples":["name"]},"AdminListMountsPageQueryParameter":{"type":"integer","description":"Page number to return.","examples":[1]},"AdminListMountsPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminListMountsIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"eggs\", \"nodes\", and \"servers\".","enum":["eggs","nodes","servers","eggs,nodes","eggs,nodes,servers"],"examples":["eggs,nodes"]},"AdminGetMountIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"eggs\", \"nodes\", and \"servers\".","enum":["eggs","nodes","servers","eggs,nodes","eggs,nodes,servers"],"examples":["eggs,nodes"]},"AdminGetMountMountIdPathParameter":{"type":"integer"},"AdminUpdateMountIdPathParameter":{"type":"integer"},"AdminAttachEggsToMountIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"eggs\", \"nodes\", and \"servers\".","enum":["eggs","nodes","servers","eggs,nodes","eggs,nodes,servers"],"examples":["eggs,nodes"]},"AdminAttachEggsToMountMountIdPathParameter":{"type":"integer"},"AdminDetachEggFromMountMountIdPathParameter":{"type":"integer"},"AdminDetachEggFromMountEggIdPathParameter":{"type":"integer"},"AdminAttachNodesToMountIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"eggs\", \"nodes\", and \"servers\".","enum":["eggs","nodes","servers","eggs,nodes","eggs,nodes,servers"],"examples":["eggs,nodes"]},"AdminAttachNodesToMountMountIdPathParameter":{"type":"integer"},"AdminDetachNodeFromMountMountIdPathParameter":{"type":"integer"},"AdminDetachNodeFromMountNodeIdPathParameter":{"type":"integer"},"AdminListEggVariablesIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Unknown includes are ignored.","examples":["egg"]},"AdminListEggVariablesEggIdPathParameter":{"type":"integer"},"AdminReorderEggVariablesEggIdPathParameter":{"type":"integer"},"AdminUpdateEggVariableEggIdPathParameter":{"type":"integer"},"AdminUpdateEggVariableIdPathParameter":{"type":"integer"},"AdminDeleteEggVariableEggIdPathParameter":{"type":"integer"},"AdminDeleteEggVariableVariableIdPathParameter":{"type":"integer"},"AdminGetEggInstallScriptEggIdPathParameter":{"type":"integer"},"AdminExportEggEggIdPathParameter":{"type":"integer"},"AdminUpdateEggFromImportEggIdPathParameter":{"type":"integer"},"AdminSyncEggTagsEggIdPathParameter":{"type":"integer"},"AdminListEggsFilterNameQueryParameter":{"type":"string","description":"Filter eggs by name.","examples":["Paper"]},"AdminListEggsSortQueryParameter":{"type":"string","description":"Sort eggs by id or name. Prefix with a hyphen for descending order.","examples":["name"]},"AdminListEggsPageQueryParameter":{"type":"integer","description":"Page number to return.","examples":[1]},"AdminListEggsPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminListEggsIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include: variables, tags, servers.","enum":["variables","tags","servers","variables,tags","variables,servers","tags,servers","variables,tags,servers"],"examples":["variables"]},"AdminGetEggIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include: variables, tags, servers.","enum":["variables","tags","servers","variables,tags","variables,servers","tags,servers","variables,tags,servers"],"examples":["variables,tags"]},"AdminGetEggEggIdPathParameter":{"type":"integer"},"AdminUpdateEggIdPathParameter":{"type":"integer"},"AdminListTagsFilterNameQueryParameter":{"type":"string","description":"Filter tags by name.","examples":["Minecraft"]},"AdminListTagsFilterSlugQueryParameter":{"type":"string","description":"Filter tags by slug.","examples":["minecraft"]},"AdminListTagsSortQueryParameter":{"type":"string","description":"Sort tags by id, name, or slug. Prefix with a hyphen for descending order.","examples":["name"]},"AdminListTagsPageQueryParameter":{"type":"integer","description":"Page number to return.","examples":[1]},"AdminListTagsPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminListTagsIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"eggs\" and \"nodes\".","enum":["eggs","nodes","eggs,nodes"],"examples":["eggs"]},"AdminGetTagIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"eggs\" and \"nodes\".","enum":["eggs","nodes","eggs,nodes"],"examples":["eggs"]},"AdminGetTagTagIdPathParameter":{"type":"integer"},"AdminUpdateTagIdPathParameter":{"type":"integer"},"AdminListDatabaseHostsPageQueryParameter":{"type":"integer","description":"Page number to retrieve.","examples":[1]},"AdminListDatabaseHostsPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminListDatabaseHostsFilterNameQueryParameter":{"type":"string","description":"Filter hosts by name.","examples":["Primary"]},"AdminListDatabaseHostsFilterHostQueryParameter":{"type":"string","description":"Filter hosts by address or hostname.","examples":["127.0.0.1"]},"AdminListDatabaseHostsSortQueryParameter":{"type":"string","description":"Sort hosts by ID, name, or creation date. Prefix with a hyphen for descending order.","examples":["-created_at"]},"AdminListDatabaseHostsIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports node and databases.","examples":["node"]},"AdminGetDatabaseHostIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports node and databases.","examples":["node"]},"AdminGetDatabaseHostDatabaseHostIdPathParameter":{"type":"string"},"AdminListDatabaseHostDatabasesPageQueryParameter":{"type":"integer","description":"Page number to retrieve.","examples":[1]},"AdminListDatabaseHostDatabasesPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminListDatabaseHostDatabasesDatabaseHostIdPathParameter":{"type":"string"},"AdminListAPIKeysFilterMemoQueryParameter":{"type":"string","description":"Filter keys by memo.","examples":["Automation"]},"AdminListAPIKeysFilterIdentifierQueryParameter":{"type":"string","description":"Filter keys by identifier.","examples":["ptla_1234567890abc"]},"AdminListAPIKeysSortQueryParameter":{"type":"string","description":"Sort keys by ID, memo, or creation date. Prefix with a hyphen for descending order.","examples":["-created_at"]},"AdminListAPIKeysPageQueryParameter":{"type":"integer","description":"Page number to retrieve.","examples":[1]},"AdminListAPIKeysPerPageQueryParameter":{"type":"integer","description":"Results to return per page.","examples":[50]},"AdminGetAPIKeyIdentifierPathParameter":{"type":"string"},"ApplicationListUsersPerPageQueryParameter":{"type":"integer","description":"Number of users to return per page, up to 100.","examples":[50]},"ApplicationListUsersFilterEmailQueryParameter":{"type":"string","description":"Filter users by email address.","examples":["user@example.com"]},"ApplicationListUsersFilterUuidQueryParameter":{"type":"string","description":"Filter users by UUID.","examples":["0d1f6f4d-9f78-4cf9-9d5a-6f7f4c9f4d6a"]},"ApplicationListUsersFilterUsernameQueryParameter":{"type":"string","description":"Filter users by username.","examples":["example-user"]},"ApplicationListUsersFilterExternalIdQueryParameter":{"type":"string","description":"Filter users by external identifier.","examples":["billing-system-42"]},"ApplicationListUsersSortQueryParameter":{"type":"string","description":"Sort users by id or uuid. Prefix with \"-\" for descending order.","enum":["id","-id","uuid","-uuid"],"examples":["-id"]},"ApplicationListUsersIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"servers\" when the key can read servers.","enum":["servers"],"examples":["servers"]},"ApplicationGetUserIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"servers\" when the key can read servers.","enum":["servers"],"examples":["servers"]},"ApplicationGetUserUserIdPathParameter":{"type":"integer"},"ApplicationGetUserByExternalIDExternalIdPathParameter":{"type":"string"},"ApplicationListNodesPerPageQueryParameter":{"type":"integer","description":"Number of nodes to return per page, up to 100.","examples":[50]},"ApplicationListNodesFilterUuidQueryParameter":{"type":"string","description":"Filter nodes by UUID.","examples":["3d8dd7f9-07a1-4d65-8db0-8c8921f2f4f7"]},"ApplicationListNodesFilterNameQueryParameter":{"type":"string","description":"Filter nodes by name.","examples":["Node 1"]},"ApplicationListNodesFilterFqdnQueryParameter":{"type":"string","description":"Filter nodes by fully qualified domain name.","examples":["node.example.com"]},"ApplicationListNodesFilterDaemonTokenIdQueryParameter":{"type":"string","description":"Filter nodes by daemon token identifier.","examples":["abcdefghijklmnop"]},"ApplicationListNodesSortQueryParameter":{"type":"string","description":"Sort nodes by id, uuid, memory, or disk. Prefix with \"-\" for descending order.","enum":["id","-id","uuid","-uuid","memory","-memory","disk","-disk"],"examples":["-id"]},"ApplicationListNodesIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"allocations\", \"location\", and \"servers\" when the key can read those resources.","enum":["allocations","location","servers","location,allocations"],"examples":["location,allocations"]},"ApplicationListDeployableNodesMemoryQueryParameter":{"type":"integer","description":"Memory required for the deployment, in megabytes.","examples":[1024]},"ApplicationListDeployableNodesDiskQueryParameter":{"type":"integer","description":"Disk required for the deployment, in megabytes.","examples":[10240]},"ApplicationListDeployableNodesLocationIdsQueryParameter":{"type":"array","description":"Restrict results to these location IDs.","items":{"type":"integer"},"examples":[[1,2]]},"ApplicationListDeployableNodesPageQueryParameter":{"type":"integer","description":"Page number to return. When omitted, all viable nodes are returned without pagination metadata.","examples":[1]},"ApplicationListDeployableNodesPerPageQueryParameter":{"type":"integer","description":"Number of nodes to return per page when page is supplied, up to 100.","examples":[50]},"ApplicationGetNodeIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"allocations\", \"location\", and \"servers\" when the key can read those resources.","enum":["allocations","location","servers","location,allocations"],"examples":["location,allocations"]},"ApplicationGetNodeNodeIdPathParameter":{"type":"integer"},"ApplicationGetNodeConfigurationNodeIdPathParameter":{"type":"integer"},"ApplicationUpdateNodeIdPathParameter":{"type":"integer"},"ApplicationListNodeAllocationsPerPageQueryParameter":{"type":"integer","description":"Number of allocations to return per page, up to 100.","examples":[50]},"ApplicationListNodeAllocationsFilterIpQueryParameter":{"type":"string","description":"Filter allocations by exact IP address.","examples":["192.0.2.10"]},"ApplicationListNodeAllocationsFilterPortQueryParameter":{"type":"integer","description":"Filter allocations by exact port.","examples":[25565]},"ApplicationListNodeAllocationsFilterIpAliasQueryParameter":{"type":"string","description":"Filter allocations by IP alias.","examples":["minecraft.example.com"]},"ApplicationListNodeAllocationsFilterServerIdQueryParameter":{"type":"string","description":"Filter allocations by assigned server ID. Empty or non-numeric values return unassigned allocations.","examples":["1"]},"ApplicationListNodeAllocationsIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"node\" and \"server\" when the key can read those resources.","enum":["node","server","node,server"],"examples":["server"]},"ApplicationListNodeAllocationsNodeIdPathParameter":{"type":"integer"},"ApplicationDeleteNodeAllocationNodeIdPathParameter":{"type":"integer"},"ApplicationDeleteNodeAllocationAllocationIdPathParameter":{"type":"integer"},"ApplicationListLocationsPerPageQueryParameter":{"type":"integer","description":"Number of locations to return per page, up to 100.","examples":[50]},"ApplicationListLocationsFilterShortQueryParameter":{"type":"string","description":"Filter locations by short identifier.","examples":["us-east"]},"ApplicationListLocationsFilterLongQueryParameter":{"type":"string","description":"Filter locations by description.","examples":["US East Datacenter"]},"ApplicationListLocationsSortQueryParameter":{"type":"string","description":"Sort locations by id. Prefix with \"-\" for descending order.","enum":["id","-id"],"examples":["id"]},"ApplicationListLocationsIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"nodes\" and \"servers\" when the key can read those resources.","enum":["nodes","servers","nodes,servers"],"examples":["nodes,servers"]},"ApplicationGetLocationIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"nodes\" and \"servers\" when the key can read those resources.","enum":["nodes","servers","nodes,servers"],"examples":["nodes,servers"]},"ApplicationGetLocationLocationIdPathParameter":{"type":"integer"},"ApplicationListEggsPerPageQueryParameter":{"type":"integer","description":"Number of eggs to return per page, up to 100.","examples":[50]},"ApplicationListEggsFilterNameQueryParameter":{"type":"string","description":"Filter eggs by name.","examples":["Paper"]},"ApplicationListEggsFilterTagQueryParameter":{"type":"string","description":"Filter eggs by tag slug. Separate several slugs with commas to return eggs that carry any of them.","examples":["minecraft"]},"ApplicationListEggsSortQueryParameter":{"type":"string","description":"Sort eggs by id or name. Prefix with \"-\" for descending order.","enum":["id","-id","name","-name"],"examples":["name"]},"ApplicationListEggsIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"servers\", \"config\", \"script\", \"variables\", and \"tags\" when the key can read those resources.","enum":["servers","config","script","variables","tags"],"examples":["variables"]},"ApplicationGetEggIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"servers\", \"config\", \"script\", \"variables\", and \"tags\" when the key can read those resources.","enum":["servers","config","script","variables","tags"],"examples":["variables"]},"ApplicationGetEggEggIdPathParameter":{"type":"integer"},"ApplicationListTagsPerPageQueryParameter":{"type":"integer","description":"Number of tags to return per page, up to 100.","examples":[50]},"ApplicationListTagsFilterNameQueryParameter":{"type":"string","description":"Filter tags by name.","examples":["Minecraft"]},"ApplicationListTagsFilterSlugQueryParameter":{"type":"string","description":"Filter tags by slug.","examples":["minecraft"]},"ApplicationListTagsSortQueryParameter":{"type":"string","description":"Sort tags by id, name, or slug. Prefix with \"-\" for descending order.","enum":["id","-id","name","-name","slug","-slug"],"examples":["name"]},"ApplicationListTagsIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"eggs\" and \"nodes\" when the key can read those resources.","enum":["eggs","nodes","eggs,nodes"],"examples":["eggs"]},"ApplicationGetTagIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"eggs\" and \"nodes\" when the key can read those resources.","enum":["eggs","nodes","eggs,nodes"],"examples":["eggs"]},"ApplicationGetTagTagIdPathParameter":{"type":"integer"},"ApplicationListServersPerPageQueryParameter":{"type":"integer","description":"Number of servers to return per page, up to 100.","examples":[50]},"ApplicationListServersFilterUuidQueryParameter":{"type":"string","description":"Filter servers by UUID.","examples":["4fcb1f44-0f90-4a1a-a8bf-7cc8a14d0f26"]},"ApplicationListServersFilterUuidShortQueryParameter":{"type":"string","description":"Filter servers by short UUID identifier.","examples":["4fcb1f44"]},"ApplicationListServersFilterNameQueryParameter":{"type":"string","description":"Filter servers by name.","examples":["Minecraft Server"]},"ApplicationListServersFilterDescriptionQueryParameter":{"type":"string","description":"Filter servers by description.","examples":["Production"]},"ApplicationListServersFilterImageQueryParameter":{"type":"string","description":"Filter servers by Docker image.","examples":["ghcr.io/pterodactyl/yolks:java_23"]},"ApplicationListServersFilterExternalIdQueryParameter":{"type":"string","description":"Filter servers by external identifier.","examples":["billing-server-42"]},"ApplicationListServersSearchQueryParameter":{"type":"string","description":"Search term accepted by the list request. Must not exceed 100 characters.","examples":["minecraft"]},"ApplicationListServersSortQueryParameter":{"type":"string","description":"Sort servers by id or uuid. Prefix with \"-\" for descending order.","enum":["id","-id","uuid","-uuid"],"examples":["-id"]},"ApplicationListServersIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"allocations\", \"user\", \"subusers\", \"egg\", \"variables\", \"location\", \"node\", \"databases\", and \"transfer\" when the key can read those resources.","examples":["user,node,allocations"]},"ApplicationGetServerIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"allocations\", \"user\", \"subusers\", \"egg\", \"variables\", \"location\", \"node\", \"databases\", and \"transfer\" when the key can read those resources.","examples":["user,node,allocations"]},"ApplicationGetServerServerIdPathParameter":{"type":"integer"},"ApplicationGetServerByExternalIDExternalIdPathParameter":{"type":"string"},"ApplicationUpdateServerDetailsServerIdPathParameter":{"type":"integer"},"ApplicationUpdateServerBuildServerIdPathParameter":{"type":"integer"},"ApplicationUpdateServerStartupServerIdPathParameter":{"type":"integer"},"ApplicationSuspendServerServerIdPathParameter":{"type":"integer"},"ApplicationUnsuspendServerServerIdPathParameter":{"type":"integer"},"ApplicationReinstallServerServerIdPathParameter":{"type":"integer"},"ApplicationDeleteServerServerIdPathParameter":{"type":"integer"},"ApplicationDeleteServerForcePathParameter":{"type":"string"},"ApplicationListServerDatabasesIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"password\" and \"host\" when the key can read database hosts.","enum":["password","host","password,host"],"examples":["password,host"]},"ApplicationListServerDatabasesServerIdPathParameter":{"type":"integer"},"ApplicationGetServerDatabaseIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"password\" and \"host\" when the key can read database hosts.","enum":["password","host","password,host"],"examples":["password,host"]},"ApplicationGetServerDatabaseServerIdPathParameter":{"type":"integer"},"ApplicationGetServerDatabaseDatabaseIdPathParameter":{"type":"string"},"ApplicationResetServerDatabasePasswordServerIdPathParameter":{"type":"integer"},"ApplicationResetServerDatabasePasswordDatabaseIdPathParameter":{"type":"string"},"ClientListClientServersPageQueryParameter":{"type":"integer","description":"Page number to return.","examples":[1]},"ClientListClientServersPerPageQueryParameter":{"type":"integer","description":"Number of servers to return per page. The maximum is 100.","examples":[50]},"ClientListClientServersTypeQueryParameter":{"type":"string","description":"Scope of servers to return. \"owner\" returns owned servers, \"admin\" returns admin-accessible servers excluding owned or subuser servers, and \"admin-all\" returns all servers for root administrators.","enum":["owner","admin","admin-all"],"examples":["owner"]},"ClientListClientServersFilterUuidQueryParameter":{"type":"string","description":"Filter servers by UUID.","examples":["4fcb1f44-0f90-4a1a-a8bf-7cc8a14d0f26"]},"ClientListClientServersFilterNameQueryParameter":{"type":"string","description":"Filter servers by name.","examples":["Minecraft Server"]},"ClientListClientServersFilterDescriptionQueryParameter":{"type":"string","description":"Filter servers by description.","examples":["Production"]},"ClientListClientServersFilterExternalIdQueryParameter":{"type":"string","description":"Filter servers by external identifier.","examples":["billing-server-42"]},"ClientListClientServersFilterWildcardQueryParameter":{"type":"string","description":"Search across server name, UUID, short UUID, external identifier, or allocation address and port.","examples":["192.0.2.10:25565"]},"ClientListAccountActivityPageQueryParameter":{"type":"integer","description":"Page number to retrieve.","examples":[1]},"ClientListAccountActivityPerPageQueryParameter":{"type":"integer","description":"Number of activity log entries to return per page. The maximum is 100.","examples":[25]},"ClientListAccountActivityFilterEventQueryParameter":{"type":"string","description":"Filter activity by event name.","examples":["user:account.email-changed"]},"ClientListAccountActivitySortQueryParameter":{"type":"string","description":"Sort activity by timestamp. Prefix with \"-\" for descending order.","enum":["timestamp","-timestamp"],"examples":["-timestamp"]},"ClientListAccountActivityIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports actor.","examples":["actor"]},"ClientDeleteAccountAPIKeyIdentifierPathParameter":{"type":"string"},"ClientGetServerServerUuidPathParameter":{"type":"string"},"ClientGetWebsocketCredentialsServerUuidPathParameter":{"type":"string"},"ClientGetServerResourcesServerUuidPathParameter":{"type":"string"},"ClientListServerActivityPageQueryParameter":{"type":"integer","description":"Page number to retrieve.","examples":[1]},"ClientListServerActivityPerPageQueryParameter":{"type":"integer","description":"Number of activity log entries to return per page. The maximum is 100.","examples":[25]},"ClientListServerActivityFilterEventQueryParameter":{"type":"string","description":"Filter activity by event name.","examples":["server:power.start"]},"ClientListServerActivitySortQueryParameter":{"type":"string","description":"Sort activity by timestamp. Prefix with \"-\" for descending order.","enum":["timestamp","-timestamp"],"examples":["-timestamp"]},"ClientListServerActivityIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports actor.","examples":["actor"]},"ClientListServerActivityServerUuidPathParameter":{"type":"string"},"ClientSendServerCommandServerUuidPathParameter":{"type":"string"},"ClientSendPowerActionServerUuidPathParameter":{"type":"string"},"ClientListServerDatabasesIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"password\" when the user can view database passwords.","enum":["password"],"examples":["password"]},"ClientCreateServerDatabaseIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"password\" when the user can view database passwords.","enum":["password"],"examples":["password"]},"ClientListServerDatabasesServerUuidPathParameter":{"type":"string"},"ClientRotateServerDatabasePasswordIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports \"password\" when the user can view database passwords.","enum":["password"],"examples":["password"]},"ClientRotateServerDatabasePasswordServerUuidPathParameter":{"type":"string"},"ClientRotateServerDatabasePasswordDatabaseIdPathParameter":{"type":"string"},"ClientDeleteServerDatabaseServerUuidPathParameter":{"type":"string"},"ClientDeleteServerDatabaseDatabaseIdPathParameter":{"type":"string"},"ClientListFilesDirectoryQueryParameter":{"type":["string","null"],"description":"Directory to list. Defaults to the server root.","examples":["/config"]},"ClientListFilesServerUuidPathParameter":{"type":"string"},"ClientGetFileContentsFileQueryParameter":{"type":"string","description":"Path to the file to read.","examples":["/server.properties"]},"ClientGetFileContentsServerUuidPathParameter":{"type":"string"},"ClientGetFileDownloadURLFileQueryParameter":{"type":"string","description":"Path to the file to download.","examples":["/server.properties"]},"ClientGetFileDownloadURLServerUuidPathParameter":{"type":"string"},"ClientRenameFilesServerUuidPathParameter":{"type":"string"},"ClientCopyFileServerUuidPathParameter":{"type":"string"},"ClientWriteFileContentsFileQueryParameter":{"type":"string","description":"Path to the file to write.","examples":["/server.properties"]},"ClientWriteFileContentsServerUuidPathParameter":{"type":"string"},"ClientCompressFilesServerUuidPathParameter":{"type":"string"},"ClientDecompressFileServerUuidPathParameter":{"type":"string"},"ClientDeleteFilesServerUuidPathParameter":{"type":"string"},"ClientCreateFolderServerUuidPathParameter":{"type":"string"},"ClientChangeFilePermissionsServerUuidPathParameter":{"type":"string"},"ClientPullRemoteFileServerUuidPathParameter":{"type":"string"},"ClientGetFileUploadURLServerUuidPathParameter":{"type":"string"},"ClientListServerSchedulesIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports tasks.","examples":["tasks"]},"ClientListServerSchedulesServerUuidPathParameter":{"type":"string"},"ClientGetServerScheduleIncludeQueryParameter":{"type":"string","description":"Comma-separated relationships to include. Supports tasks.","examples":["tasks"]},"ClientGetServerScheduleServerUuidPathParameter":{"type":"string"},"ClientGetServerScheduleScheduleIdPathParameter":{"type":"integer"},"ClientExecuteServerScheduleServerUuidPathParameter":{"type":"string"},"ClientExecuteServerScheduleScheduleIdPathParameter":{"type":"integer"},"ClientCreateScheduleTaskServerUuidPathParameter":{"type":"string"},"ClientCreateScheduleTaskScheduleIdPathParameter":{"type":"integer"},"ClientUpdateScheduleTaskServerUuidPathParameter":{"type":"string"},"ClientUpdateScheduleTaskScheduleIdPathParameter":{"type":"integer"},"ClientUpdateScheduleTaskTaskIdPathParameter":{"type":"integer"},"ClientListServerAllocationsServerUuidPathParameter":{"type":"string"},"ClientUpdateAllocationNotesServerUuidPathParameter":{"type":"string"},"ClientUpdateAllocationNotesAllocationIdPathParameter":{"type":"integer"},"ClientSetPrimaryAllocationServerUuidPathParameter":{"type":"string"},"ClientSetPrimaryAllocationAllocationIdPathParameter":{"type":"integer"},"ClientListServerSubusersServerUuidPathParameter":{"type":"string"},"ClientGetServerSubuserServerPathParameter":{"type":"string"},"ClientGetServerSubuserUserPathParameter":{"type":"string"},"ClientUpdateServerSubuserServerUuidPathParameter":{"type":"string"},"ClientUpdateServerSubuserUserPathParameter":{"type":"string"},"ClientListServerBackupsPageQueryParameter":{"type":"integer","description":"The page number to return.","examples":[1]},"ClientListServerBackupsPerPageQueryParameter":{"type":"integer","description":"Number of backups to return per page. The maximum is 50.","examples":[20]},"ClientListServerBackupsServerUuidPathParameter":{"type":"string"},"ClientGetServerBackupServerUuidPathParameter":{"type":"string"},"ClientGetServerBackupBackupUuidPathParameter":{"type":"string"},"ClientGetBackupDownloadURLServerUuidPathParameter":{"type":"string"},"ClientGetBackupDownloadURLBackupUuidPathParameter":{"type":"string"},"ClientToggleBackupLockServerUuidPathParameter":{"type":"string"},"ClientToggleBackupLockBackupUuidPathParameter":{"type":"string"},"ClientRestoreServerBackupServerUuidPathParameter":{"type":"string"},"ClientRestoreServerBackupBackupUuidPathParameter":{"type":"string"},"ClientGetStartupConfigurationServerUuidPathParameter":{"type":"string"},"ClientUpdateStartupVariableServerUuidPathParameter":{"type":"string"},"ClientRenameServerServerUuidPathParameter":{"type":"string"},"ClientReinstallServerServerUuidPathParameter":{"type":"string"},"ClientSetServerDockerImageServerUuidPathParameter":{"type":"string"}}},"security":[{"default":[]}],"paths":{"/api/admin/languages":{"get":{"summary":"List languages","operationId":"adminListLanguages","description":"Returns the languages available for panel locale selectors.","parameters":[],"responses":{"200":{"description":"Available languages returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLanguagesResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]}},"/api/admin/extensions":{"get":{"summary":"List extensions","operationId":"adminListExtensions","description":"Returns discovered extensions, invalid manifests, and their install state.","parameters":[],"responses":{"200":{"description":"Extensions returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListExtensionsResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Install extension","operationId":"adminInstallExtension","description":"Installs an uploaded .pteroext or .zip extension package.","parameters":[],"responses":{"201":{"description":"Extension installed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminInstallExtensionResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AdminInstallExtensionRequest"}}}}}},"/api/admin/extensions/{extension}/settings":{"get":{"summary":"Get extension settings","operationId":"adminGetExtensionSettings","description":"Returns the auto-render form schema (with current public values) for an extension that registered a settings definition.","parameters":[],"responses":{"200":{"description":"Settings schema returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminGetExtensionSettingsResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"extension","description":"The extension.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetExtensionSettingsExtensionPathParameter"},"examples":{"default":{"value":"architecto"}}}]},"/api/admin/extensions/{extension_id}/settings":{"patch":{"summary":"Update extension settings","operationId":"adminUpdateExtensionSettings","description":"Validates against the extension's declared rules and persists the submitted values. Omitted fields keep their stored values.","parameters":[],"responses":{"200":{"description":"Settings updated; fresh schema returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateExtensionSettingsResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateExtensionSettingsRequest"}}}}},"parameters":[{"in":"path","name":"extension_id","description":"The ID of the extension.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateExtensionSettingsExtensionIdPathParameter"},"examples":{"default":{"value":"architecto"}}}]},"/api/admin/extensions/{extension}/enable":{"post":{"summary":"Enable extension","operationId":"adminEnableExtension","description":"Enables an installed extension, publishes assets, and runs migrations.","parameters":[],"responses":{"200":{"description":"Extension enabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEnableExtensionResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"extension","description":"The extension.","required":true,"schema":{"$ref":"#/components/schemas/AdminEnableExtensionExtensionPathParameter"},"examples":{"default":{"value":"architecto"}}}]},"/api/admin/extensions/{extension}/disable":{"post":{"summary":"Disable extension","operationId":"adminDisableExtension","description":"Disables an installed extension without removing files or data.","parameters":[],"responses":{"200":{"description":"Extension disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminDisableExtensionResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"extension","description":"The extension.","required":true,"schema":{"$ref":"#/components/schemas/AdminDisableExtensionExtensionPathParameter"},"examples":{"default":{"value":"architecto"}}}]},"/api/admin/extensions/{extension}":{"delete":{"summary":"Remove extension","operationId":"adminRemoveExtension","description":"Deletes extension files, published assets, and the install record.","parameters":[],"responses":{"204":{"description":"Extension removed."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"extension","description":"The extension.","required":true,"schema":{"$ref":"#/components/schemas/AdminRemoveExtensionExtensionPathParameter"},"examples":{"default":{"value":"architecto"}}}]},"/api/admin/users":{"get":{"summary":"List users","operationId":"adminListUsers","description":"Returns a paginated list of panel users, sorted with root administrators first by default.","parameters":[{"in":"query","name":"page","description":"Page number to retrieve.","required":false,"schema":{"$ref":"#/components/schemas/AdminListUsersPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":false,"schema":{"$ref":"#/components/schemas/AdminListUsersPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"filter[email]","description":"Filter users by email address.","required":false,"schema":{"$ref":"#/components/schemas/AdminListUsersFilterEmailQueryParameter"},"examples":{"default":{"value":"admin@example.com"}}},{"in":"query","name":"filter[uuid]","description":"Filter users by UUID.","required":false,"schema":{"$ref":"#/components/schemas/AdminListUsersFilterUuidQueryParameter"},"examples":{"default":{"value":"1b19cf3f-2f89-4f88-a81e-321e7fe326bc"}}},{"in":"query","name":"filter[username]","description":"Filter users by username.","required":false,"schema":{"$ref":"#/components/schemas/AdminListUsersFilterUsernameQueryParameter"},"examples":{"default":{"value":"admin"}}},{"in":"query","name":"filter[external_id]","description":"Filter users by external identifier.","required":false,"schema":{"$ref":"#/components/schemas/AdminListUsersFilterExternalIdQueryParameter"},"examples":{"default":{"value":"remote-123"}}},{"in":"query","name":"filter[search]","description":"Search users by username, email, or UUID.","required":false,"schema":{"$ref":"#/components/schemas/AdminListUsersFilterSearchQueryParameter"},"examples":{"default":{"value":"admin"}}},{"in":"query","name":"sort","description":"Sort users by id, uuid, email, username, or creation date. Prefix with a hyphen for descending order.","required":false,"schema":{"$ref":"#/components/schemas/AdminListUsersSortQueryParameter"},"examples":{"default":{"value":"-created_at"}}}],"responses":{"200":{"description":"Users returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUserPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create user","operationId":"adminCreateUser","description":"Creates a panel user. Optional password and language fields may be supplied explicitly.","parameters":[],"responses":{"201":{"description":"User created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUserResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateUserRequest"}}}}}},"/api/admin/users/external/{external_id}":{"get":{"summary":"Get user by external ID","operationId":"adminGetUserByExternalID","description":"Returns a single panel user by external identifier.","parameters":[],"responses":{"200":{"description":"User returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUserResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"external_id","description":"The external ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetUserByExternalIDExternalIdPathParameter"},"examples":{"default":{"value":"external-identifier"}}}]},"/api/admin/users/{user_id}":{"get":{"summary":"Get user","operationId":"adminGetUser","description":"Returns a single panel user by internal numeric ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports servers.","required":false,"schema":{"$ref":"#/components/schemas/AdminGetUserIncludeQueryParameter"},"examples":{"default":{"value":"servers"}}}],"responses":{"200":{"description":"User returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUserResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"delete":{"summary":"Delete user","operationId":"adminDeleteUser","description":"Deletes a panel user. The authenticated administrator cannot delete their own account.","parameters":[],"responses":{"204":{"description":"User deleted."},"400":{"description":"The authenticated administrator attempted to delete their own user account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"user_id","description":"The user ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetUserUserIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/users/{user_id}/disable-2fa":{"post":{"summary":"Disable user two-factor authentication","operationId":"adminDisableUserTwoFactorAuthentication","description":"Clears the configured TOTP secret and disables two-factor authentication for a user.","parameters":[],"responses":{"204":{"description":"Two-factor authentication disabled."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"user_id","description":"The user ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminDisableUserTwoFactorAuthenticationUserIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/users/{id}":{"put":{"summary":"Update user","operationId":"adminUpdateUser","description":"Updates an existing panel user. Supplying a password changes the user password.","parameters":[],"responses":{"200":{"description":"User updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUserResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateUserRequest"}}}}},"parameters":[{"in":"path","name":"id","description":"The resource ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateUserIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/system-information":{"get":{"summary":"Get node system information","operationId":"adminGetNodeSystemInformation","description":"Proxies Wings system information for a node.","parameters":[],"responses":{"200":{"description":"System information returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminNodeSystemInformationResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"The panel could not connect to Wings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetNodeSystemInformationNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/deploy-token":{"post":{"summary":"Create node deploy token","operationId":"adminCreateNodeDeployToken","description":"Creates or reuses an application API key that can deploy the specified node.","parameters":[],"responses":{"200":{"description":"Deploy token returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminNodeDeployTokenResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminCreateNodeDeployTokenNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/utilization":{"get":{"summary":"Get node utilization","operationId":"adminGetNodeUtilization","description":"Returns aggregate resource utilization for a node.","parameters":[],"responses":{"200":{"description":"Utilization returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminNodeUtilizationResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetNodeUtilizationNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/servers/{server_admin_identifier}/mounts":{"get":{"summary":"List server mounts","operationId":"adminListServerMounts","description":"Returns mount definitions that are eligible for a server, including whether each mount is attached.","parameters":[],"responses":{"200":{"description":"Eligible server mounts returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminMountListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The server is not installed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Attach server mount","operationId":"adminAttachServerMount","description":"Attaches an eligible mount definition to a server.","parameters":[],"responses":{"204":{"description":"Mount attached."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The server is not installed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAttachServerMountRequest"}}}}},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminListServerMountsServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/mounts/{mount_id}":{"delete":{"summary":"Detach server mount","operationId":"adminDetachServerMount","description":"Detaches a mount definition from a server.","parameters":[],"responses":{"204":{"description":"Mount detached."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The server is not installed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminDetachServerMountServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}},{"in":"path","name":"mount_id","description":"The mount ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminDetachServerMountMountIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/servers":{"get":{"summary":"List servers","operationId":"adminListServers","description":"Returns a paginated list of servers.","parameters":[{"in":"query","name":"filter[*]","description":"Search servers by UUID, name, owner, node, allocation, or external identifier.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersFilterWildcardQueryParameter"},"examples":{"default":{"value":"Survival"}}},{"in":"query","name":"filter[uuid]","description":"Filter servers by UUID.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersFilterUuidQueryParameter"},"examples":{"default":{"value":"1b19cf3f-2f89-4f88-a81e-321e7fe326bc"}}},{"in":"query","name":"filter[uuidShort]","description":"Filter servers by short UUID identifier.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersFilterUuidShortQueryParameter"},"examples":{"default":{"value":"1b19cf3f"}}},{"in":"query","name":"filter[name]","description":"Filter servers by name.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersFilterNameQueryParameter"},"examples":{"default":{"value":"Survival"}}},{"in":"query","name":"filter[external_id]","description":"Filter servers by external identifier.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersFilterExternalIdQueryParameter"},"examples":{"default":{"value":"remote-123"}}},{"in":"query","name":"filter[image]","description":"Filter servers by Docker image.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersFilterImageQueryParameter"},"examples":{"default":{"value":"ghcr.io/pterodactyl/yolks:java_21"}}},{"in":"query","name":"filter[node_id]","description":"Filter servers by node ID.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersFilterNodeIdQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"filter[owner_id]","description":"Filter servers by owner user ID.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersFilterOwnerIdQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"sort","description":"Sort servers by id, uuid, name, or creation time. Prefix with a hyphen for descending order.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersSortQueryParameter"},"examples":{"default":{"value":"-created_at"}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports allocation, allocations, user, subusers, egg, variables, location, node, and databases.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersIncludeQueryParameter"},"examples":{"default":{"value":"user,node,allocation"}}},{"in":"query","name":"page","description":"Page number to retrieve.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":false,"schema":{"$ref":"#/components/schemas/AdminListServersPerPageQueryParameter"},"examples":{"default":{"value":50}}}],"responses":{"200":{"description":"Servers returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create server","operationId":"adminCreateServer","description":"Creates a server using explicit allocations or automatic deployment constraints.","parameters":[],"responses":{"201":{"description":"Server created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateServerRequest"}}}}}},"/api/admin/servers/external/{external_id}":{"get":{"summary":"Get server by external ID","operationId":"adminGetServerByExternalID","description":"Returns a single server by external identifier.","parameters":[],"responses":{"200":{"description":"Server returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"external_id","description":"The external ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetServerByExternalIDExternalIdPathParameter"},"examples":{"default":{"value":"external-identifier"}}}]},"/api/admin/servers/{server_admin_identifier}":{"get":{"summary":"Get server","operationId":"adminGetServer","description":"Returns a single server by admin identifier.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports allocation, allocations, user, subusers, egg, variables, location, node, and databases.","required":false,"schema":{"$ref":"#/components/schemas/AdminGetServerIncludeQueryParameter"},"examples":{"default":{"value":"allocations,user,node,egg,variables"}}}],"responses":{"200":{"description":"Server returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"delete":{"summary":"Delete server","operationId":"adminDeleteServer","description":"Deletes a server and returns an error if Wings or database host cleanup fails.","parameters":[],"responses":{"204":{"description":"Server deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetServerServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/details":{"put":{"summary":"Update server details","operationId":"adminUpdateServerDetails","description":"Updates a server name, owner, description, and external identifier.","parameters":[],"responses":{"200":{"description":"Server updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateServerDetailsRequest"}}}}},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateServerDetailsServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/build":{"put":{"summary":"Update server build","operationId":"adminUpdateServerBuild","description":"Updates server limits, primary allocation, and feature limits.","parameters":[],"responses":{"200":{"description":"Server build updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateServerBuildRequest"}}}}},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateServerBuildServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/startup":{"put":{"summary":"Update server startup","operationId":"adminUpdateServerStartup","description":"Updates the egg, Docker image, startup command, environment, and install-script behavior.","parameters":[],"responses":{"200":{"description":"Server startup updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateServerStartupRequest"}}}}},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateServerStartupServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/suspension":{"post":{"summary":"Update server suspension","operationId":"adminUpdateServerSuspension","description":"Suspends or unsuspends a server.","parameters":[],"responses":{"204":{"description":"Server suspension state updated."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateServerSuspensionRequest"}}}}},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateServerSuspensionServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/reinstall":{"post":{"summary":"Reinstall server","operationId":"adminReinstallServer","description":"Queues a server reinstall through Wings.","parameters":[],"responses":{"202":{"description":"Server reinstall accepted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminReinstallServerServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/rebuild":{"post":{"summary":"Rebuild server","operationId":"adminRebuildServer","description":"Synchronizes the server configuration to Wings.","parameters":[],"responses":{"204":{"description":"Server rebuild synchronized."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminRebuildServerServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/transfer/progress":{"get":{"summary":"Get server transfer progress","operationId":"adminGetServerTransferProgress","description":"Returns the active transfer for a server, or 204 when no transfer is in progress.","parameters":[],"responses":{"200":{"description":"Transfer progress returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerTransferResource"}}}},"204":{"description":"No server transfer is currently in progress."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetServerTransferProgressServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/transfer":{"post":{"summary":"Transfer server","operationId":"adminTransferServer","description":"Starts a server transfer to another node using the specified target allocations.","parameters":[],"responses":{"204":{"description":"Server transfer started."},"400":{"description":"The destination node cannot fit the server or the server cannot currently be transferred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTransferServerRequest"}}}}},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminTransferServerServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/settings/toggle-install":{"post":{"summary":"Toggle server install state","operationId":"adminToggleServerInstallState","description":"Toggles a server between installed and installing states unless it is marked as failed.","parameters":[],"responses":{"204":{"description":"Server install state toggled."},"400":{"description":"The server is marked as failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminToggleServerInstallStateServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/force":{"delete":{"summary":"Force delete server","operationId":"adminForceDeleteServer","description":"Deletes a server while bypassing recoverable Wings or database host cleanup failures.","parameters":[],"responses":{"204":{"description":"Server force deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminForceDeleteServerServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/databases":{"get":{"summary":"List server databases","operationId":"adminListServerDatabases","description":"Returns all databases assigned to a server.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"password\".","required":false,"schema":{"$ref":"#/components/schemas/AdminListServerDatabasesIncludeQueryParameter"},"examples":{"default":{"value":"password"}}}],"responses":{"200":{"description":"Server databases returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerDatabaseListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The server is not installed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create server database","operationId":"adminCreateServerDatabase","description":"Creates a database for a server and returns the generated password.","parameters":[],"responses":{"201":{"description":"Server database created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerDatabaseResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The server is not installed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateServerDatabaseRequest"}}}}},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminListServerDatabasesServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/databases/{database_id}":{"get":{"summary":"Get server database","operationId":"adminGetServerDatabase","description":"Returns a single database assigned to a server.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"password\".","required":false,"schema":{"$ref":"#/components/schemas/AdminGetServerDatabaseIncludeQueryParameter"},"examples":{"default":{"value":"password"}}}],"responses":{"200":{"description":"Server database returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerDatabaseResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The server is not installed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"delete":{"summary":"Delete server database","operationId":"adminDeleteServerDatabase","description":"Deletes a database assigned to a server.","parameters":[],"responses":{"204":{"description":"Server database deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The server is not installed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetServerDatabaseServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}},{"in":"path","name":"database_id","description":"The database ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetServerDatabaseDatabaseIdPathParameter"},"examples":{"default":{"value":"Lk3jx4pQ"}}}]},"/api/admin/servers/{server_admin_identifier}/databases/{database_id}/rotate-password":{"post":{"summary":"Rotate server database password","operationId":"adminRotateServerDatabasePassword","description":"Rotates the password for a database assigned to a server.","parameters":[],"responses":{"200":{"description":"Database password rotated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminServerDatabaseResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminRotateServerDatabasePasswordServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}},{"in":"path","name":"database_id","description":"The database ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminRotateServerDatabasePasswordDatabaseIdPathParameter"},"examples":{"default":{"value":"Lk3jx4pQ"}}}]},"/api/admin/servers/{server_admin_identifier}/backups":{"get":{"summary":"List server backups","operationId":"adminListServerBackups","description":"Returns a paginated list of backups assigned to a server.","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter backups by UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminListServerBackupsFilterUuidQueryParameter"},"examples":{"default":{"value":"1b19cf3f-2f89-4f88-a81e-321e7fe326bc"}}},{"in":"query","name":"filter[name]","description":"Filter backups by name.","required":true,"schema":{"$ref":"#/components/schemas/AdminListServerBackupsFilterNameQueryParameter"},"examples":{"default":{"value":"Before Update"}}},{"in":"query","name":"sort","description":"Sort backups by id, bytes, or created_at. Prefix with a hyphen for descending order.","required":true,"schema":{"$ref":"#/components/schemas/AdminListServerBackupsSortQueryParameter"},"examples":{"default":{"value":"-created_at"}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":true,"schema":{"$ref":"#/components/schemas/AdminListServerBackupsPerPageQueryParameter"},"examples":{"default":{"value":25}}}],"responses":{"200":{"description":"Server backups returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminBackupPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminListServerBackupsServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}}]},"/api/admin/servers/{server_admin_identifier}/backups/{backup_id}/toggle":{"post":{"summary":"Toggle server backup lock","operationId":"adminToggleServerBackupLock","description":"Toggles whether a server backup is locked against deletion.","parameters":[],"responses":{"200":{"description":"Server backup lock state toggled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminBackupResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"server_admin_identifier","description":"The server ID or UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminToggleServerBackupLockServerAdminIdentifierPathParameter"},"examples":{"default":{"value":"1"}}},{"in":"path","name":"backup_id","description":"The ID of the backup.","required":true,"schema":{"$ref":"#/components/schemas/AdminToggleServerBackupLockBackupIdPathParameter"},"examples":{"default":{"value":"architecto"}}}]},"/api/admin/nodes":{"get":{"summary":"List nodes","operationId":"adminListNodes","description":"Returns a paginated list of Wings nodes.","parameters":[{"in":"query","name":"filter[uuid]","description":"Filter nodes by UUID.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodesFilterUuidQueryParameter"},"examples":{"default":{"value":"1b19cf3f-2f89-4f88-a81e-321e7fe326bc"}}},{"in":"query","name":"filter[name]","description":"Filter nodes by name.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodesFilterNameQueryParameter"},"examples":{"default":{"value":"node-1"}}},{"in":"query","name":"filter[fqdn]","description":"Filter nodes by FQDN.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodesFilterFqdnQueryParameter"},"examples":{"default":{"value":"node.example.com"}}},{"in":"query","name":"sort","description":"Sort nodes by id, uuid, name, memory, disk, or creation time. Prefix with a hyphen for descending order.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodesSortQueryParameter"},"examples":{"default":{"value":"-created_at"}}},{"in":"query","name":"page","description":"Page number to return.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodesPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodesPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"allocations\", \"location\", and \"servers\".","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodesIncludeQueryParameter"},"examples":{"default":{"value":"location"}}}],"responses":{"200":{"description":"Nodes returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminNodePaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create node","operationId":"adminCreateNode","description":"Creates a Wings node. HTTPS nodes must use a valid FQDN rather than a raw IP address.","parameters":[],"responses":{"201":{"description":"Node created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminNodeResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateNodeRequest"}}}}}},"/api/admin/nodes/{node_id}":{"get":{"summary":"Get node","operationId":"adminGetNode","description":"Returns a single Wings node by ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"allocations\", \"location\", and \"servers\".","required":false,"schema":{"$ref":"#/components/schemas/AdminGetNodeIncludeQueryParameter"},"examples":{"default":{"value":"location"}}}],"responses":{"200":{"description":"Node returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminNodeResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"delete":{"summary":"Delete node","operationId":"adminDeleteNode","description":"Deletes a node when it has no active servers.","parameters":[],"responses":{"204":{"description":"Node deleted."},"400":{"description":"The node has active servers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetNodeNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/configuration":{"get":{"summary":"Get node configuration","operationId":"adminGetNodeConfiguration","description":"Returns the raw Wings configuration payload for a node, including daemon authentication tokens.","parameters":[],"responses":{"200":{"description":"Node configuration returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminNodeConfigurationResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetNodeConfigurationNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{id}":{"put":{"summary":"Update node","operationId":"adminUpdateNode","description":"Updates a Wings node and optionally rotates its daemon secret.","parameters":[],"responses":{"200":{"description":"Node updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminNodeResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateNodeRequest"}}}}},"parameters":[{"in":"path","name":"id","description":"The resource ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/tags":{"put":{"summary":"Sync node game tags","operationId":"adminSyncNodeGameTags","description":"Replaces the games a node accepts. A node with no game tags accepts any egg.","parameters":[],"responses":{"200":{"description":"Games the node accepts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTagListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminSyncNodeGameTagsRequest"}}}}},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminSyncNodeGameTagsNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/deployment-tags":{"put":{"summary":"Sync node deployment tags","operationId":"adminSyncNodeDeploymentTags","description":"Replaces the reservations on a node. A deploy must declare exactly these tags to land here.","parameters":[],"responses":{"200":{"description":"Reservations on the node.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTagListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminSyncNodeDeploymentTagsRequest"}}}}},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminSyncNodeDeploymentTagsNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/allocations":{"get":{"summary":"List node allocations","operationId":"adminListNodeAllocations","description":"Returns a paginated list of allocations for a node.","parameters":[{"in":"query","name":"filter[ip]","description":"Filter allocations by exact IP address.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodeAllocationsFilterIpQueryParameter"},"examples":{"default":{"value":"192.168.1.1"}}},{"in":"query","name":"filter[port]","description":"Filter allocations by exact port.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodeAllocationsFilterPortQueryParameter"},"examples":{"default":{"value":25565}}},{"in":"query","name":"filter[ip_alias]","description":"Filter allocations by IP alias.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodeAllocationsFilterIpAliasQueryParameter"},"examples":{"default":{"value":"game.example.com"}}},{"in":"query","name":"filter[server_id]","description":"Filter allocations by server ID, or pass an empty value to return unassigned allocations.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodeAllocationsFilterServerIdQueryParameter"},"examples":{"default":{"value":"42"}}},{"in":"query","name":"sort","description":"Sort allocations by id, ip, or port. Prefix with a hyphen for descending order.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodeAllocationsSortQueryParameter"},"examples":{"default":{"value":"port"}}},{"in":"query","name":"page","description":"Page number to return.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodeAllocationsPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":false,"schema":{"$ref":"#/components/schemas/AdminListNodeAllocationsPerPageQueryParameter"},"examples":{"default":{"value":50}}}],"responses":{"200":{"description":"Allocations returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAllocationPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create node allocations","operationId":"adminCreateNodeAllocations","description":"Creates one or more allocations on a node from IP addresses and ports or port ranges.","parameters":[],"responses":{"204":{"description":"Allocations created."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateNodeAllocationsRequest"}}}}},"delete":{"summary":"Bulk delete node allocations","operationId":"adminBulkDeleteNodeAllocations","description":"Deletes multiple unassigned allocations from a node by allocation ID.","parameters":[],"responses":{"204":{"description":"Allocations deleted."},"400":{"description":"One of the allocations is currently assigned to a server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminBulkDeleteNodeAllocationsRequest"}}}}},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminListNodeAllocationsNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/allocations/ips":{"get":{"summary":"List node allocation IPs","operationId":"adminListNodeAllocationIPs","description":"Returns distinct allocation IP addresses for a node.","parameters":[],"responses":{"200":{"description":"Allocation IPs returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListNodeAllocationIPsResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminListNodeAllocationIPsNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/allocations/available":{"get":{"summary":"List available node allocations","operationId":"adminListAvailableNodeAllocations","description":"Returns unassigned allocations for a node.","parameters":[{"in":"query","name":"filter[ip]","description":"Filter allocations by exact IP address.","required":true,"schema":{"$ref":"#/components/schemas/AdminListAvailableNodeAllocationsFilterIpQueryParameter"},"examples":{"default":{"value":"192.168.1.1"}}},{"in":"query","name":"filter[port]","description":"Filter allocations by exact port.","required":true,"schema":{"$ref":"#/components/schemas/AdminListAvailableNodeAllocationsFilterPortQueryParameter"},"examples":{"default":{"value":25565}}},{"in":"query","name":"filter[ip_alias]","description":"Filter allocations by IP alias.","required":true,"schema":{"$ref":"#/components/schemas/AdminListAvailableNodeAllocationsFilterIpAliasQueryParameter"},"examples":{"default":{"value":"game.example.com"}}},{"in":"query","name":"sort","description":"Sort allocations by id, ip, or port. Prefix with a hyphen for descending order.","required":true,"schema":{"$ref":"#/components/schemas/AdminListAvailableNodeAllocationsSortQueryParameter"},"examples":{"default":{"value":"port"}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":true,"schema":{"$ref":"#/components/schemas/AdminListAvailableNodeAllocationsPerPageQueryParameter"},"examples":{"default":{"value":50}}}],"responses":{"200":{"description":"Available allocations returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAllocationPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminListAvailableNodeAllocationsNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/allocations/block":{"delete":{"summary":"Delete node allocation IP block","operationId":"adminDeleteNodeAllocationIPBlock","description":"Deletes every unassigned allocation for an IP address on a node.","parameters":[],"responses":{"204":{"description":"Unassigned allocations for the IP were deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminDeleteNodeAllocationIPBlockRequest"}}}}},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminDeleteNodeAllocationIPBlockNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/allocations/{id}":{"put":{"summary":"Update node allocation","operationId":"adminUpdateNodeAllocation","description":"Updates the alias for a single allocation on a node.","parameters":[],"responses":{"200":{"description":"Allocation updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAllocationResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateNodeAllocationRequest"}}}}},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateNodeAllocationNodeIdPathParameter"},"examples":{"default":{"value":1}}},{"in":"path","name":"id","description":"The resource ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateNodeAllocationIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/nodes/{node_id}/allocations/{allocation_id}":{"delete":{"summary":"Delete node allocation","operationId":"adminDeleteNodeAllocation","description":"Deletes a single unassigned allocation from a node.","parameters":[],"responses":{"204":{"description":"Allocation deleted."},"400":{"description":"The allocation is currently assigned to a server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminDeleteNodeAllocationNodeIdPathParameter"},"examples":{"default":{"value":1}}},{"in":"path","name":"allocation_id","description":"The ID of the allocation.","required":true,"schema":{"$ref":"#/components/schemas/AdminDeleteNodeAllocationAllocationIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/locations":{"get":{"summary":"List locations","operationId":"adminListLocations","description":"Returns a paginated list of locations.","parameters":[{"in":"query","name":"filter[short]","description":"Filter locations by short identifier.","required":false,"schema":{"$ref":"#/components/schemas/AdminListLocationsFilterShortQueryParameter"},"examples":{"default":{"value":"us-east"}}},{"in":"query","name":"filter[long]","description":"Filter locations by long description.","required":false,"schema":{"$ref":"#/components/schemas/AdminListLocationsFilterLongQueryParameter"},"examples":{"default":{"value":"US East"}}},{"in":"query","name":"sort","description":"Sort locations by ID, short identifier, or creation date. Prefix with a hyphen for descending order.","required":false,"schema":{"$ref":"#/components/schemas/AdminListLocationsSortQueryParameter"},"examples":{"default":{"value":"short"}}},{"in":"query","name":"page","description":"Page number to return.","required":false,"schema":{"$ref":"#/components/schemas/AdminListLocationsPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":false,"schema":{"$ref":"#/components/schemas/AdminListLocationsPerPageQueryParameter"},"examples":{"default":{"value":50}}}],"responses":{"200":{"description":"Locations returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLocationPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create location","operationId":"adminCreateLocation","description":"Creates a location for grouping nodes and servers.","parameters":[],"responses":{"201":{"description":"Location created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLocationResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateLocationRequest"}}}}}},"/api/admin/locations/{location_id}":{"get":{"summary":"Get location","operationId":"adminGetLocation","description":"Returns a single location by ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"nodes\" and \"servers\".","required":false,"schema":{"$ref":"#/components/schemas/AdminGetLocationIncludeQueryParameter"},"examples":{"default":{"value":"nodes"}}}],"responses":{"200":{"description":"Location returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLocationResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"delete":{"summary":"Delete location","operationId":"adminDeleteLocation","description":"Deletes a location when no dependent resources prevent removal.","parameters":[],"responses":{"204":{"description":"Location deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"location_id","description":"The location ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetLocationLocationIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/locations/{location_id}/eligible-nodes":{"get":{"summary":"List eligible location nodes","operationId":"adminListEligibleLocationNodes","description":"Returns nodes assigned to a location that can be selected for location-scoped workflows.","parameters":[],"responses":{"200":{"description":"Eligible nodes returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminNodeListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"location_id","description":"The location ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminListEligibleLocationNodesLocationIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/locations/{id}":{"put":{"summary":"Update location","operationId":"adminUpdateLocation","description":"Updates a location short identifier and description.","parameters":[],"responses":{"200":{"description":"Location updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLocationResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateLocationRequest"}}}}},"parameters":[{"in":"path","name":"id","description":"The resource ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateLocationIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/mounts":{"get":{"summary":"List mounts","operationId":"adminListMounts","description":"Returns a paginated list of mount definitions.","parameters":[{"in":"query","name":"filter[name]","description":"Filter mounts by name.","required":false,"schema":{"$ref":"#/components/schemas/AdminListMountsFilterNameQueryParameter"},"examples":{"default":{"value":"Shared Mods"}}},{"in":"query","name":"sort","description":"Sort mounts by id or name. Prefix with a hyphen for descending order.","required":false,"schema":{"$ref":"#/components/schemas/AdminListMountsSortQueryParameter"},"examples":{"default":{"value":"name"}}},{"in":"query","name":"page","description":"Page number to return.","required":false,"schema":{"$ref":"#/components/schemas/AdminListMountsPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":false,"schema":{"$ref":"#/components/schemas/AdminListMountsPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"eggs\", \"nodes\", and \"servers\".","required":false,"schema":{"$ref":"#/components/schemas/AdminListMountsIncludeQueryParameter"},"examples":{"default":{"value":"eggs,nodes"}}}],"responses":{"200":{"description":"Mounts returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminMountPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create mount","operationId":"adminCreateMount","description":"Creates a mount definition and generates its UUID.","parameters":[],"responses":{"201":{"description":"Mount created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminMountResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateMountRequest"}}}}}},"/api/admin/mounts/{mount_id}":{"get":{"summary":"Get mount","operationId":"adminGetMount","description":"Returns a single mount definition by ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"eggs\", \"nodes\", and \"servers\".","required":false,"schema":{"$ref":"#/components/schemas/AdminGetMountIncludeQueryParameter"},"examples":{"default":{"value":"eggs,nodes"}}}],"responses":{"200":{"description":"Mount returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminMountResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"delete":{"summary":"Delete mount","operationId":"adminDeleteMount","description":"Deletes a mount definition.","parameters":[],"responses":{"204":{"description":"Mount deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"mount_id","description":"The mount ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetMountMountIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/mounts/{id}":{"put":{"summary":"Update mount","operationId":"adminUpdateMount","description":"Updates an existing mount definition.","parameters":[],"responses":{"200":{"description":"Mount updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminMountResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateMountRequest"}}}}},"parameters":[{"in":"path","name":"id","description":"The resource ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateMountIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/mounts/{mount_id}/eggs":{"post":{"summary":"Attach eggs to mount","operationId":"adminAttachEggsToMount","description":"Attaches one or more eggs to a mount definition without removing existing egg attachments.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"eggs\", \"nodes\", and \"servers\".","required":false,"schema":{"$ref":"#/components/schemas/AdminAttachEggsToMountIncludeQueryParameter"},"examples":{"default":{"value":"eggs,nodes"}}}],"responses":{"200":{"description":"Mount updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminMountResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAttachEggsToMountRequest"}}}}},"parameters":[{"in":"path","name":"mount_id","description":"The mount ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminAttachEggsToMountMountIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/mounts/{mount_id}/eggs/{egg_id}":{"delete":{"summary":"Detach egg from mount","operationId":"adminDetachEggFromMount","description":"Removes a single egg attachment from a mount definition.","parameters":[],"responses":{"204":{"description":"Egg detached from mount."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"mount_id","description":"The mount ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminDetachEggFromMountMountIdPathParameter"},"examples":{"default":{"value":1}}},{"in":"path","name":"egg_id","description":"The egg ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminDetachEggFromMountEggIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/mounts/{mount_id}/nodes":{"post":{"summary":"Attach nodes to mount","operationId":"adminAttachNodesToMount","description":"Attaches one or more nodes to a mount definition without removing existing node attachments.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"eggs\", \"nodes\", and \"servers\".","required":false,"schema":{"$ref":"#/components/schemas/AdminAttachNodesToMountIncludeQueryParameter"},"examples":{"default":{"value":"eggs,nodes"}}}],"responses":{"200":{"description":"Mount updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminMountResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAttachNodesToMountRequest"}}}}},"parameters":[{"in":"path","name":"mount_id","description":"The mount ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminAttachNodesToMountMountIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/mounts/{mount_id}/nodes/{node_id}":{"delete":{"summary":"Detach node from mount","operationId":"adminDetachNodeFromMount","description":"Removes a single node attachment from a mount definition.","parameters":[],"responses":{"204":{"description":"Node detached from mount."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"mount_id","description":"The mount ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminDetachNodeFromMountMountIdPathParameter"},"examples":{"default":{"value":1}}},{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminDetachNodeFromMountNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/eggs/catalog":{"get":{"summary":"List egg catalog","operationId":"adminListEggCatalog","description":"Returns the cached Pterodactyl egg catalog for searching and filtering. The index is cached for one hour.","parameters":[],"responses":{"200":{"description":"Catalog entries returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminListEggCatalogResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"The upstream catalog is unavailable or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]}},"/api/admin/eggs/catalog/refresh":{"post":{"summary":"Refresh egg catalog","operationId":"adminRefreshEggCatalog","description":"Clears the cached Pterodactyl catalog so the next listing downloads the current index.","parameters":[],"responses":{"204":{"description":"Catalog cache cleared."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]}},"/api/admin/eggs/catalog/import":{"post":{"summary":"Import catalog egg","operationId":"adminImportCatalogEgg","description":"Downloads the selected entry from the Pterodactyl catalog and imports its egg definition and variables.","parameters":[],"responses":{"201":{"description":"Egg imported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The selected catalog entry does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"The upstream catalog or egg definition could not be loaded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminImportCatalogEggRequest"}}}}}},"/api/admin/eggs/{egg_id}/variables":{"get":{"summary":"List egg variables","operationId":"adminListEggVariables","description":"Returns variables for an egg in display order.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Unknown includes are ignored.","required":false,"schema":{"$ref":"#/components/schemas/AdminListEggVariablesIncludeQueryParameter"},"examples":{"default":{"value":"egg"}}}],"responses":{"200":{"description":"Egg variables returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggVariableListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create egg variable","operationId":"adminCreateEggVariable","description":"Creates a startup variable for an egg.","parameters":[],"responses":{"201":{"description":"Egg variable created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggVariableResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateEggVariableRequest"}}}}},"parameters":[{"in":"path","name":"egg_id","description":"The egg ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminListEggVariablesEggIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/eggs/{egg_id}/variables/reorder":{"put":{"summary":"Reorder egg variables","operationId":"adminReorderEggVariables","description":"Updates the display order for variables on an egg.","parameters":[],"responses":{"200":{"description":"Egg variables reordered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggVariableListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminReorderEggVariablesRequest"}}}}},"parameters":[{"in":"path","name":"egg_id","description":"The egg ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminReorderEggVariablesEggIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/eggs/{egg_id}/variables/{id}":{"put":{"summary":"Update egg variable","operationId":"adminUpdateEggVariable","description":"Updates a startup variable for an egg.","parameters":[],"responses":{"200":{"description":"Egg variable updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggVariableResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateEggVariableRequest"}}}}},"parameters":[{"in":"path","name":"egg_id","description":"The egg ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateEggVariableEggIdPathParameter"},"examples":{"default":{"value":1}}},{"in":"path","name":"id","description":"The resource ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateEggVariableIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/eggs/{egg_id}/variables/{variable_id}":{"delete":{"summary":"Delete egg variable","operationId":"adminDeleteEggVariable","description":"Deletes a startup variable from an egg.","parameters":[],"responses":{"204":{"description":"Egg variable deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"egg_id","description":"The egg ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminDeleteEggVariableEggIdPathParameter"},"examples":{"default":{"value":1}}},{"in":"path","name":"variable_id","description":"The variable ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminDeleteEggVariableVariableIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/eggs/{egg_id}/scripts":{"get":{"summary":"Get egg install script","operationId":"adminGetEggInstallScript","description":"Returns an egg with its install script block.","parameters":[],"responses":{"200":{"description":"Egg install script returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"put":{"summary":"Update egg install script","operationId":"adminUpdateEggInstallScript","description":"Updates the install script configuration for an egg.","parameters":[],"responses":{"200":{"description":"Egg install script updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggResource"}}}},"400":{"description":"The selected copy source is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateEggInstallScriptRequest"}}}}},"parameters":[{"in":"path","name":"egg_id","description":"The egg ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetEggInstallScriptEggIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/eggs/{egg_id}/export":{"get":{"summary":"Export egg","operationId":"adminExportEgg","description":"Downloads an egg share JSON file.","parameters":[],"responses":{"200":{"description":"Egg share file returned.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AdminExportEggResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"egg_id","description":"The egg ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminExportEggEggIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/eggs/{egg_id}/import":{"post":{"summary":"Update egg from import","operationId":"adminUpdateEggFromImport","description":"Updates an existing egg from an uploaded egg share JSON file.","parameters":[],"responses":{"200":{"description":"Egg updated from import.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AdminUpdateEggFromImportRequest"}}}}},"parameters":[{"in":"path","name":"egg_id","description":"The egg ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateEggFromImportEggIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/eggs/{egg_id}/tags":{"put":{"summary":"Sync egg tags","operationId":"adminSyncEggTags","description":"Replaces the tags applied to an egg. Values may be tag IDs or new tag names.","parameters":[],"responses":{"200":{"description":"Tags applied to the egg.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTagListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminSyncEggTagsRequest"}}}}},"parameters":[{"in":"path","name":"egg_id","description":"The egg ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminSyncEggTagsEggIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/eggs/import":{"post":{"summary":"Import egg","operationId":"adminImportEgg","description":"Creates an egg from an uploaded egg share JSON file.","parameters":[],"responses":{"201":{"description":"Egg imported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AdminImportEggRequest"}}}}}},"/api/admin/eggs":{"get":{"summary":"List eggs","operationId":"adminListEggs","description":"Returns a paginated list of egg definitions.","parameters":[{"in":"query","name":"filter[name]","description":"Filter eggs by name.","required":false,"schema":{"$ref":"#/components/schemas/AdminListEggsFilterNameQueryParameter"},"examples":{"default":{"value":"Paper"}}},{"in":"query","name":"sort","description":"Sort eggs by id or name. Prefix with a hyphen for descending order.","required":false,"schema":{"$ref":"#/components/schemas/AdminListEggsSortQueryParameter"},"examples":{"default":{"value":"name"}}},{"in":"query","name":"page","description":"Page number to return.","required":false,"schema":{"$ref":"#/components/schemas/AdminListEggsPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":false,"schema":{"$ref":"#/components/schemas/AdminListEggsPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"include","description":"Comma-separated relationships to include: variables, tags, servers.","required":false,"schema":{"$ref":"#/components/schemas/AdminListEggsIncludeQueryParameter"},"examples":{"default":{"value":"variables"}}}],"responses":{"200":{"description":"Eggs returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create egg","operationId":"adminCreateEgg","description":"Creates an egg definition.","parameters":[],"responses":{"201":{"description":"Egg created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateEggRequest"}}}}}},"/api/admin/eggs/{egg_id}":{"get":{"summary":"Get egg","operationId":"adminGetEgg","description":"Returns a single egg definition by ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include: variables, tags, servers.","required":false,"schema":{"$ref":"#/components/schemas/AdminGetEggIncludeQueryParameter"},"examples":{"default":{"value":"variables,tags"}}}],"responses":{"200":{"description":"Egg returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"delete":{"summary":"Delete egg","operationId":"adminDeleteEgg","description":"Deletes an egg definition.","parameters":[],"responses":{"204":{"description":"Egg deleted."},"400":{"description":"The egg has active servers or child eggs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"egg_id","description":"The egg ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetEggEggIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/eggs/{id}":{"put":{"summary":"Update egg","operationId":"adminUpdateEgg","description":"Updates an egg definition.","parameters":[],"responses":{"200":{"description":"Egg updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminEggResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateEggRequest"}}}}},"parameters":[{"in":"path","name":"id","description":"The resource ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateEggIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/tags":{"get":{"summary":"List tags","operationId":"adminListTags","description":"Returns a paginated list of tags.","parameters":[{"in":"query","name":"filter[name]","description":"Filter tags by name.","required":false,"schema":{"$ref":"#/components/schemas/AdminListTagsFilterNameQueryParameter"},"examples":{"default":{"value":"Minecraft"}}},{"in":"query","name":"filter[slug]","description":"Filter tags by slug.","required":false,"schema":{"$ref":"#/components/schemas/AdminListTagsFilterSlugQueryParameter"},"examples":{"default":{"value":"minecraft"}}},{"in":"query","name":"sort","description":"Sort tags by id, name, or slug. Prefix with a hyphen for descending order.","required":false,"schema":{"$ref":"#/components/schemas/AdminListTagsSortQueryParameter"},"examples":{"default":{"value":"name"}}},{"in":"query","name":"page","description":"Page number to return.","required":false,"schema":{"$ref":"#/components/schemas/AdminListTagsPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":false,"schema":{"$ref":"#/components/schemas/AdminListTagsPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"eggs\" and \"nodes\".","required":false,"schema":{"$ref":"#/components/schemas/AdminListTagsIncludeQueryParameter"},"examples":{"default":{"value":"eggs"}}}],"responses":{"200":{"description":"Tags returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTagPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create tag","operationId":"adminCreateTag","description":"Creates a tag.","parameters":[],"responses":{"201":{"description":"Tag created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTagResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateTagRequest"}}}}}},"/api/admin/tags/{tag_id}":{"get":{"summary":"Get tag","operationId":"adminGetTag","description":"Returns a single tag by ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"eggs\" and \"nodes\".","required":false,"schema":{"$ref":"#/components/schemas/AdminGetTagIncludeQueryParameter"},"examples":{"default":{"value":"eggs"}}}],"responses":{"200":{"description":"Tag returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTagResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"delete":{"summary":"Delete tag","operationId":"adminDeleteTag","description":"Deletes a tag and detaches it from every egg and node.","parameters":[],"responses":{"204":{"description":"Tag deleted."},"400":{"description":"The tag is a built-in game tag.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"tag_id","description":"The ID of the tag.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetTagTagIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/tags/{id}":{"put":{"summary":"Update tag","operationId":"adminUpdateTag","description":"Updates an existing tag. Built-in game tags cannot be edited.","parameters":[],"responses":{"200":{"description":"Tag updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminTagResource"}}}},"400":{"description":"The tag is a built-in game tag.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateTagRequest"}}}}},"parameters":[{"in":"path","name":"id","description":"The resource ID.","required":true,"schema":{"$ref":"#/components/schemas/AdminUpdateTagIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/admin/settings":{"get":{"summary":"Get settings","operationId":"adminGetSettings","description":"Returns current general, mail, advanced, and metadata settings.","parameters":[],"responses":{"200":{"description":"Settings returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminSettingsResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]}},"/api/admin/settings/general":{"put":{"summary":"Update general settings","operationId":"adminUpdateGeneralSettings","description":"Updates panel branding, 2FA requirements, and default locale settings.","parameters":[],"responses":{"204":{"description":"General settings updated."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateGeneralSettingsRequest"}}}}}},"/api/admin/settings/mail":{"put":{"summary":"Update mail settings","operationId":"adminUpdateMailSettings","description":"Updates SMTP mail settings and restarts queued workers so they reload configuration.","parameters":[],"responses":{"204":{"description":"Mail settings updated."},"400":{"description":"The panel is not configured to use SMTP mail.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateMailSettingsRequest"}}}}}},"/api/admin/settings/mail/test":{"post":{"summary":"Send test mail","operationId":"adminSendTestMail","description":"Sends a test email to the authenticated administrator using the configured mail transport.","parameters":[],"responses":{"204":{"description":"Test mail queued."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"The configured mail transport failed to send the message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]}},"/api/admin/settings/advanced":{"put":{"summary":"Update advanced settings","operationId":"adminUpdateAdvancedSettings","description":"Updates reCAPTCHA, HTTP client timeout, and client allocation feature settings.","parameters":[],"responses":{"204":{"description":"Advanced settings updated."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateAdvancedSettingsRequest"}}}}}},"/api/admin/database-hosts":{"get":{"summary":"List database hosts","operationId":"adminListDatabaseHosts","description":"Returns a paginated list of database hosts.","parameters":[{"in":"query","name":"page","description":"Page number to retrieve.","required":false,"schema":{"$ref":"#/components/schemas/AdminListDatabaseHostsPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":false,"schema":{"$ref":"#/components/schemas/AdminListDatabaseHostsPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"filter[name]","description":"Filter hosts by name.","required":false,"schema":{"$ref":"#/components/schemas/AdminListDatabaseHostsFilterNameQueryParameter"},"examples":{"default":{"value":"Primary"}}},{"in":"query","name":"filter[host]","description":"Filter hosts by address or hostname.","required":false,"schema":{"$ref":"#/components/schemas/AdminListDatabaseHostsFilterHostQueryParameter"},"examples":{"default":{"value":"127.0.0.1"}}},{"in":"query","name":"sort","description":"Sort hosts by ID, name, or creation date. Prefix with a hyphen for descending order.","required":false,"schema":{"$ref":"#/components/schemas/AdminListDatabaseHostsSortQueryParameter"},"examples":{"default":{"value":"-created_at"}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports node and databases.","required":false,"schema":{"$ref":"#/components/schemas/AdminListDatabaseHostsIncludeQueryParameter"},"examples":{"default":{"value":"node"}}}],"responses":{"200":{"description":"Database hosts returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminDatabaseHostPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create database host","operationId":"adminCreateDatabaseHost","description":"Creates a database host after validating that the panel can connect to it.","parameters":[],"responses":{"201":{"description":"Database host created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminDatabaseHostResource"}}}},"400":{"description":"The panel could not connect to the database host.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateDatabaseHostRequest"}}}}}},"/api/admin/database-hosts/{databaseHost_id}":{"get":{"summary":"Get database host","operationId":"adminGetDatabaseHost","description":"Returns a single database host by ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports node and databases.","required":false,"schema":{"$ref":"#/components/schemas/AdminGetDatabaseHostIncludeQueryParameter"},"examples":{"default":{"value":"node"}}}],"responses":{"200":{"description":"Database host returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminDatabaseHostResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"put":{"summary":"Update database host","operationId":"adminUpdateDatabaseHost","description":"Updates a database host after validating that the panel can connect to the supplied host details.","parameters":[],"responses":{"200":{"description":"Database host updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminDatabaseHostResource"}}}},"400":{"description":"The panel could not connect to the database host.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateDatabaseHostRequest"}}}}},"delete":{"summary":"Delete database host","operationId":"adminDeleteDatabaseHost","description":"Deletes a database host when no server databases depend on it.","parameters":[],"responses":{"204":{"description":"Database host deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"databaseHost_id","description":"The ID of the databaseHost.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetDatabaseHostDatabaseHostIdPathParameter"},"examples":{"default":{"value":"architecto"}}}]},"/api/admin/database-hosts/{databaseHost_id}/databases":{"get":{"summary":"List database host databases","operationId":"adminListDatabaseHostDatabases","description":"Returns a paginated list of server databases assigned to a database host.","parameters":[{"in":"query","name":"page","description":"Page number to retrieve.","required":false,"schema":{"$ref":"#/components/schemas/AdminListDatabaseHostDatabasesPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":false,"schema":{"$ref":"#/components/schemas/AdminListDatabaseHostDatabasesPerPageQueryParameter"},"examples":{"default":{"value":50}}}],"responses":{"200":{"description":"Databases returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminDatabasePaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"databaseHost_id","description":"The ID of the databaseHost.","required":true,"schema":{"$ref":"#/components/schemas/AdminListDatabaseHostDatabasesDatabaseHostIdPathParameter"},"examples":{"default":{"value":"architecto"}}}]},"/api/admin/api-keys":{"get":{"summary":"List API keys","operationId":"adminListAPIKeys","description":"Returns a paginated list of application API keys.","parameters":[{"in":"query","name":"filter[memo]","description":"Filter keys by memo.","required":false,"schema":{"$ref":"#/components/schemas/AdminListAPIKeysFilterMemoQueryParameter"},"examples":{"default":{"value":"Automation"}}},{"in":"query","name":"filter[identifier]","description":"Filter keys by identifier.","required":false,"schema":{"$ref":"#/components/schemas/AdminListAPIKeysFilterIdentifierQueryParameter"},"examples":{"default":{"value":"ptla_1234567890abc"}}},{"in":"query","name":"sort","description":"Sort keys by ID, memo, or creation date. Prefix with a hyphen for descending order.","required":false,"schema":{"$ref":"#/components/schemas/AdminListAPIKeysSortQueryParameter"},"examples":{"default":{"value":"-created_at"}}},{"in":"query","name":"page","description":"Page number to retrieve.","required":false,"schema":{"$ref":"#/components/schemas/AdminListAPIKeysPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Results to return per page.","required":false,"schema":{"$ref":"#/components/schemas/AdminListAPIKeysPerPageQueryParameter"},"examples":{"default":{"value":50}}}],"responses":{"200":{"description":"API keys returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminApiKeyPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"post":{"summary":"Create API key","operationId":"adminCreateAPIKey","description":"Creates a new application API key and returns the plaintext secret token once.","parameters":[],"responses":{"201":{"description":"API key created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminApiKeyResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminCreateAPIKeyRequest"}}}}}},"/api/admin/api-keys/{identifier}":{"get":{"summary":"Get API key","operationId":"adminGetAPIKey","description":"Returns a single application API key by identifier without exposing its token.","parameters":[],"responses":{"200":{"description":"API key returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminApiKeyResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"put":{"summary":"Update API key","operationId":"adminUpdateAPIKey","description":"Updates an application API key memo and resource permissions without regenerating the token.","parameters":[],"responses":{"200":{"description":"API key updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminApiKeyResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Admin API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminUpdateAPIKeyRequest"}}}}},"delete":{"summary":"Delete API key","operationId":"adminDeleteAPIKey","description":"Deletes an application API key by identifier.","parameters":[],"responses":{"204":{"description":"API key deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]},"parameters":[{"in":"path","name":"identifier","description":"The server UUID or short UUID.","required":true,"schema":{"$ref":"#/components/schemas/AdminGetAPIKeyIdentifierPathParameter"},"examples":{"default":{"value":"d3aac109"}}}]},"/api/admin/version":{"get":{"summary":"Get version information","operationId":"adminGetVersionInformation","description":"Returns panel, Wings, and project version metadata.","parameters":[],"responses":{"200":{"description":"Version information returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminVersionInformationResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Admin API"]}},"/api/application/users":{"get":{"summary":"List users","operationId":"applicationListUsers","description":"Returns a paginated list of panel users visible to the application API key.","parameters":[{"in":"query","name":"per_page","description":"Number of users to return per page, up to 100.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListUsersPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"filter[email]","description":"Filter users by email address.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListUsersFilterEmailQueryParameter"},"examples":{"default":{"value":"user@example.com"}}},{"in":"query","name":"filter[uuid]","description":"Filter users by UUID.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListUsersFilterUuidQueryParameter"},"examples":{"default":{"value":"0d1f6f4d-9f78-4cf9-9d5a-6f7f4c9f4d6a"}}},{"in":"query","name":"filter[username]","description":"Filter users by username.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListUsersFilterUsernameQueryParameter"},"examples":{"default":{"value":"example-user"}}},{"in":"query","name":"filter[external_id]","description":"Filter users by external identifier.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListUsersFilterExternalIdQueryParameter"},"examples":{"default":{"value":"billing-system-42"}}},{"in":"query","name":"sort","description":"Sort users by id or uuid. Prefix with \"-\" for descending order.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListUsersSortQueryParameter"},"examples":{"default":{"value":"-id"}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"servers\" when the key can read servers.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListUsersIncludeQueryParameter"},"examples":{"default":{"value":"servers"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUserPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"post":{"summary":"Create user","operationId":"applicationCreateUser","description":"Creates a new panel user and returns the created resource.","parameters":[],"responses":{"201":{"description":"User created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUserResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreateUserRequest"}}}}}},"/api/application/users/{user_id}":{"get":{"summary":"Get user","operationId":"applicationGetUser","description":"Returns a single panel user by internal numeric ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"servers\" when the key can read servers.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationGetUserIncludeQueryParameter"},"examples":{"default":{"value":"servers"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUserResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"patch":{"summary":"Update user","operationId":"applicationUpdateUser","description":"Updates account details for an existing panel user.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUserResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpdateUserRequest"}}}}},"delete":{"summary":"Delete user","operationId":"applicationDeleteUser","description":"Deletes a panel user by internal numeric ID.","parameters":[],"responses":{"204":{"description":"User deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"user_id","description":"The user ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationGetUserUserIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/users/external/{external_id}":{"get":{"summary":"Get user by external ID","operationId":"applicationGetUserByExternalID","description":"Returns a single panel user by its external identifier.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUserResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"external_id","description":"The external ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationGetUserByExternalIDExternalIdPathParameter"},"examples":{"default":{"value":"external-identifier"}}}]},"/api/application/nodes":{"get":{"summary":"List nodes","operationId":"applicationListNodes","description":"Returns a paginated list of Wings nodes registered on the panel.","parameters":[{"in":"query","name":"per_page","description":"Number of nodes to return per page, up to 100.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodesPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"filter[uuid]","description":"Filter nodes by UUID.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodesFilterUuidQueryParameter"},"examples":{"default":{"value":"3d8dd7f9-07a1-4d65-8db0-8c8921f2f4f7"}}},{"in":"query","name":"filter[name]","description":"Filter nodes by name.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodesFilterNameQueryParameter"},"examples":{"default":{"value":"Node 1"}}},{"in":"query","name":"filter[fqdn]","description":"Filter nodes by fully qualified domain name.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodesFilterFqdnQueryParameter"},"examples":{"default":{"value":"node.example.com"}}},{"in":"query","name":"filter[daemon_token_id]","description":"Filter nodes by daemon token identifier.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodesFilterDaemonTokenIdQueryParameter"},"examples":{"default":{"value":"abcdefghijklmnop"}}},{"in":"query","name":"sort","description":"Sort nodes by id, uuid, memory, or disk. Prefix with \"-\" for descending order.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodesSortQueryParameter"},"examples":{"default":{"value":"-id"}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"allocations\", \"location\", and \"servers\" when the key can read those resources.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodesIncludeQueryParameter"},"examples":{"default":{"value":"location,allocations"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationNodePaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"post":{"summary":"Create node","operationId":"applicationCreateNode","description":"Creates a new Wings node and returns the created resource.","parameters":[],"responses":{"201":{"description":"Node created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationNodeResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreateNodeRequest"}}}}}},"/api/application/nodes/deployable":{"get":{"summary":"List deployable nodes","operationId":"applicationListDeployableNodes","description":"Returns nodes that can satisfy the requested memory, disk, and optional location deployment constraints.","parameters":[{"in":"query","name":"memory","description":"Memory required for the deployment, in megabytes.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationListDeployableNodesMemoryQueryParameter"},"examples":{"default":{"value":1024}}},{"in":"query","name":"disk","description":"Disk required for the deployment, in megabytes.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationListDeployableNodesDiskQueryParameter"},"examples":{"default":{"value":10240}}},{"in":"query","name":"location_ids","description":"Restrict results to these location IDs.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListDeployableNodesLocationIdsQueryParameter"},"examples":{"default":{"value":[1,2]}}},{"in":"query","name":"page","description":"Page number to return. When omitted, all viable nodes are returned without pagination metadata.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListDeployableNodesPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Number of nodes to return per page when page is supplied, up to 100.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListDeployableNodesPerPageQueryParameter"},"examples":{"default":{"value":50}}}],"responses":{"200":{"description":"Deployable nodes returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationNodeListResponse"}}}},"400":{"description":"No nodes can satisfy the requested deployment constraints.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"]}},"/api/application/nodes/{node_id}":{"get":{"summary":"Get node","operationId":"applicationGetNode","description":"Returns a single Wings node by internal numeric ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"allocations\", \"location\", and \"servers\" when the key can read those resources.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationGetNodeIncludeQueryParameter"},"examples":{"default":{"value":"location,allocations"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationNodeResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"delete":{"summary":"Delete node","operationId":"applicationDeleteNode","description":"Deletes a Wings node by internal numeric ID when no servers are attached.","parameters":[],"responses":{"204":{"description":"Node deleted."},"400":{"description":"The node has active servers attached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationGetNodeNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/nodes/{node_id}/configuration":{"get":{"summary":"Get node configuration","operationId":"applicationGetNodeConfiguration","description":"Returns the Wings configuration payload for a node, including node authentication tokens.","parameters":[],"responses":{"200":{"description":"Node configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationGetNodeConfigurationResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationGetNodeConfigurationNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/nodes/{id}":{"patch":{"summary":"Update node","operationId":"applicationUpdateNode","description":"Updates an existing Wings node by internal numeric ID.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationNodeResource"}}}},"400":{"description":"The panel saved the node changes but could not persist the configuration to Wings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpdateNodeRequest"}}}}},"parameters":[{"in":"path","name":"id","description":"The resource ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationUpdateNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/nodes/{node_id}/allocations":{"get":{"summary":"List node allocations","operationId":"applicationListNodeAllocations","description":"Returns a paginated list of allocations belonging to a node.","parameters":[{"in":"query","name":"per_page","description":"Number of allocations to return per page, up to 100.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodeAllocationsPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"filter[ip]","description":"Filter allocations by exact IP address.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodeAllocationsFilterIpQueryParameter"},"examples":{"default":{"value":"192.0.2.10"}}},{"in":"query","name":"filter[port]","description":"Filter allocations by exact port.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodeAllocationsFilterPortQueryParameter"},"examples":{"default":{"value":25565}}},{"in":"query","name":"filter[ip_alias]","description":"Filter allocations by IP alias.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodeAllocationsFilterIpAliasQueryParameter"},"examples":{"default":{"value":"minecraft.example.com"}}},{"in":"query","name":"filter[server_id]","description":"Filter allocations by assigned server ID. Empty or non-numeric values return unassigned allocations.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodeAllocationsFilterServerIdQueryParameter"},"examples":{"default":{"value":"1"}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"node\" and \"server\" when the key can read those resources.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListNodeAllocationsIncludeQueryParameter"},"examples":{"default":{"value":"server"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationAllocationPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"post":{"summary":"Create node allocations","operationId":"applicationCreateNodeAllocations","description":"Assigns one or more allocation ports to a node.","parameters":[],"responses":{"204":{"description":"Allocations created."},"400":{"description":"The allocation IP, CIDR, or port mapping could not be processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreateNodeAllocationsRequest"}}}}},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationListNodeAllocationsNodeIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/nodes/{node_id}/allocations/{allocation_id}":{"delete":{"summary":"Delete node allocation","operationId":"applicationDeleteNodeAllocation","description":"Deletes an allocation from a node when no server is using it.","parameters":[],"responses":{"204":{"description":"Allocation deleted."},"400":{"description":"The allocation is currently assigned to a server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"node_id","description":"The node ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationDeleteNodeAllocationNodeIdPathParameter"},"examples":{"default":{"value":1}}},{"in":"path","name":"allocation_id","description":"The ID of the allocation.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationDeleteNodeAllocationAllocationIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/locations":{"get":{"summary":"List locations","operationId":"applicationListLocations","description":"Returns a paginated list of all locations registered on the panel.","parameters":[{"in":"query","name":"per_page","description":"Number of locations to return per page, up to 100.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListLocationsPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"filter[short]","description":"Filter locations by short identifier.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListLocationsFilterShortQueryParameter"},"examples":{"default":{"value":"us-east"}}},{"in":"query","name":"filter[long]","description":"Filter locations by description.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListLocationsFilterLongQueryParameter"},"examples":{"default":{"value":"US East Datacenter"}}},{"in":"query","name":"sort","description":"Sort locations by id. Prefix with \"-\" for descending order.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListLocationsSortQueryParameter"},"examples":{"default":{"value":"id"}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"nodes\" and \"servers\" when the key can read those resources.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListLocationsIncludeQueryParameter"},"examples":{"default":{"value":"nodes,servers"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationLocationPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"post":{"summary":"Create location","operationId":"applicationCreateLocation","description":"Creates a new location and returns the created resource.","parameters":[],"responses":{"201":{"description":"Location created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationLocationResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreateLocationRequest"}}}}}},"/api/application/locations/{location_id}":{"get":{"summary":"Get location","operationId":"applicationGetLocation","description":"Returns a single location by internal numeric ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"nodes\" and \"servers\" when the key can read those resources.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationGetLocationIncludeQueryParameter"},"examples":{"default":{"value":"nodes,servers"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationLocationResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"patch":{"summary":"Update location","operationId":"applicationUpdateLocation","description":"Updates an existing location by internal numeric ID.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationLocationResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpdateLocationRequest"}}}}},"delete":{"summary":"Delete location","operationId":"applicationDeleteLocation","description":"Deletes a location by internal numeric ID.","parameters":[],"responses":{"204":{"description":"Location deleted."},"400":{"description":"The location has active nodes attached.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"location_id","description":"The location ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationGetLocationLocationIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/eggs":{"get":{"summary":"List eggs","operationId":"applicationListEggs","description":"Returns a paginated list of server eggs available on the panel.","parameters":[{"in":"query","name":"per_page","description":"Number of eggs to return per page, up to 100.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListEggsPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"filter[name]","description":"Filter eggs by name.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListEggsFilterNameQueryParameter"},"examples":{"default":{"value":"Paper"}}},{"in":"query","name":"filter[tag]","description":"Filter eggs by tag slug. Separate several slugs with commas to return eggs that carry any of them.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListEggsFilterTagQueryParameter"},"examples":{"default":{"value":"minecraft"}}},{"in":"query","name":"sort","description":"Sort eggs by id or name. Prefix with \"-\" for descending order.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListEggsSortQueryParameter"},"examples":{"default":{"value":"name"}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"servers\", \"config\", \"script\", \"variables\", and \"tags\" when the key can read those resources.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListEggsIncludeQueryParameter"},"examples":{"default":{"value":"variables"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationEggPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]}},"/api/application/eggs/{egg_id}":{"get":{"summary":"Get egg","operationId":"applicationGetEgg","description":"Returns a single egg by internal numeric ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"servers\", \"config\", \"script\", \"variables\", and \"tags\" when the key can read those resources.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationGetEggIncludeQueryParameter"},"examples":{"default":{"value":"variables"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationEggResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"egg_id","description":"The egg ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationGetEggEggIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/tags":{"get":{"summary":"List tags","operationId":"applicationListTags","description":"Returns a paginated list of the tags that group eggs.","parameters":[{"in":"query","name":"per_page","description":"Number of tags to return per page, up to 100.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListTagsPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"filter[name]","description":"Filter tags by name.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListTagsFilterNameQueryParameter"},"examples":{"default":{"value":"Minecraft"}}},{"in":"query","name":"filter[slug]","description":"Filter tags by slug.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListTagsFilterSlugQueryParameter"},"examples":{"default":{"value":"minecraft"}}},{"in":"query","name":"sort","description":"Sort tags by id, name, or slug. Prefix with \"-\" for descending order.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListTagsSortQueryParameter"},"examples":{"default":{"value":"name"}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"eggs\" and \"nodes\" when the key can read those resources.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListTagsIncludeQueryParameter"},"examples":{"default":{"value":"eggs"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationTagPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]}},"/api/application/tags/{tag_id}":{"get":{"summary":"Get tag","operationId":"applicationGetTag","description":"Returns a single tag by internal numeric ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"eggs\" and \"nodes\" when the key can read those resources.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationGetTagIncludeQueryParameter"},"examples":{"default":{"value":"eggs"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationTagResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"tag_id","description":"The ID of the tag.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationGetTagTagIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/servers":{"get":{"summary":"List servers","operationId":"applicationListServers","description":"Returns a paginated list of servers visible to the application API key.","parameters":[{"in":"query","name":"per_page","description":"Number of servers to return per page, up to 100.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListServersPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"filter[uuid]","description":"Filter servers by UUID.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListServersFilterUuidQueryParameter"},"examples":{"default":{"value":"4fcb1f44-0f90-4a1a-a8bf-7cc8a14d0f26"}}},{"in":"query","name":"filter[uuidShort]","description":"Filter servers by short UUID identifier.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListServersFilterUuidShortQueryParameter"},"examples":{"default":{"value":"4fcb1f44"}}},{"in":"query","name":"filter[name]","description":"Filter servers by name.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListServersFilterNameQueryParameter"},"examples":{"default":{"value":"Minecraft Server"}}},{"in":"query","name":"filter[description]","description":"Filter servers by description.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListServersFilterDescriptionQueryParameter"},"examples":{"default":{"value":"Production"}}},{"in":"query","name":"filter[image]","description":"Filter servers by Docker image.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListServersFilterImageQueryParameter"},"examples":{"default":{"value":"ghcr.io/pterodactyl/yolks:java_23"}}},{"in":"query","name":"filter[external_id]","description":"Filter servers by external identifier.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListServersFilterExternalIdQueryParameter"},"examples":{"default":{"value":"billing-server-42"}}},{"in":"query","name":"search","description":"Search term accepted by the list request. Must not exceed 100 characters.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListServersSearchQueryParameter"},"examples":{"default":{"value":"minecraft"}}},{"in":"query","name":"sort","description":"Sort servers by id or uuid. Prefix with \"-\" for descending order.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListServersSortQueryParameter"},"examples":{"default":{"value":"-id"}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"allocations\", \"user\", \"subusers\", \"egg\", \"variables\", \"location\", \"node\", \"databases\", and \"transfer\" when the key can read those resources.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListServersIncludeQueryParameter"},"examples":{"default":{"value":"user,node,allocations"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationServerPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"]},"post":{"summary":"Create server","operationId":"applicationCreateServer","description":"Creates a new server using either explicit allocations or automatic deployment constraints.","parameters":[],"responses":{"201":{"description":"Server created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationServerResource"}}}},"400":{"description":"Automatic deployment could not find a viable node or allocation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreateServerRequest"}}}}}},"/api/application/servers/{server_id}":{"get":{"summary":"Get server","operationId":"applicationGetServer","description":"Returns a single server by internal numeric ID.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"allocations\", \"user\", \"subusers\", \"egg\", \"variables\", \"location\", \"node\", \"databases\", and \"transfer\" when the key can read those resources.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationGetServerIncludeQueryParameter"},"examples":{"default":{"value":"user,node,allocations"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationServerResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"delete":{"summary":"Delete server","operationId":"applicationDeleteServerForServersServerId","description":"Deletes a server. The force route bypasses recoverable Wings or database host deletion failures.","parameters":[],"responses":{"204":{"description":"Server deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"server_id","description":"The server ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationGetServerServerIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/servers/external/{external_id}":{"get":{"summary":"Get server by external ID","operationId":"applicationGetServerByExternalID","description":"Returns a single server by its external identifier.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationServerResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"external_id","description":"The external ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationGetServerByExternalIDExternalIdPathParameter"},"examples":{"default":{"value":"external-identifier"}}}]},"/api/application/servers/{server_id}/details":{"patch":{"summary":"Update server details","operationId":"applicationUpdateServerDetails","description":"Updates ownership and display details for a server.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationServerResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpdateServerDetailsRequest"}}}}},"parameters":[{"in":"path","name":"server_id","description":"The server ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationUpdateServerDetailsServerIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/servers/{server_id}/build":{"patch":{"summary":"Update server build","operationId":"applicationUpdateServerBuild","description":"Updates resource limits, feature limits, and allocations for a server.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationServerResource"}}}},"400":{"description":"The requested allocation change is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpdateServerBuildRequest"}}}}},"parameters":[{"in":"path","name":"server_id","description":"The server ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationUpdateServerBuildServerIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/servers/{server_id}/startup":{"patch":{"summary":"Update server startup","operationId":"applicationUpdateServerStartup","description":"Updates startup command, image, egg, and environment variables for a server.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationServerResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"504":{"description":"Wings could not be reached while syncing startup changes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpdateServerStartupRequest"}}}}},"parameters":[{"in":"path","name":"server_id","description":"The server ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationUpdateServerStartupServerIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/servers/{server_id}/suspend":{"post":{"summary":"Suspend server","operationId":"applicationSuspendServer","description":"Marks a server as suspended and syncs the state to Wings.","parameters":[],"responses":{"204":{"description":"Server suspended."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"The server is currently being transferred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Wings could not be reached while syncing suspension state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"server_id","description":"The server ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationSuspendServerServerIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/servers/{server_id}/unsuspend":{"post":{"summary":"Unsuspend server","operationId":"applicationUnsuspendServer","description":"Clears a server suspension and syncs the state to Wings.","parameters":[],"responses":{"204":{"description":"Server unsuspended."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"The server is currently being transferred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Wings could not be reached while syncing suspension state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"server_id","description":"The server ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationUnsuspendServerServerIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/servers/{server_id}/reinstall":{"post":{"summary":"Reinstall server","operationId":"applicationReinstallServer","description":"Marks a server for reinstall and asks Wings to reinstall it.","parameters":[],"responses":{"204":{"description":"Server marked for reinstall."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"504":{"description":"Wings could not be reached while starting reinstall.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"server_id","description":"The server ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationReinstallServerServerIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/servers/{server_id}/{force}":{"delete":{"summary":"Delete server","operationId":"applicationDeleteServerForServersServerIdForce","description":"Deletes a server. The force route bypasses recoverable Wings or database host deletion failures.","parameters":[],"responses":{"204":{"description":"Server deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"server_id","description":"The server ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationDeleteServerServerIdPathParameter"},"examples":{"default":{"value":1}}},{"in":"path","name":"force","description":"Optional parameter. Whether to force the delete operation.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationDeleteServerForcePathParameter"},"examples":{"omitted":{"summary":"When the value is omitted","value":""},"present":{"summary":"When the value is present","value":"force"}}}]},"/api/application/servers/{server_id}/databases":{"get":{"summary":"List server databases","operationId":"applicationListServerDatabases","description":"Returns all databases attached to a server.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"password\" and \"host\" when the key can read database hosts.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationListServerDatabasesIncludeQueryParameter"},"examples":{"default":{"value":"password,host"}}}],"responses":{"200":{"description":"Server databases returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationServerDatabaseListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"post":{"summary":"Create server database","operationId":"applicationCreateServerDatabase","description":"Creates a database for a server on a configured database host.","parameters":[],"responses":{"201":{"description":"Database created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationServerDatabaseResource"}}}},"400":{"description":"The server has reached its configured database limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Application API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreateServerDatabaseRequest"}}}}},"parameters":[{"in":"path","name":"server_id","description":"The server ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationListServerDatabasesServerIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/application/servers/{server_id}/databases/{database_id}":{"get":{"summary":"Get server database","operationId":"applicationGetServerDatabase","description":"Returns a single database attached to a server.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"password\" and \"host\" when the key can read database hosts.","required":false,"schema":{"$ref":"#/components/schemas/ApplicationGetServerDatabaseIncludeQueryParameter"},"examples":{"default":{"value":"password,host"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationServerDatabaseResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"delete":{"summary":"Delete server database","operationId":"applicationDeleteServerDatabase","description":"Deletes a database attached to a server.","parameters":[],"responses":{"204":{"description":"Database deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"server_id","description":"The server ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationGetServerDatabaseServerIdPathParameter"},"examples":{"default":{"value":1}}},{"in":"path","name":"database_id","description":"The database ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationGetServerDatabaseDatabaseIdPathParameter"},"examples":{"default":{"value":"Lk3jx4pQ"}}}]},"/api/application/servers/{server_id}/databases/{database_id}/reset-password":{"post":{"summary":"Reset server database password","operationId":"applicationResetServerDatabasePassword","description":"Rotates the password for a database attached to a server.","parameters":[],"responses":{"204":{"description":"Database password reset."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Application API"]},"parameters":[{"in":"path","name":"server_id","description":"The server ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationResetServerDatabasePasswordServerIdPathParameter"},"examples":{"default":{"value":1}}},{"in":"path","name":"database_id","description":"The database ID.","required":true,"schema":{"$ref":"#/components/schemas/ApplicationResetServerDatabasePasswordDatabaseIdPathParameter"},"examples":{"default":{"value":"Lk3jx4pQ"}}}]},"/auth/login":{"post":{"summary":"Login","operationId":"authLogin","description":"Authenticates a browser session. Returns a complete login payload, or a two-factor checkpoint token when the account requires a second factor.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthLoginResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Authentication"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthLoginRequest"}}}},"security":[]}},"/auth/login/checkpoint":{"post":{"summary":"Complete login checkpoint","operationId":"authCompleteLoginCheckpoint","description":"Completes a two-factor login checkpoint using either a TOTP code or a recovery token.","parameters":[],"responses":{"200":{"description":"Login completed and a browser session was created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthLoginCompleteResponse"}}}},"400":{"description":"The checkpoint token, TOTP code, or recovery token is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Authentication"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthCompleteLoginCheckpointRequest"}}}},"security":[]}},"/auth/password":{"post":{"summary":"Request password reset email","operationId":"authRequestPasswordResetEmail","description":"Sends a password reset email when the account exists. The response is intentionally the same when no matching account is found.","parameters":[],"responses":{"200":{"description":"Password reset email accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthPasswordResetEmailResponse"}}}},"400":{"description":"The reCAPTCHA token is invalid or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Authentication"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthRequestPasswordResetEmailRequest"}}}},"security":[]}},"/auth/password/reset":{"post":{"summary":"Reset password","operationId":"authResetPassword","description":"Resets an account password using a password reset token. The response tells the frontend whether the user must return to the login form.","parameters":[],"responses":{"200":{"description":"Password reset completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResetPasswordResponse"}}}},"400":{"description":"The reset token is invalid or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Authentication"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResetPasswordRequest"}}}},"security":[]}},"/auth/logout":{"post":{"summary":"Logout","operationId":"authLogout","description":"Destroys the current browser session and regenerates the CSRF token.","parameters":[],"responses":{"204":{"description":"The browser session was destroyed."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Authentication"],"security":[{"panelSession":[]}]}},"/api/client":{"get":{"summary":"List client servers","operationId":"clientListClientServers","description":"Returns a paginated list of servers the authenticated user can access as an owner, subuser, or administrator.","parameters":[{"in":"query","name":"page","description":"Page number to return.","required":false,"schema":{"$ref":"#/components/schemas/ClientListClientServersPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Number of servers to return per page. The maximum is 100.","required":false,"schema":{"$ref":"#/components/schemas/ClientListClientServersPerPageQueryParameter"},"examples":{"default":{"value":50}}},{"in":"query","name":"type","description":"Scope of servers to return. \"owner\" returns owned servers, \"admin\" returns admin-accessible servers excluding owned or subuser servers, and \"admin-all\" returns all servers for root administrators.","required":false,"schema":{"$ref":"#/components/schemas/ClientListClientServersTypeQueryParameter"},"examples":{"default":{"value":"owner"}}},{"in":"query","name":"filter[uuid]","description":"Filter servers by UUID.","required":false,"schema":{"$ref":"#/components/schemas/ClientListClientServersFilterUuidQueryParameter"},"examples":{"default":{"value":"4fcb1f44-0f90-4a1a-a8bf-7cc8a14d0f26"}}},{"in":"query","name":"filter[name]","description":"Filter servers by name.","required":false,"schema":{"$ref":"#/components/schemas/ClientListClientServersFilterNameQueryParameter"},"examples":{"default":{"value":"Minecraft Server"}}},{"in":"query","name":"filter[description]","description":"Filter servers by description.","required":false,"schema":{"$ref":"#/components/schemas/ClientListClientServersFilterDescriptionQueryParameter"},"examples":{"default":{"value":"Production"}}},{"in":"query","name":"filter[external_id]","description":"Filter servers by external identifier.","required":false,"schema":{"$ref":"#/components/schemas/ClientListClientServersFilterExternalIdQueryParameter"},"examples":{"default":{"value":"billing-server-42"}}},{"in":"query","name":"filter[*]","description":"Search across server name, UUID, short UUID, external identifier, or allocation address and port.","required":false,"schema":{"$ref":"#/components/schemas/ClientListClientServersFilterWildcardQueryParameter"},"examples":{"default":{"value":"192.0.2.10:25565"}}}],"responses":{"200":{"description":"Accessible servers returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"]}},"/api/client/permissions":{"get":{"summary":"List server permissions","operationId":"clientListServerPermissions","description":"Returns the permission keys that can be granted to server subusers.","parameters":[],"responses":{"200":{"description":"System permission definitions returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSystemPermissionsResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]}},"/api/client/account":{"get":{"summary":"Get account","operationId":"clientGetAccount","description":"Returns profile details for the authenticated user.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientUserResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]}},"/api/client/account/two-factor":{"get":{"summary":"Get two-factor setup","operationId":"clientGetTwoFactorSetup","description":"Creates or returns the current two-factor setup payload for the authenticated user.","parameters":[],"responses":{"200":{"description":"Two-factor setup data returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientTwoFactorSetupResponse"}}}},"400":{"description":"Two-factor authentication is already enabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"post":{"summary":"Enable two-factor authentication","operationId":"clientEnableTwoFactorAuthentication","description":"Enables two-factor authentication for the authenticated user and returns one-time recovery tokens.","parameters":[],"responses":{"200":{"description":"Two-factor authentication enabled. Store these recovery tokens now; they are not shown again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRecoveryTokensResource"}}}},"400":{"description":"The password or TOTP code is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientEnableTwoFactorAuthenticationRequest"}}}}}},"/api/client/account/two-factor/disable":{"post":{"summary":"Disable two-factor authentication","operationId":"clientDisableTwoFactorAuthentication","description":"Disables two-factor authentication for the authenticated user after verifying their password.","parameters":[],"responses":{"204":{"description":"Two-factor authentication disabled."},"400":{"description":"The password is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDisableTwoFactorAuthenticationRequest"}}}}}},"/api/client/account/email":{"put":{"summary":"Update account email","operationId":"clientUpdateAccountEmail","description":"Updates the authenticated user's email address after verifying their current password.","parameters":[],"responses":{"204":{"description":"Email address updated."},"400":{"description":"The current password is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"429":{"description":"The account has changed email too many times in the current throttle window.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientUpdateAccountEmailRequest"}}}}}},"/api/client/account/password":{"put":{"summary":"Update account password","operationId":"clientUpdateAccountPassword","description":"Updates the authenticated user's password and revokes other active sessions where supported.","parameters":[],"responses":{"204":{"description":"Password updated."},"400":{"description":"The current password is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientUpdateAccountPasswordRequest"}}}}}},"/api/client/account/activity":{"get":{"summary":"List account activity","operationId":"clientListAccountActivity","description":"Returns a paginated list of activity log entries for the authenticated user account.","parameters":[{"in":"query","name":"page","description":"Page number to retrieve.","required":false,"schema":{"$ref":"#/components/schemas/ClientListAccountActivityPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Number of activity log entries to return per page. The maximum is 100.","required":false,"schema":{"$ref":"#/components/schemas/ClientListAccountActivityPerPageQueryParameter"},"examples":{"default":{"value":25}}},{"in":"query","name":"filter[event]","description":"Filter activity by event name.","required":false,"schema":{"$ref":"#/components/schemas/ClientListAccountActivityFilterEventQueryParameter"},"examples":{"default":{"value":"user:account.email-changed"}}},{"in":"query","name":"sort","description":"Sort activity by timestamp. Prefix with \"-\" for descending order.","required":false,"schema":{"$ref":"#/components/schemas/ClientListAccountActivitySortQueryParameter"},"examples":{"default":{"value":"-timestamp"}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports actor.","required":false,"schema":{"$ref":"#/components/schemas/ClientListAccountActivityIncludeQueryParameter"},"examples":{"default":{"value":"actor"}}}],"responses":{"200":{"description":"Activity logs returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientActivityLogPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]}},"/api/client/account/api-keys":{"get":{"summary":"List account API keys","operationId":"clientListAccountAPIKeys","description":"Returns all client API keys owned by the authenticated user.","parameters":[],"responses":{"200":{"description":"API keys returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientApiKeyListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"post":{"summary":"Create account API key","operationId":"clientCreateAccountAPIKey","description":"Creates a client API key for the authenticated user and returns the secret token once.","parameters":[],"responses":{"200":{"description":"API key created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientApiKeyResource"}}}},"400":{"description":"The account already has the maximum number of API keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCreateAccountAPIKeyRequest"}}}}}},"/api/client/account/api-keys/{identifier}":{"delete":{"summary":"Delete account API key","operationId":"clientDeleteAccountAPIKey","description":"Deletes one client API key owned by the authenticated user.","parameters":[],"responses":{"204":{"description":"API key deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"identifier","description":"The server UUID or short UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientDeleteAccountAPIKeyIdentifierPathParameter"},"examples":{"default":{"value":"d3aac109"}}}]},"/api/client/account/ssh-keys":{"get":{"summary":"List SSH keys","operationId":"clientListSSHKeys","description":"Returns all SSH public keys configured for the authenticated user.","parameters":[],"responses":{"200":{"description":"SSH keys returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSshKeyListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"post":{"summary":"Create SSH key","operationId":"clientCreateSSHKey","description":"Adds an SSH public key to the authenticated user account.","parameters":[],"responses":{"200":{"description":"SSH key created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSshKeyResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCreateSSHKeyRequest"}}}}}},"/api/client/account/ssh-keys/remove":{"post":{"summary":"Delete SSH key","operationId":"clientDeleteSSHKey","description":"Deletes an SSH key from the authenticated user account by fingerprint. Missing keys are treated as already deleted.","parameters":[],"responses":{"204":{"description":"SSH key deleted or already absent."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDeleteSSHKeyRequest"}}}}}},"/api/client/servers/{server_uuid}":{"get":{"summary":"Get server","operationId":"clientGetServer","description":"Returns details for one server the authenticated user can access.","parameters":[],"responses":{"200":{"description":"Server details returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetServerServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/websocket":{"get":{"summary":"Get websocket credentials","operationId":"clientGetWebsocketCredentials","description":"Returns a short-lived Wings websocket token and socket URL for the server.","parameters":[],"responses":{"200":{"description":"Websocket credentials returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientGetWebsocketCredentialsResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetWebsocketCredentialsServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/resources":{"get":{"summary":"Get server resources","operationId":"clientGetServerResources","description":"Returns the latest cached resource utilization reported by Wings for the server.","parameters":[],"responses":{"200":{"description":"Resource utilization returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientStatsResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"502":{"description":"Wings could not be reached for resource utilization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetServerResourcesServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/activity":{"get":{"summary":"List server activity","operationId":"clientListServerActivity","description":"Returns a paginated list of activity log entries for the server.","parameters":[{"in":"query","name":"page","description":"Page number to retrieve.","required":false,"schema":{"$ref":"#/components/schemas/ClientListServerActivityPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Number of activity log entries to return per page. The maximum is 100.","required":false,"schema":{"$ref":"#/components/schemas/ClientListServerActivityPerPageQueryParameter"},"examples":{"default":{"value":25}}},{"in":"query","name":"filter[event]","description":"Filter activity by event name.","required":false,"schema":{"$ref":"#/components/schemas/ClientListServerActivityFilterEventQueryParameter"},"examples":{"default":{"value":"server:power.start"}}},{"in":"query","name":"sort","description":"Sort activity by timestamp. Prefix with \"-\" for descending order.","required":false,"schema":{"$ref":"#/components/schemas/ClientListServerActivitySortQueryParameter"},"examples":{"default":{"value":"-timestamp"}}},{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports actor.","required":false,"schema":{"$ref":"#/components/schemas/ClientListServerActivityIncludeQueryParameter"},"examples":{"default":{"value":"actor"}}}],"responses":{"200":{"description":"Server activity logs returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientActivityLogPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientListServerActivityServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/command":{"post":{"summary":"Send server command","operationId":"clientSendServerCommand","description":"Sends a console command to the running server through Wings.","parameters":[],"responses":{"204":{"description":"Command accepted by Wings."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"The server is not online or Wings rejected the command.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSendServerCommandRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientSendServerCommandServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/power":{"post":{"summary":"Send power action","operationId":"clientSendPowerAction","description":"Sends a power signal to the server through Wings.","parameters":[],"responses":{"204":{"description":"Power signal accepted by Wings."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSendPowerActionRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientSendPowerActionServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/databases":{"get":{"summary":"List server databases","operationId":"clientListServerDatabases","description":"Returns databases attached to a server visible to the authenticated user.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"password\" when the user can view database passwords.","required":false,"schema":{"$ref":"#/components/schemas/ClientListServerDatabasesIncludeQueryParameter"},"examples":{"default":{"value":"password"}}}],"responses":{"200":{"description":"Server databases returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerDatabaseListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"post":{"summary":"Create server database","operationId":"clientCreateServerDatabase","description":"Creates a database for a server on an automatically selected database host.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"password\" when the user can view database passwords.","required":false,"schema":{"$ref":"#/components/schemas/ClientCreateServerDatabaseIncludeQueryParameter"},"examples":{"default":{"value":"password"}}}],"responses":{"200":{"description":"Database created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerDatabaseResource"}}}},"400":{"description":"The server has reached its configured database limit or client database creation is disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCreateServerDatabaseRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientListServerDatabasesServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/databases/{database_id}/rotate-password":{"post":{"summary":"Rotate server database password","operationId":"clientRotateServerDatabasePassword","description":"Rotates the password for a database attached to a server and returns the updated database.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports \"password\" when the user can view database passwords.","required":false,"schema":{"$ref":"#/components/schemas/ClientRotateServerDatabasePasswordIncludeQueryParameter"},"examples":{"default":{"value":"password"}}}],"responses":{"200":{"description":"Database password rotated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerDatabaseResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientRotateServerDatabasePasswordServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"database_id","description":"The database ID.","required":true,"schema":{"$ref":"#/components/schemas/ClientRotateServerDatabasePasswordDatabaseIdPathParameter"},"examples":{"default":{"value":"Lk3jx4pQ"}}}]},"/api/client/servers/{server_uuid}/databases/{database_id}":{"delete":{"summary":"Delete server database","operationId":"clientDeleteServerDatabase","description":"Deletes a database attached to a server.","parameters":[],"responses":{"204":{"description":"Database deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientDeleteServerDatabaseServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"database_id","description":"The database ID.","required":true,"schema":{"$ref":"#/components/schemas/ClientDeleteServerDatabaseDatabaseIdPathParameter"},"examples":{"default":{"value":"Lk3jx4pQ"}}}]},"/api/client/servers/{server_uuid}/files/list":{"get":{"summary":"List files","operationId":"clientListFiles","description":"Returns files and folders in a server directory.","parameters":[{"in":"query","name":"directory","description":"Directory to list. Defaults to the server root.","required":false,"schema":{"$ref":"#/components/schemas/ClientListFilesDirectoryQueryParameter"},"examples":{"default":{"value":"/config"}}}],"responses":{"200":{"description":"Directory contents returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientFileObjectListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not list the directory.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientListFilesServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/contents":{"get":{"summary":"Get file contents","operationId":"clientGetFileContents","description":"Returns raw text contents for a server file.","parameters":[{"in":"query","name":"file","description":"Path to the file to read.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetFileContentsFileQueryParameter"},"examples":{"default":{"value":"/server.properties"}}}],"responses":{"200":{"description":"File contents returned as text/plain.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ClientGetFileContentsResponseBody"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not read the file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetFileContentsServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/download":{"get":{"summary":"Get file download URL","operationId":"clientGetFileDownloadURL","description":"Returns a short-lived signed URL for downloading a server file directly from Wings.","parameters":[{"in":"query","name":"file","description":"Path to the file to download.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetFileDownloadURLFileQueryParameter"},"examples":{"default":{"value":"/server.properties"}}}],"responses":{"200":{"description":"Signed download URL returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSignedUrlResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not create the download URL.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetFileDownloadURLServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/rename":{"put":{"summary":"Rename files","operationId":"clientRenameFiles","description":"Renames one or more files or folders in a server directory.","parameters":[],"responses":{"204":{"description":"Files renamed."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not rename the files.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRenameFilesRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientRenameFilesServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/copy":{"post":{"summary":"Copy file","operationId":"clientCopyFile","description":"Creates a copy of a file on the server.","parameters":[],"responses":{"204":{"description":"File copied."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not copy the file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCopyFileRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientCopyFileServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/write":{"post":{"summary":"Write file contents","operationId":"clientWriteFileContents","description":"Writes the raw request body to a server file. This endpoint does not expect a JSON wrapper for the file contents.","parameters":[{"in":"query","name":"file","description":"Path to the file to write.","required":true,"schema":{"$ref":"#/components/schemas/ClientWriteFileContentsFileQueryParameter"},"examples":{"default":{"value":"/server.properties"}}}],"responses":{"204":{"description":"File contents written."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not write the file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ClientWriteFileContentsRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientWriteFileContentsServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/compress":{"post":{"summary":"Compress files","operationId":"clientCompressFiles","description":"Creates an archive from one or more files or folders in a server directory.","parameters":[],"responses":{"200":{"description":"Archive created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientFileObjectResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not create the archive.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCompressFilesRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientCompressFilesServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/decompress":{"post":{"summary":"Decompress file","operationId":"clientDecompressFile","description":"Extracts an archive in a server directory.","parameters":[],"responses":{"204":{"description":"Archive extracted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not extract the archive.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDecompressFileRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientDecompressFileServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/delete":{"post":{"summary":"Delete files","operationId":"clientDeleteFiles","description":"Deletes one or more files or folders from a server directory.","parameters":[],"responses":{"204":{"description":"Files deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not delete the files.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDeleteFilesRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientDeleteFilesServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/create-folder":{"post":{"summary":"Create folder","operationId":"clientCreateFolder","description":"Creates a folder in a server directory.","parameters":[],"responses":{"204":{"description":"Folder created."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not create the folder.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCreateFolderRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientCreateFolderServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/chmod":{"post":{"summary":"Change file permissions","operationId":"clientChangeFilePermissions","description":"Updates POSIX mode bits for one or more files or folders in a server directory.","parameters":[],"responses":{"204":{"description":"File permissions updated."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not update file permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientChangeFilePermissionsRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientChangeFilePermissionsServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/pull":{"post":{"summary":"Pull remote file","operationId":"clientPullRemoteFile","description":"Requests that Wings download a remote file into a server directory.","parameters":[],"responses":{"204":{"description":"Remote file pull queued or completed."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}},"502":{"description":"Wings could not pull the remote file.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientPullRemoteFileRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientPullRemoteFileServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/files/upload":{"get":{"summary":"Get file upload URL","operationId":"clientGetFileUploadURL","description":"Returns a short-lived signed URL for uploading a file directly to Wings.","parameters":[],"responses":{"200":{"description":"Signed upload URL returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSignedUrlResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetFileUploadURLServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/schedules":{"get":{"summary":"List server schedules","operationId":"clientListServerSchedules","description":"Returns all schedules configured for the server, including their tasks.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports tasks.","required":false,"schema":{"$ref":"#/components/schemas/ClientListServerSchedulesIncludeQueryParameter"},"examples":{"default":{"value":"tasks"}}}],"responses":{"200":{"description":"Server schedules returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerScheduleListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"post":{"summary":"Create server schedule","operationId":"clientCreateServerSchedule","description":"Creates a schedule for the server.","parameters":[],"responses":{"200":{"description":"Schedule created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerScheduleResource"}}}},"400":{"description":"The cron expression is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCreateServerScheduleRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientListServerSchedulesServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/schedules/{schedule_id}":{"get":{"summary":"Get server schedule","operationId":"clientGetServerSchedule","description":"Returns one schedule configured for the server, including its tasks.","parameters":[{"in":"query","name":"include","description":"Comma-separated relationships to include. Supports tasks.","required":false,"schema":{"$ref":"#/components/schemas/ClientGetServerScheduleIncludeQueryParameter"},"examples":{"default":{"value":"tasks"}}}],"responses":{"200":{"description":"Server schedule returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerScheduleResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"post":{"summary":"Update server schedule","operationId":"clientUpdateServerSchedule","description":"Updates a schedule for the server and recalculates its next run time.","parameters":[],"responses":{"200":{"description":"Schedule updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerScheduleResource"}}}},"400":{"description":"The cron expression is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientUpdateServerScheduleRequest"}}}}},"delete":{"summary":"Delete server schedule","operationId":"clientDeleteServerSchedule","description":"Deletes a schedule and its tasks from the server.","parameters":[],"responses":{"204":{"description":"Schedule deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetServerScheduleServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"schedule_id","description":"The schedule ID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetServerScheduleScheduleIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/client/servers/{server_uuid}/schedules/{schedule_id}/execute":{"post":{"summary":"Execute server schedule","operationId":"clientExecuteServerSchedule","description":"Queues a schedule to run immediately regardless of its active state.","parameters":[],"responses":{"202":{"description":"Schedule execution queued."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientExecuteServerScheduleServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"schedule_id","description":"The schedule ID.","required":true,"schema":{"$ref":"#/components/schemas/ClientExecuteServerScheduleScheduleIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/client/servers/{server_uuid}/schedules/{schedule_id}/tasks":{"post":{"summary":"Create schedule task","operationId":"clientCreateScheduleTask","description":"Creates a task in a server schedule.","parameters":[],"responses":{"200":{"description":"Schedule task created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientScheduleTaskResource"}}}},"400":{"description":"The schedule has reached its configured task limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCreateScheduleTaskRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientCreateScheduleTaskServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"schedule_id","description":"The schedule ID.","required":true,"schema":{"$ref":"#/components/schemas/ClientCreateScheduleTaskScheduleIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/client/servers/{server_uuid}/schedules/{schedule_id}/tasks/{task_id}":{"post":{"summary":"Update schedule task","operationId":"clientUpdateScheduleTask","description":"Updates a task in a server schedule, including its sequence position.","parameters":[],"responses":{"200":{"description":"Schedule task updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientScheduleTaskResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientUpdateScheduleTaskRequest"}}}}},"delete":{"summary":"Delete schedule task","operationId":"clientDeleteScheduleTask","description":"Deletes a task from a server schedule and compacts subsequent sequence IDs.","parameters":[],"responses":{"204":{"description":"Schedule task deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientUpdateScheduleTaskServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"schedule_id","description":"The schedule ID.","required":true,"schema":{"$ref":"#/components/schemas/ClientUpdateScheduleTaskScheduleIdPathParameter"},"examples":{"default":{"value":1}}},{"in":"path","name":"task_id","description":"The task ID.","required":true,"schema":{"$ref":"#/components/schemas/ClientUpdateScheduleTaskTaskIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/client/servers/{server_uuid}/network/allocations":{"get":{"summary":"List server allocations","operationId":"clientListServerAllocations","description":"Returns all network allocations assigned to the server.","parameters":[],"responses":{"200":{"description":"Server allocations returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientAllocationListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"post":{"summary":"Create server allocation","operationId":"clientCreateServerAllocation","description":"Assigns an available allocation to the server.","parameters":[],"responses":{"200":{"description":"Allocation assigned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientAllocationResource"}}}},"400":{"description":"The server has reached its configured allocation limit or no allocation is available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientListServerAllocationsServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/network/allocations/{allocation_id}":{"post":{"summary":"Update allocation notes","operationId":"clientUpdateAllocationNotes","description":"Updates notes attached to a server allocation.","parameters":[],"responses":{"200":{"description":"Allocation notes updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientAllocationResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientUpdateAllocationNotesRequest"}}}}},"delete":{"summary":"Delete server allocation","operationId":"clientDeleteServerAllocation","description":"Removes a non-primary allocation from the server and returns it to the available pool.","parameters":[],"responses":{"204":{"description":"Allocation removed."},"400":{"description":"The allocation cannot be removed because it is primary or the server has no allocation limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientUpdateAllocationNotesServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"allocation_id","description":"The ID of the allocation.","required":true,"schema":{"$ref":"#/components/schemas/ClientUpdateAllocationNotesAllocationIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/client/servers/{server_uuid}/network/allocations/{allocation_id}/primary":{"post":{"summary":"Set primary allocation","operationId":"clientSetPrimaryAllocation","description":"Sets the primary network allocation for the server.","parameters":[],"responses":{"200":{"description":"Primary allocation updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientAllocationResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientSetPrimaryAllocationServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"allocation_id","description":"The ID of the allocation.","required":true,"schema":{"$ref":"#/components/schemas/ClientSetPrimaryAllocationAllocationIdPathParameter"},"examples":{"default":{"value":1}}}]},"/api/client/servers/{server_uuid}/users":{"get":{"summary":"List server subusers","operationId":"clientListServerSubusers","description":"Returns subusers assigned to the server.","parameters":[],"responses":{"200":{"description":"Server subusers returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerSubuserListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"post":{"summary":"Create server subuser","operationId":"clientCreateServerSubuser","description":"Assigns an existing or new user as a subuser on the server.","parameters":[],"responses":{"200":{"description":"Server subuser created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerSubuserResource"}}}},"400":{"description":"The user is already assigned to the server or is the server owner.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCreateServerSubuserRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientListServerSubusersServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server}/users/{user}":{"get":{"summary":"Get server subuser","operationId":"clientGetServerSubuser","description":"Returns one subuser assignment for the server.","parameters":[],"responses":{"200":{"description":"Server subuser returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerSubuserResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetServerSubuserServerPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"user","description":"The user UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetServerSubuserUserPathParameter"},"examples":{"default":{"value":"0d1f6f4d-9f78-4cf9-9d5a-6f7f4c9f4d6a"}}}]},"/api/client/servers/{server_uuid}/users/{user}":{"post":{"summary":"Update server subuser","operationId":"clientUpdateServerSubuser","description":"Updates permissions for a server subuser and revokes their SFTP access tokens.","parameters":[],"responses":{"200":{"description":"Server subuser updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientServerSubuserResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientUpdateServerSubuserRequest"}}}}},"delete":{"summary":"Delete server subuser","operationId":"clientDeleteServerSubuser","description":"Removes a subuser assignment from the server and revokes SFTP access tokens.","parameters":[],"responses":{"204":{"description":"Server subuser removed."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientUpdateServerSubuserServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"user","description":"The user UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientUpdateServerSubuserUserPathParameter"},"examples":{"default":{"value":"0d1f6f4d-9f78-4cf9-9d5a-6f7f4c9f4d6a"}}}]},"/api/client/servers/{server_uuid}/backups":{"get":{"summary":"List server backups","operationId":"clientListServerBackups","description":"Returns a paginated list of backups for the server.","parameters":[{"in":"query","name":"page","description":"The page number to return.","required":false,"schema":{"$ref":"#/components/schemas/ClientListServerBackupsPageQueryParameter"},"examples":{"default":{"value":1}}},{"in":"query","name":"per_page","description":"Number of backups to return per page. The maximum is 50.","required":false,"schema":{"$ref":"#/components/schemas/ClientListServerBackupsPerPageQueryParameter"},"examples":{"default":{"value":20}}}],"responses":{"200":{"description":"Server backups returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientBackupPaginatedResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"]},"post":{"summary":"Create server backup","operationId":"clientCreateServerBackup","description":"Starts a new backup for the server.","parameters":[],"responses":{"200":{"description":"Backup started.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientBackupResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCreateServerBackupRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientListServerBackupsServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/backups/{backup_uuid}":{"get":{"summary":"Get server backup","operationId":"clientGetServerBackup","description":"Returns information about one server backup.","parameters":[],"responses":{"200":{"description":"Server backup returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientBackupResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"delete":{"summary":"Delete server backup","operationId":"clientDeleteServerBackup","description":"Deletes a backup record and its stored archive.","parameters":[],"responses":{"204":{"description":"Backup deleted."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetServerBackupServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"backup_uuid","description":"The backup UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetServerBackupBackupUuidPathParameter"},"examples":{"default":{"value":"b6b9acf9-19b1-4bb1-8c75-4abac802c6cf"}}}]},"/api/client/servers/{server_uuid}/backups/{backup_uuid}/download":{"get":{"summary":"Get backup download URL","operationId":"clientGetBackupDownloadURL","description":"Returns a signed URL for downloading a server backup.","parameters":[],"responses":{"200":{"description":"Signed backup download URL returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSignedUrlResource"}}}},"400":{"description":"The backup cannot be downloaded from its storage driver.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetBackupDownloadURLServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"backup_uuid","description":"The backup UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetBackupDownloadURLBackupUuidPathParameter"},"examples":{"default":{"value":"b6b9acf9-19b1-4bb1-8c75-4abac802c6cf"}}}]},"/api/client/servers/{server_uuid}/backups/{backup_uuid}/lock":{"post":{"summary":"Toggle backup lock","operationId":"clientToggleBackupLock","description":"Toggles whether a backup is locked against deletion.","parameters":[],"responses":{"200":{"description":"Backup lock state toggled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientBackupResource"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientToggleBackupLockServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"backup_uuid","description":"The backup UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientToggleBackupLockBackupUuidPathParameter"},"examples":{"default":{"value":"b6b9acf9-19b1-4bb1-8c75-4abac802c6cf"}}}]},"/api/client/servers/{server_uuid}/backups/{backup_uuid}/restore":{"post":{"summary":"Restore server backup","operationId":"clientRestoreServerBackup","description":"Restores a backup over the server files.","parameters":[],"responses":{"204":{"description":"Backup restore started."},"400":{"description":"The server or backup is not in a restorable state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRestoreServerBackupRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientRestoreServerBackupServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}},{"in":"path","name":"backup_uuid","description":"The backup UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientRestoreServerBackupBackupUuidPathParameter"},"examples":{"default":{"value":"b6b9acf9-19b1-4bb1-8c75-4abac802c6cf"}}}]},"/api/client/servers/{server_uuid}/startup":{"get":{"summary":"Get startup configuration","operationId":"clientGetStartupConfiguration","description":"Returns the rendered startup command, available Docker images, raw startup command, and user-visible variables for the server.","parameters":[],"responses":{"200":{"description":"Startup configuration returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientEggVariableListResponse"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientGetStartupConfigurationServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/startup/variable":{"put":{"summary":"Update startup variable","operationId":"clientUpdateStartupVariable","description":"Updates one editable startup variable for the server and returns the updated rendered startup command.","parameters":[],"responses":{"200":{"description":"Startup variable updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientEggVariableResource"}}}},"400":{"description":"The variable does not exist, is hidden, or is read-only.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientUpdateStartupVariableRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientUpdateStartupVariableServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/settings/rename":{"post":{"summary":"Rename server","operationId":"clientRenameServer","description":"Updates the server name and optionally its description.","parameters":[],"responses":{"204":{"description":"Server renamed."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRenameServerRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientRenameServerServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/settings/reinstall":{"post":{"summary":"Reinstall server","operationId":"clientReinstallServer","description":"Queues a reinstall of the server on Wings.","parameters":[],"responses":{"202":{"description":"Server reinstall queued."},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"tags":["Client API"]},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientReinstallServerServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/api/client/servers/{server_uuid}/settings/docker-image":{"put":{"summary":"Set server Docker image","operationId":"clientSetServerDockerImage","description":"Updates the server Docker image to one of the images allowed by the server egg.","parameters":[],"responses":{"204":{"description":"Docker image updated."},"400":{"description":"The server image was manually set by an administrator and cannot be changed through this endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Authentication credentials were missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The API key does not have permission to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"The submitted data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationErrorEnvelope"}}}}},"tags":["Client API"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSetServerDockerImageRequest"}}}}},"parameters":[{"in":"path","name":"server_uuid","description":"The server UUID.","required":true,"schema":{"$ref":"#/components/schemas/ClientSetServerDockerImageServerUuidPathParameter"},"examples":{"default":{"value":"d3aac109-e5a0-4331-b03e-3454f7e02bbe"}}}]},"/sanctum/csrf-cookie":{"get":{"summary":"Get CSRF cookie","operationId":"authGetCsrfCookie","description":"Initializes the Laravel Sanctum CSRF cookie required before browser-session authentication requests.","parameters":[],"responses":{"204":{"description":"The CSRF cookie was queued on the response."}},"tags":["Endpoints"],"security":[]}}}}}}]

Get CSRF cookie

Response Body

204