Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

WebSpaces endpoints (Client API: web hosting)

107 FeatherPanel Client API: web hosting endpoints from user/webspaces.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/webspaces.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/user/webspaces

Auth: Signed-in userDefault rate limit: 2 / second (user-webspaces)Route name: user-webspacesController: WebSpacesController::indexroute source

List accessible WebSpaces

curl -X GET "$PANEL_URL/api/user/webspaces" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/catalog

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-catalogController: WebSpacesController::catalogroute source

Order catalog (nodes + WebPlates)

curl -X GET "$PANEL_URL/api/user/webspaces/catalog" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/utilization

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-utilizationController: WebSpacesController::utilizationroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/utilization" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/transfer/status

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-transfer-statusController: WebSpacesController::transferStatusroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/transfer/status" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/backups/jobs/{jobId}

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-backup-job-statusController: WebSpacesController::backupJobStatusroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
jobIdpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/backups/jobs/$JOB_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-showController: WebSpacesController::showroute source

Get WebSpace

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

GET/api/user/webspaces/{uuidShort}/infrastructure-readiness

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-infrastructure-readinessController: WebSpacesController::infrastructureReadinessroute source

Infrastructure readiness for this WebSpace

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/infrastructure-readiness" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PATCH/api/user/webspaces/{uuidShort}

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-updateController: WebSpacesController::updateroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X PATCH "$PANEL_URL/api/user/webspaces/$UUID_SHORT" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:updated

GET/api/user/webspaces/{uuidShort}/php-ini

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-php-iniController: WebSpacesController::phpIniroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/php-ini" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/user/webspaces/{uuidShort}/php-ini

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-php-ini-saveController: WebSpacesController::savePhpIniroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X PUT "$PANEL_URL/api/user/webspaces/$UUID_SHORT/php-ini" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/php-extensions

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-php-extensionsController: WebSpacesController::phpExtensionsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/php-extensions" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/user/webspaces/{uuidShort}/php-extensions

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-php-extensions-saveController: WebSpacesController::savePhpExtensionsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X PUT "$PANEL_URL/api/user/webspaces/$UUID_SHORT/php-extensions" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/redis

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-redisController: WebSpacesController::redisroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/redis" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/user/webspaces/{uuidShort}/redis

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-redis-saveController: WebSpacesController::saveRedisroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X PUT "$PANEL_URL/api/user/webspaces/$UUID_SHORT/redis" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/malware-scan

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-malware-scanController: WebSpacesController::malwareScanroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/malware-scan" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/malware-scan

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-malware-scan-statusController: WebSpacesController::malwareScanStatusroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/malware-scan" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/malware-scan/schedule

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-malware-scan-scheduleController: WebSpacesController::enableMalwareScanScheduleroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/malware-scan/schedule" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/power

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-powerController: WebSpacesController::powerroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/power" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/status

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-statusController: WebSpacesController::statusroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/status" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/logs

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-logsController: WebSpacesController::logsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/logs" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/logs/install

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-install-logsController: WebSpacesController::installLogsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/logs/install" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/reinstall

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-reinstallController: WebSpacesController::reinstallroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/reinstall" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:reinstall

