FeatherZeroTrust endpoints (Admin API)
15 FeatherPanel Admin API endpoints from admin/featherzerotrust.php: methods, paths, auth, permissions, rate limits, parameters and responses.
Last synced from FeatherPanel 15b94e9 on .
On this page
Defined in backend/app/routes/admin/featherzerotrust.php. Authentication used here: Admin. 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/admin/featherzerotrust/config
Get FeatherZeroTrust configuration Retrieve current FeatherZeroTrust configuration.
curl -X GET "$PANEL_URL/api/admin/featherzerotrust/config" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:admin:featherzerotrust:config:retrieved
Responses: 200 Configuration retrieved successfully
PUT/api/admin/featherzerotrust/config
Update FeatherZeroTrust configuration Update FeatherZeroTrust configuration settings.
curl -X PUT "$PANEL_URL/api/admin/featherzerotrust/config" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:admin:featherzerotrust:config:updated
Responses: 200 Configuration updated successfully
POST/api/admin/featherzerotrust/scan
Scan a server Scan a server for suspicious files using FeatherZeroTrust.
curl -X POST "$PANEL_URL/api/admin/featherzerotrust/scan" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:admin:featherzerotrust:scan:completed, featherpanel:admin:featherzerotrust:scan:started
Responses: 200 Server scan completed successfully
POST/api/admin/featherzerotrust/scan/batch
Scan multiple servers Scan multiple servers for suspicious files using FeatherZeroTrust.
curl -X POST "$PANEL_URL/api/admin/featherzerotrust/scan/batch" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Batch scan completed
GET/api/admin/featherzerotrust/logs
Get FeatherZeroTrust cron execution logs Retrieve cron job execution logs with pagination.
curl -X GET "$PANEL_URL/api/admin/featherzerotrust/logs" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Cron logs retrieved successfully
GET/api/admin/featherzerotrust/logs/{executionId}
Get detailed cron execution log Retrieve detailed information about a specific cron execution including server scan logs.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
executionId | path | - | yes |
curl -X GET "$PANEL_URL/api/admin/featherzerotrust/logs/$EXECUTION_ID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Execution log retrieved successfully
GET/api/admin/featherzerotrust/hashes
Get suspicious file hashes Retrieve suspicious file hashes from the database.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
confirmed_only | query | boolean | no | Only return confirmed malicious hashes |
curl -X GET "$PANEL_URL/api/admin/featherzerotrust/hashes" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Hashes retrieved successfully
GET/api/admin/featherzerotrust/hashes/stats
Get hash statistics Retrieve statistics about suspicious file hashes in the database.
curl -X GET "$PANEL_URL/api/admin/featherzerotrust/hashes/stats" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Hash statistics retrieved successfully
POST/api/admin/featherzerotrust/hashes/check
Check hashes against database Check multiple hashes against the suspicious file hash database.
curl -X POST "$PANEL_URL/api/admin/featherzerotrust/hashes/check" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Hashes checked successfully
POST/api/admin/featherzerotrust/hashes
Add hash manually Manually add a suspicious file hash to the database.
curl -X POST "$PANEL_URL/api/admin/featherzerotrust/hashes" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Hash added successfully
PUT/api/admin/featherzerotrust/hashes/{hash}/confirm
Confirm hash as malicious Mark a hash as confirmed malicious.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
hash | path | - | yes |
curl -X PUT "$PANEL_URL/api/admin/featherzerotrust/hashes/$HASH/confirm" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Hash confirmed as malicious
POST/api/admin/featherzerotrust/hashes/bulk/confirm
Confirm multiple hashes as malicious Mark multiple hashes as confirmed malicious.
curl -X POST "$PANEL_URL/api/admin/featherzerotrust/hashes/bulk/confirm" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Bulk hash confirmation completed
POST/api/admin/featherzerotrust/hashes/bulk/delete
curl -X POST "$PANEL_URL/api/admin/featherzerotrust/hashes/bulk/delete" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"POST/api/admin/featherzerotrust/hashes/import/malwarebazaar
Import hashes from MalwareBazaar Pull recent suspicious hashes from MalwareBazaar and store them in FeatherZeroTrust hash database.
curl -X POST "$PANEL_URL/api/admin/featherzerotrust/hashes/import/malwarebazaar" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 MalwareBazaar import completed
DELETE/api/admin/featherzerotrust/hashes/{hash}
Delete hash Delete a hash from the database.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
hash | path | - | yes |
curl -X DELETE "$PANEL_URL/api/admin/featherzerotrust/hashes/$HASH" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Hash deleted successfully