Lifecycle Hooks endpoints (Client API: game servers)
6 FeatherPanel Client API: game servers endpoints from user/server/lifecycle-hooks.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/lifecycle-hooks.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}/lifecycle-hooks
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
uuidShort | path | - | yes |
curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/lifecycle-hooks" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"PUT/api/user/servers/{uuidShort}/lifecycle-hooks/{hookType}
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
uuidShort | path | - | yes | |
hookType | path | - | yes |
curl -X PUT "$PANEL_URL/api/user/servers/$UUID_SHORT/lifecycle-hooks/$HOOK_TYPE" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:server:update
POST/api/user/servers/{uuidShort}/lifecycle-hooks/{hookType}/steps
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
uuidShort | path | - | yes | |
hookType | path | - | yes |
curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/lifecycle-hooks/$HOOK_TYPE/steps" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:server:update
PUT/api/user/servers/{uuidShort}/lifecycle-hooks/{hookType}/steps/{stepId}
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
uuidShort | path | - | yes | |
hookType | path | - | yes | |
stepId | path | - | yes |
curl -X PUT "$PANEL_URL/api/user/servers/$UUID_SHORT/lifecycle-hooks/$HOOK_TYPE/steps/$STEP_ID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:server:update
PUT/api/user/servers/{uuidShort}/lifecycle-hooks/{hookType}/steps/{stepId}/sequence
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
uuidShort | path | - | yes | |
hookType | path | - | yes | |
stepId | path | - | yes |
curl -X PUT "$PANEL_URL/api/user/servers/$UUID_SHORT/lifecycle-hooks/$HOOK_TYPE/steps/$STEP_ID/sequence" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:server:update
DELETE/api/user/servers/{uuidShort}/lifecycle-hooks/{hookType}/steps/{stepId}
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
uuidShort | path | - | yes | |
hookType | path | - | yes | |
stepId | path | - | yes |
curl -X DELETE "$PANEL_URL/api/user/servers/$UUID_SHORT/lifecycle-hooks/$HOOK_TYPE/steps/$STEP_ID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:server:update