Allocations endpoints (Admin API)

GET/api/admin/allocations

Get all allocations Retrieve a paginated list of all IP allocations with optional filtering by node, server, and search query.

curl -X GET "$PANEL_URL/api/admin/allocations" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Allocations retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

PUT/api/admin/allocations

Create new allocation(s) Create one or more IP allocations. Supports single port or port range creation. Port ranges are limited to 1000 ports maximum.

curl -X PUT "$PANEL_URL/api/admin/allocations" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":0,"node_id":0,"ip":"","port":0,"ip_alias":"","server_id":0,"notes":""}'

Plugin events: featherpanel:admin:allocations:allocation:created

Responses: 201 Allocation(s) created successfully · 400 Bad request - Invalid data or validation errors · 401 Unauthorized · 403 Forbidden - Insufficient permissions

GET/api/admin/allocations/available

Get available allocations Retrieve a paginated list of allocations that are not assigned to any server. Optionally filter by node.

curl -X GET "$PANEL_URL/api/admin/allocations/available" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Available allocations retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions

DELETE/api/admin/allocations/bulk-delete

Bulk delete allocations Delete multiple allocations at once by providing an array of allocation IDs. Only unassigned allocations will be deleted. Allocations assigned to servers will be skipped.

curl -X DELETE "$PANEL_URL/api/admin/allocations/bulk-delete" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"ids":[]}'

Plugin events: featherpanel:admin:allocations:allocation:deleted

Responses: 200 Allocations deleted successfully · 400 Bad request - Invalid or missing IDs · 401 Unauthorized · 403 Forbidden - Insufficient permissions

DELETE/api/admin/allocations/delete-unused

Delete unused allocations Delete all allocations that are not assigned to any server. Optionally filter by node ID and/or IP address (subnet).

curl -X DELETE "$PANEL_URL/api/admin/allocations/delete-unused" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"node_id":0,"ip":""}'

Plugin events: featherpanel:admin:allocations:allocation:deleted

Responses: 200 Unused allocations deleted successfully · 400 Bad request - Invalid node ID or IP address · 401 Unauthorized · 403 Forbidden - Insufficient permissions

PATCH/api/admin/allocations/bulk-address

Bulk update allocation IP or alias Update the IP address and/or IP alias for every allocation on a node that currently uses a specific IP address.

curl -X PATCH "$PANEL_URL/api/admin/allocations/bulk-address" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"node_id":0,"from_ip":"","to_ip":"","ip_alias":""}'

Plugin events: featherpanel:admin:allocations:allocation:updated

Responses: 200 Allocations updated successfully · 400 Bad request - Invalid data · 401 Unauthorized · 403 Forbidden - Insufficient permissions · 404 Node or matching allocations not found · 409 Target IP has ports already assigned to another server

GET/api/admin/allocations/{id}

Get allocation by ID Retrieve a specific allocation by its ID with associated node and server information.

curl -X GET "$PANEL_URL/api/admin/allocations/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Allocation retrieved successfully · 400 Invalid ID format · 401 Unauthorized · 403 Forbidden - Insufficient permissions · 404 Allocation not found

PATCH/api/admin/allocations/{id}

Update allocation Update an existing allocation. Only provided fields will be updated. IP and port combinations must be unique per node.

curl -X PATCH "$PANEL_URL/api/admin/allocations/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"node_id":0,"ip":"","port":0,"ip_alias":"","server_id":0,"notes":""}'

Plugin events: featherpanel:admin:allocations:allocation:updated

Responses: 200 Allocation updated successfully · 400 Bad request - Invalid data or validation errors · 401 Unauthorized · 403 Forbidden - Insufficient permissions · 404 Allocation not found

DELETE/api/admin/allocations/{id}

Delete allocation Permanently delete an allocation. This action cannot be undone. Only unassigned allocations can be deleted.

curl -X DELETE "$PANEL_URL/api/admin/allocations/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:admin:allocations:allocation:deleted

Responses: 200 Allocation deleted successfully · 400 Bad request - Failed to delete allocation · 401 Unauthorized · 403 Forbidden - Insufficient permissions · 404 Allocation not found · 409 Conflict - Allocation is assigned to a server

POST/api/admin/allocations/{id}/assign

Assign allocation to server Assign an unassigned allocation to a specific server.

curl -X POST "$PANEL_URL/api/admin/allocations/$ID/assign" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"server_id":0}'

Responses: 200 Allocation assigned to server successfully · 400 Bad request - Invalid server ID or assignment failed · 401 Unauthorized · 403 Forbidden - Insufficient permissions · 404 Allocation not found

POST/api/admin/allocations/{id}/unassign

Unassign allocation from server Remove the server assignment from an allocation, making it available for reassignment.

curl -X POST "$PANEL_URL/api/admin/allocations/$ID/unassign" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Allocation unassigned from server successfully · 400 Bad request - Allocation not assigned or unassignment failed · 401 Unauthorized · 403 Forbidden - Insufficient permissions · 404 Allocation not found