Subdomains endpoints (Client API: game servers)
3 FeatherPanel Client API: game servers endpoints from user/server/subdomains.php: methods, paths, auth, permissions, rate limits, parameters and responses.
Last synced from FeatherPanel 15b94e9 on .
On this page
Defined in backend/app/routes/user/server/subdomains.php. Authentication used here: Server access. Read Authentication for how to send credentials and Rate limits and errors for the response envelope.
Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.
Endpoints
GET/api/user/servers/{uuidShort}/subdomains
List subdomains and available domains Returns the subdomains created for a server and the domains available for its spell.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
uuidShort | path | string | yes |
curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/subdomains" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Subdomains retrieved successfully · 403 Forbidden · 404 Server not found
PUT/api/user/servers/{uuidShort}/subdomains
Create a subdomain
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
uuidShort | path | - | yes |
| Body field | Type | Required | Description |
|---|---|---|---|
domain_uuid | string | yes | |
subdomain | string | yes |
curl -X PUT "$PANEL_URL/api/user/servers/$UUID_SHORT/subdomains" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"domain_uuid":"","subdomain":""}'Plugin events: featherpanel:user:subdomain:created
Responses: 201 Subdomain created successfully · 400 Validation failed · 403 Forbidden · 404 Domain not found
DELETE/api/user/servers/{uuidShort}/subdomains/{uuid}
Delete a subdomain
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
uuidShort | path | string | yes | |
uuid | path | string | yes |
curl -X DELETE "$PANEL_URL/api/user/servers/$UUID_SHORT/subdomains/$UUID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:user:subdomain:deleted
Responses: 200 Subdomain deleted successfully · 404 Subdomain not found