POST/api/user/webspaces/{uuidShort}/install/abort

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-install-abortController: WebSpacesController::abortInstallroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/install/abort" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/ssl

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-sslController: WebSpacesController::sslroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/ssl" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/ssl/renew

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-ssl-renewController: WebSpacesController::renewSslroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/ssl/renew" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/dns-check

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-dns-checkController: WebSpacesController::checkDnsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/dns-check" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/dns/provision

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-dns-provisionController: WebSpacesController::provisionDnsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/dns/provision" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/ssl/custom

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-ssl-custom-statusController: WebSpacesController::customSslStatusroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/ssl/custom" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/user/webspaces/{uuidShort}/ssl/custom

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-ssl-custom-uploadController: WebSpacesController::uploadCustomSslroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X PUT "$PANEL_URL/api/user/webspaces/$UUID_SHORT/ssl/custom" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/user/webspaces/{uuidShort}/ssl/custom

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-ssl-custom-deleteController: WebSpacesController::deleteCustomSslroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/ssl/custom" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/backups

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-backupsController: WebSpacesController::listBackupsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/backups" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/backups/reconcile

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-backups-reconcileController: WebSpacesController::reconcileBackupsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/backups/reconcile" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/backup

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-backup-createController: WebSpacesController::createBackuproute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/backup" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/user/webspaces/{uuidShort}/backups/{backupUuid}

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-backup-deleteController: WebSpacesController::deleteBackuproute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
backupUuidpath-yes
curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/backups/$BACKUP_UUID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/backups/{backupUuid}/restore

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-backup-restoreController: WebSpacesController::restoreBackuproute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
backupUuidpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/backups/$BACKUP_UUID/restore" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/backups/{backupUuid}/files

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-backup-filesController: WebSpacesController::listBackupFilesroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
backupUuidpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/backups/$BACKUP_UUID/files" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/backups/{backupUuid}/download

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-backup-downloadController: WebSpacesController::downloadBackuproute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
backupUuidpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/backups/$BACKUP_UUID/download" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/backups/import

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-backup-importController: WebSpacesController::importBackuproute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/backups/import" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/jwt

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-jwtController: WebSpacesController::generateJwtroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/jwt" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/file-capabilities

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-file-capabilitiesController: WebSpaceFilesController::fileCapabilitiesroute source

WebSpace file manager capabilities

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/file-capabilities" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/files/list

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-files-listController: WebSpaceFilesController::listroute source

List WebSpace files

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/list" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/files/contents

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-files-contentsController: WebSpaceFilesController::contentsroute source

Read WebSpace file

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/contents" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/write

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-files-writeController: WebSpaceFilesController::writeroute source

Write WebSpace file

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/write" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/create-directory

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-create-directoryController: WebSpaceFilesController::createDirectoryroute source

Create WebSpace directory

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/create-directory" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:directory:create

PUT/api/user/webspaces/{uuidShort}/files/rename

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-renameController: WebSpaceFilesController::renameroute source

Rename WebSpace file

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X PUT "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/rename" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/copy

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-copyController: WebSpaceFilesController::copyroute source

Copy WebSpace file or directory

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/copy" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/copy-many

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-files-copy-manyController: WebSpaceFilesController::copyManyroute source

Copy many WebSpace files

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/copy-many" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/create-symlink

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-create-symlinkController: WebSpaceFilesController::createSymlinkroute source

Create WebSpace symlink

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/create-symlink" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/files/fingerprints

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-fingerprintsController: WebSpaceFilesController::fingerprintsroute source

Fingerprint WebSpace files

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/fingerprints" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/delete

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-deleteController: WebSpaceFilesController::deleteroute source

Delete WebSpace files

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/delete" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:files:delete

POST/api/user/webspaces/{uuidShort}/files/compress

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-files-compressController: WebSpaceFilesController::compressroute source

Compress WebSpace files

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/compress" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/decompress

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-files-decompressController: WebSpaceFilesController::decompressroute source

Decompress WebSpace archive

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/decompress" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/chmod

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-chmodController: WebSpaceFilesController::chmodroute source

Change WebSpace file permissions

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/chmod" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/pull

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-files-pullController: WebSpaceFilesController::pullroute source

Pull remote file into WebSpace

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/pull" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/files/download

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-files-downloadController: WebSpaceFilesController::downloadroute source

Download WebSpace file

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/download" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/upload

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-uploadController: WebSpaceFilesController::uploadroute source

