View .md

Subuser Invites endpoints (Client API: game servers)

5 FeatherPanel Client API: game servers endpoints from user/server/subuser-invites.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/subuser-invites.php. Authentication used here: Server access, Signed-in user. 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}/subuser-invites

Auth: Server accessDefault rate limit: 20 / minute (user-server-subuser-invites)Route name: session-server-subuser-invitesroute source

Active invite links

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/subuser-invites" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Invites

POST/api/user/servers/{uuidShort}/subuser-invites

Auth: Server accessDefault rate limit: 20 / minute (user-server-subuser-invites)Route name: session-server-subuser-invitesroute source

Active invite links

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/subuser-invites" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Invites

DELETE/api/user/servers/{uuidShort}/subuser-invites/{inviteId}

Auth: Server accessDefault rate limit: 20 / minute (user-server-subuser-invites)Route name: session-server-subuser-invite-revokeController: SubuserInviteController::revokeroute source

Revoke an invite link

ParameterInTypeRequiredDescription
uuidShortpath-yes
inviteIdpath-yes
curl -X DELETE "$PANEL_URL/api/user/servers/$UUID_SHORT/subuser-invites/$INVITE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Revoked

GET/api/user/subuser-invites/{token}

Auth: Signed-in userDefault rate limit: 10 / minute (user-subuser-invite)Route name: user-subuser-inviteroute source

Preview an invite link

ParameterInTypeRequiredDescription
tokenpath-yes
curl -X GET "$PANEL_URL/api/user/subuser-invites/$TOKEN" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Invite preview

POST/api/user/subuser-invites/{token}

Auth: Signed-in userDefault rate limit: 10 / minute (user-subuser-invite)Route name: user-subuser-inviteroute source

Preview an invite link

ParameterInTypeRequiredDescription
tokenpath-yes
curl -X POST "$PANEL_URL/api/user/subuser-invites/$TOKEN" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Invite preview