Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

Remote endpoints (Daemon-facing)

10 FeatherPanel Daemon-facing endpoints from quilld/remote.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Last synced from FeatherPanel 15b94e9 on .

On this page

Defined in backend/app/routes/quilld/remote.php. Authentication used here: Quilld node token. 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/quilld-remote/config

Auth: Quilld node tokenRoute name: quilld-remote-configController: FeatherQuilldConfigController::getConfigroute source
curl -X GET "$PANEL_URL/api/quilld-remote/config" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"

Plugin events: featherpanel:quilld:config:retrieved

GET/api/quilld-remote/health

Auth: Quilld node tokenRoute name: quilld-remote-healthController: FeatherQuilldHealthController::getHealthroute source
curl -X GET "$PANEL_URL/api/quilld-remote/health" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"

GET/api/quilld-remote/webspaces/{uuid}

Auth: Quilld node tokenRoute name: quilld-remote-webspaceController: FeatherQuilldWebSpaceController::getWebSpaceroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X GET "$PANEL_URL/api/quilld-remote/webspaces/$UUID" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"

Plugin events: featherpanel:quilld:webspace:retrieved

PATCH/api/quilld-remote/webspaces/{uuid}

Auth: Quilld node tokenRoute name: quilld-remote-webspace-patchController: FeatherQuilldWebSpaceController::patchWebSpaceroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X PATCH "$PANEL_URL/api/quilld-remote/webspaces/$UUID" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"

Plugin events: featherpanel:quilld:webspace:updated

GET/api/quilld-remote/webspaces/{uuid}/install

Auth: Quilld node tokenRoute name: quilld-remote-webspace-install-getController: FeatherQuilldWebSpaceController::getInstallroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X GET "$PANEL_URL/api/quilld-remote/webspaces/$UUID/install" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"

Plugin events: featherpanel:quilld:install:retrieved

POST/api/quilld-remote/webspaces/{uuid}/install

Auth: Quilld node tokenRoute name: quilld-remote-webspace-install-postController: FeatherQuilldWebSpaceController::postInstallroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/quilld-remote/webspaces/$UUID/install" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"

Plugin events: featherpanel:quilld:install:completed

POST/api/quilld-remote/webspaces/{uuid}/acme-dns

Auth: Quilld node tokenRoute name: quilld-remote-webspace-acme-dnsController: FeatherQuilldWebSpaceController::acmeDnsroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/quilld-remote/webspaces/$UUID/acme-dns" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"

POST/api/quilld-remote/sftp/auth

Auth: Quilld node tokenRoute name: quilld-remote-sftp-authController: SftpAuthController::authenticateroute source
curl -X POST "$PANEL_URL/api/quilld-remote/sftp/auth" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"

POST/api/quilld-remote/transfers/{uuid}

Auth: Quilld node tokenRoute name: quilld-remote-transfer-statusController: FeatherQuilldTransferController::postStatusroute source
ParameterInTypeRequiredDescription
uuidpath-yes
curl -X POST "$PANEL_URL/api/quilld-remote/transfers/$UUID" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"

Plugin events: featherpanel:quilld:transfer:status

POST/api/quilld-remote/activity

Auth: Quilld node tokenRoute name: quilld-remote-activityController: QuilldActivityController::logActivityroute source
curl -X POST "$PANEL_URL/api/quilld-remote/activity" \
  -H "Authorization: Bearer $NODE_TOKEN_ID.$NODE_TOKEN" \
  -H "Accept: application/json"

Plugin events: featherpanel:quilld:activity:logged

Written from the source:FeatherPanel/backend/app/routes/quilld/remote.php
View source on GitHubReport a problemLast updated