Mounts

​

Overview

​

Endpoints

​

List Mounts

curl -X GET "https://panel.example.com/api/admin/mounts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

• view (optional): Set to options for a simplified list of ID and name only

{
  "data": [
    {
      "id": "mount-uuid",
      "uuid": "mount-uuid",
      "name": "Shared Maps",
      "description": "Shared world maps",
      "source": "/mnt/maps",
      "target": "/home/container/maps",
      "readOnly": true,
      "userMountable": false,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "eggCount": 3,
      "nodeCount": 5,
      "serverCount": 12
    }
  ]
}

{
  "data": [
    {
      "id": "mount-uuid",
      "name": "Shared Maps"
    }
  ]
}

​

Create Mount

curl -X POST "https://panel.example.com/api/admin/mounts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Shared Plugins",
    "description": "Shared plugin directory",
    "source": "/mnt/plugins",
    "target": "/home/container/plugins",
    "readOnly": true,
    "userMountable": false,
    "nodeIds": ["node-uuid-1", "node-uuid-2"],
    "eggIds": ["egg-uuid-1"]
  }'

• name (required): Mount name (1-255 characters, trimmed)
• description (optional): Description (max 500 characters, trimmed)
• source (required): Host path (trimmed, minimum 1 character)
• target (required): Container path (trimmed, minimum 1 character)
• readOnly (optional): Whether mount is read-only (default: false)
• userMountable (optional): Whether users can mount this (default: false)
• nodeIds (optional): Array of node UUIDs to assign mount to
• eggIds (optional): Array of egg UUIDs to assign mount to

​

Update Mount

curl -X PATCH "https://panel.example.com/api/admin/mounts/mount-uuid" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "readOnly": false,
    "userMountable": true
  }'

​

Delete Mount

curl -X DELETE "https://panel.example.com/api/admin/mounts/mount-uuid" \
  -H "Authorization: Bearer YOUR_API_KEY"

​

Mount Object

​

Mount Assignment

• Eggs: Mount automatically applies to all servers using that egg
• Nodes: Mount is only available on specific nodes
• Servers: Mount can be individually assigned to servers

​

Security Considerations

• Use readOnly: true when servers should not modify shared data
• Carefully control userMountable to prevent security issues
• Ensure source paths exist on all assigned nodes
• Be cautious with sensitive directories (e.g., /etc, system paths)

​

Notes

• Mounts are ordered alphabetically by name
• Counts are computed via SQL joins in the list endpoint
• Use view=options for dropdown/select inputs
• Audit logs track all mount operations