Upload WebSpace file

ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/upload" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/files/trash

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-files-trash-listController: WebSpaceFilesController::listTrashroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/trash" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/trash/restore

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-trash-restoreController: WebSpaceFilesController::restoreTrashroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/trash/restore" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/trash/delete

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-trash-deleteController: WebSpaceFilesController::deleteTrashroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/trash/delete" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/trash/empty

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-files-trash-emptyController: WebSpaceFilesController::emptyTrashroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/trash/empty" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/files/download-directory

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-files-download-directoryController: WebSpaceFilesController::downloadDirectoryroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/download-directory" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/files/archive-list

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-files-archive-listController: WebSpaceFilesController::listArchiveroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/archive-list" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/extract-archive-selection

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-files-extract-archiveController: WebSpaceFilesController::extractArchiveSelectionroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/extract-archive-selection" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/files/search-advanced

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-files-search-advancedController: WebSpaceFilesController::searchAdvancedroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/search-advanced" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/wipe

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-files-wipeController: WebSpaceFilesController::wipeAllroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/wipe" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/files/upload-url

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-files-upload-urlController: WebSpaceFilesController::getUploadUrlroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/upload-url" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/files/share

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-files-shareController: WebSpaceFilesController::shareFileroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/share" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/files/share-jobs

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-files-share-jobsController: WebSpaceFilesController::getShareJobsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/share-jobs" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/user/webspaces/{uuidShort}/files/share-jobs/{shareId}

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-share-jobs-deleteController: WebSpaceFilesController::deleteShareJobroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
shareIdpath-yes
curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/share-jobs/$SHARE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/files/pull-jobs

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-files-pull-jobsController: WebSpaceFilesController::listPullJobsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/pull-jobs" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/user/webspaces/{uuidShort}/files/pull-jobs/{identifier}

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-files-pull-jobs-deleteController: WebSpaceFilesController::cancelPullJobroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
identifierpath-yes
curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/files/pull-jobs/$IDENTIFIER" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/users

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-usersController: WebSpaceSubuserController::indexroute source

List WebSpace subusers

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

POST/api/user/webspaces/{uuidShort}/users

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-users-createController: WebSpaceSubuserController::createroute source

Add WebSpace subuser

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

Plugin events: featherpanel:webspace:subuser:create

PUT/api/user/webspaces/{uuidShort}/users/{subuserId}

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-users-updateController: WebSpaceSubuserController::updateroute source

Update WebSpace subuser

ParameterInTypeRequiredDescription
uuidShortpath-yes
subuserIdpath-yes
curl -X PUT "$PANEL_URL/api/user/webspaces/$UUID_SHORT/users/$SUBUSER_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:subuser:update

DELETE/api/user/webspaces/{uuidShort}/users/{subuserId}

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-users-deleteController: WebSpaceSubuserController::deleteroute source

Remove WebSpace subuser

ParameterInTypeRequiredDescription
uuidShortpath-yes
subuserIdpath-yes
curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/users/$SUBUSER_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:subuser:delete

GET/api/user/webspaces/{uuidShort}/activities

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-activitiesController: WebSpaceActivityController::indexroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/activities" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/dns/zones

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-dns-zonesController: WebSpaceDnsController::listZonesroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/dns/zones" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/dns/hosts

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-dns-hostsController: WebSpaceDnsController::listDnsHostsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/dns/hosts" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/dns/zones

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-dns-zones-linkController: WebSpaceDnsController::linkZoneroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/dns/zones" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/user/webspaces/{uuidShort}/dns/zones/{zoneId}

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-dns-zones-unlinkController: WebSpaceDnsController::unlinkZoneroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
zoneIdpath-yes
curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/dns/zones/$ZONE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/dns/zones/{zoneId}/records

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-dns-recordsController: WebSpaceDnsController::listRecordsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
zoneIdpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/dns/zones/$ZONE_ID/records" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/dns/zones/{zoneId}/records

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-dns-records-createController: WebSpaceDnsController::createRecordroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
zoneIdpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/dns/zones/$ZONE_ID/records" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PATCH/api/user/webspaces/{uuidShort}/dns/zones/{zoneId}/records/{recordId}

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-dns-records-updateController: WebSpaceDnsController::updateRecordroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
zoneIdpath-yes
recordIdpath-yes
curl -X PATCH "$PANEL_URL/api/user/webspaces/$UUID_SHORT/dns/zones/$ZONE_ID/records/$RECORD_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

DELETE/api/user/webspaces/{uuidShort}/dns/zones/{zoneId}/records/{recordId}

Auth: Signed-in userDefault rate limit: 20 / minute (user-webspaces)Route name: user-webspaces-dns-records-deleteController: WebSpaceDnsController::deleteRecordroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
zoneIdpath-yes
recordIdpath-yes
curl -X DELETE "$PANEL_URL/api/user/webspaces/$UUID_SHORT/dns/zones/$ZONE_ID/records/$RECORD_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/proxy-logs

