Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

Calagopus Client endpoints (Client API: account)

27 FeatherPanel Client API: account endpoints from user/calagopus-client.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/calagopus-client.php. Authentication used here: 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/settings

Auth: Signed-in userDefault rate limit: 60 / minute (calagopus-client)Route name: calagopus-settingsroute source
curl -X GET "$PANEL_URL/api/settings" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/client/account

Auth: Signed-in userDefault rate limit: 60 / minute (calagopus-client)Route name: calagopus-accountroute source
curl -X GET "$PANEL_URL/api/client/account" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/client/account/command-snippets

Auth: Signed-in userDefault rate limit: 30 / minute (calagopus-client)Route name: calagopus-command-snippets-listroute source
curl -X GET "$PANEL_URL/api/client/account/command-snippets" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/client/account/command-snippets

Auth: Signed-in userDefault rate limit: 20 / minute (calagopus-client)Route name: calagopus-command-snippets-createroute source
curl -X POST "$PANEL_URL/api/client/account/command-snippets" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PATCH/api/client/account/command-snippets/{snippetUuid}

Auth: Signed-in userDefault rate limit: 20 / minute (calagopus-client)Route name: calagopus-command-snippets-updateroute source
ParameterInTypeRequiredDescription
snippetUuidpath-yes
curl -X PATCH "$PANEL_URL/api/client/account/command-snippets/$SNIPPET_UUID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/client/account/command-snippets/{snippetUuid}

Auth: Signed-in userDefault rate limit: 20 / minute (calagopus-client)Route name: calagopus-command-snippets-deleteroute source
ParameterInTypeRequiredDescription
snippetUuidpath-yes
curl -X DELETE "$PANEL_URL/api/client/account/command-snippets/$SNIPPET_UUID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/client/servers

Auth: Signed-in userDefault rate limit: 60 / minute (calagopus-client)Route name: calagopus-servers-listroute source
curl -X GET "$PANEL_URL/api/client/servers" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/client/servers/{uuid}

Auth: Signed-in userDefault rate limit: 60 / minute (calagopus-client)Route name: calagopus-server-getroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X GET "$PANEL_URL/api/client/servers/$UUID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/client/servers/{uuid}/websocket

Auth: Signed-in userDefault rate limit: 30 / minute (calagopus-client)Route name: calagopus-server-websocketroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X GET "$PANEL_URL/api/client/servers/$UUID/websocket" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/client/servers/{uuid}/power

Auth: Signed-in userDefault rate limit: 20 / minute (calagopus-client)Route name: calagopus-server-powerroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/client/servers/$UUID/power" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/client/servers/{uuid}/files/list

Auth: Signed-in userDefault rate limit: 60 / minute (calagopus-client)Route name: calagopus-files-listroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/list" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/client/servers/{uuid}/files/contents

Auth: Signed-in userDefault rate limit: 60 / minute (calagopus-client)Route name: calagopus-files-contentsroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/contents" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/client/servers/{uuid}/files/write

Auth: Signed-in userDefault rate limit: 60 / minute (calagopus-client)Route name: calagopus-files-writeroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/write" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/client/servers/{uuid}/files/upload

Auth: Signed-in userDefault rate limit: 30 / minute (calagopus-client)Route name: calagopus-files-uploadroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/upload" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/client/servers/{uuid}/files/download

Auth: Signed-in userDefault rate limit: 30 / minute (calagopus-client)Route name: calagopus-files-downloadroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/download" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/client/servers/{uuid}/files/create-directory

Auth: Signed-in userDefault rate limit: 30 / minute (calagopus-client)Route name: calagopus-files-create-directoryroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/create-directory" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/client/servers/{uuid}/files/rename

Auth: Signed-in userDefault rate limit: 30 / minute (calagopus-client)Route name: calagopus-files-renameroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X PUT "$PANEL_URL/api/client/servers/$UUID/files/rename" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/client/servers/{uuid}/files/delete

Auth: Signed-in userDefault rate limit: 30 / minute (calagopus-client)Route name: calagopus-files-deleteroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/delete" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/client/servers/{uuid}/files/search

Auth: Signed-in userDefault rate limit: 30 / minute (calagopus-client)Route name: calagopus-files-searchroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/search" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/client/servers/{uuid}/files/revisions

Auth: Signed-in userDefault rate limit: 30 / minute (calagopus-client)Route name: calagopus-files-revisionsroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/revisions" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/client/servers/{uuid}/files/revisions/{id}

Auth: Signed-in userDefault rate limit: 30 / minute (calagopus-client)Route name: calagopus-files-revisionroute source
ParameterInTypeRequiredDescription
uuidpath-yes
idpath-yes
curl -X GET "$PANEL_URL/api/client/servers/$UUID/files/revisions/$ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/client/servers/{uuid}/files/compress

Auth: Signed-in userDefault rate limit: 10 / minute (calagopus-client)Route name: calagopus-files-compressroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/compress" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/client/servers/{uuid}/files/decompress

Auth: Signed-in userDefault rate limit: 10 / minute (calagopus-client)Route name: calagopus-files-decompressroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/decompress" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/client/servers/{uuid}/files/chmod

Auth: Signed-in userDefault rate limit: 20 / minute (calagopus-client)Route name: calagopus-files-chmodroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X PUT "$PANEL_URL/api/client/servers/$UUID/files/chmod" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/client/servers/{uuid}/files/copy-many

Auth: Signed-in userDefault rate limit: 20 / minute (calagopus-client)Route name: calagopus-files-copy-manyroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/copy-many" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/client/servers/{uuid}/files/copy-remote

Auth: Signed-in userDefault rate limit: 10 / minute (calagopus-client)Route name: calagopus-files-copy-remoteroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/client/servers/$UUID/files/copy-remote" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/client/servers/{uuid}/files/operations/{operation}

Auth: Signed-in userDefault rate limit: 30 / minute (calagopus-client)Route name: calagopus-files-operation-cancelroute source
ParameterInTypeRequiredDescription
uuidpath-yes
operationpath-yes
curl -X DELETE "$PANEL_URL/api/client/servers/$UUID/files/operations/$OPERATION" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
Written from the source:FeatherPanel/backend/app/routes/user/calagopus-client.php
View source on GitHubReport a problemLast updated