Auth: Signed-in userDefault rate limit: 60 / minute (user-webspaces)Route name: user-webspaces-proxy-logsController: WebSpaceLogsController::proxyLogsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/proxy-logs" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/proxy-logs/rotate

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-proxy-logs-rotateController: WebSpaceLogsController::rotateProxyLogsroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/proxy-logs/rotate" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/analytics

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-analyticsController: WebSpaceAnalyticsController::summaryroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/analytics" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/apps/wordpress

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-wordpressController: WebSpaceAppsController::installWordPressroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/wordpress" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:app:installed

POST/api/user/webspaces/{uuidShort}/apps/wordpress/update

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-wordpress-updateController: WebSpaceAppsController::updateWordPressroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/wordpress/update" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:app:updated

POST/api/user/webspaces/{uuidShort}/apps/wordpress/staging

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-wordpress-stagingController: WebSpaceAppsController::stagingWordPressroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/wordpress/staging" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/apps/wordpress/staging/promote

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-wordpress-staging-promoteController: WebSpaceAppsController::promoteWordPressStagingroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/wordpress/staging/promote" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/apps/laravel

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-laravelController: WebSpaceAppsController::installLaravelroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/laravel" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:app:installed

POST/api/user/webspaces/{uuidShort}/apps/joomla

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-joomlaController: WebSpaceAppsController::installJoomlaroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/joomla" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:app:installed

POST/api/user/webspaces/{uuidShort}/apps/drupal

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-drupalController: WebSpaceAppsController::installDrupalroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/drupal" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:app:installed

POST/api/user/webspaces/{uuidShort}/apps/prestashop

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-prestashopController: WebSpaceAppsController::installPrestaShoproute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/prestashop" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/apps/magento

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-magentoController: WebSpaceAppsController::installMagentoroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/magento" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/apps/ghost

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-ghostController: WebSpaceAppsController::installGhostroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/ghost" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:app:installed

POST/api/user/webspaces/{uuidShort}/apps/node-starter

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-node-starterController: WebSpaceAppsController::installNodeStarterroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/node-starter" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:app:installed

POST/api/user/webspaces/{uuidShort}/apps/python-starter

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-python-starterController: WebSpaceAppsController::installPythonStarterroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/python-starter" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:app:installed

POST/api/user/webspaces/{uuidShort}/apps/wordpress/plugin

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-apps-wordpress-pluginController: WebSpaceAppsController::installWordPressPluginroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/wordpress/plugin" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:app:installed

POST/api/user/webspaces/{uuidShort}/apps/wordpress/auto-update

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-wordpress-auto-updateController: WebSpaceAppsController::enableWordPressAutoUpdateroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/wordpress/auto-update" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/apps/git-deploy

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-git-deployController: WebSpaceAppsController::gitDeployroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/git-deploy" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:webspace:app:updated

GET/api/user/webspaces/{uuidShort}/apps/git-webhook

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-apps-git-webhookController: WebSpaceAppsController::gitWebhookConfigroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/git-webhook" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

PUT/api/user/webspaces/{uuidShort}/apps/git-webhook

Auth: Signed-in userDefault rate limit: 10 / minute (user-webspaces)Route name: user-webspaces-apps-git-webhook-saveController: WebSpaceAppsController::saveGitWebhookConfigroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X PUT "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/git-webhook" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

GET/api/user/webspaces/{uuidShort}/apps/git-deploy-key

Auth: Signed-in userDefault rate limit: 30 / minute (user-webspaces)Route name: user-webspaces-apps-git-deploy-keyController: WebSpaceAppsController::gitDeployKeyroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X GET "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/git-deploy-key" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

POST/api/user/webspaces/{uuidShort}/apps/git-deploy-key

Auth: Signed-in userDefault rate limit: 5 / minute (user-webspaces)Route name: user-webspaces-apps-git-deploy-key-regenerateController: WebSpaceAppsController::regenerateGitDeployKeyroute source
ParameterInTypeRequiredDescription
uuidShortpath-yes
curl -X POST "$PANEL_URL/api/user/webspaces/$UUID_SHORT/apps/git-deploy-key" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
Written from the source:FeatherPanel/backend/app/routes/user/webspaces.php
View source on GitHubReport a problemLast updated