2024-11-30 14:00:25 -06:00
|
|
|
---
|
|
|
|
id: httpd
|
|
|
|
title: HTTPD
|
|
|
|
---
|
|
|
|
|
|
|
|
# HTTPD
|
2024-12-02 12:41:26 -06:00
|
|
|
|
2024-11-30 14:00:25 -06:00
|
|
|
The HTTPD module sets up a basic web server to display information from Plex.
|
|
|
|
|
|
|
|
## Endpoints
|
2024-12-02 12:41:26 -06:00
|
|
|
|
2024-11-30 14:00:25 -06:00
|
|
|
The endpoints are what allow you to query the server and see information. All endpoints are formatted in JSON.
|
|
|
|
|
2024-12-02 12:41:26 -06:00
|
|
|
### /api/commands
|
|
|
|
|
|
|
|
This endpoint shows a list of registered commands on the server. It is an automatically generated help page. It is up to
|
|
|
|
plugin authors to provide accurate information about their plugins and the commands they provide.
|
2024-11-30 14:00:25 -06:00
|
|
|
|
|
|
|
### /api/indefbans
|
2024-12-02 12:41:26 -06:00
|
|
|
|
2025-01-24 09:58:46 -06:00
|
|
|
Displays a list of indefinite players in JSON format. This page is only accessible if your IP address is linked to your
|
|
|
|
account in game. It will check if the player has the `plex.httpd.indefbans.access`.
|
2024-11-30 14:00:25 -06:00
|
|
|
|
|
|
|
### /api/list
|
2024-12-02 12:41:26 -06:00
|
|
|
|
2024-11-30 14:00:25 -06:00
|
|
|
This will display a list of online players in JSON format. This is accessible to everyone.
|
|
|
|
|
|
|
|
### /api/punishments
|
2024-12-02 12:41:26 -06:00
|
|
|
|
2025-01-24 09:58:46 -06:00
|
|
|
If you go this page, it will ask you to enter a UUID. When you enter a valid UUID in the search box, it will display
|
2024-12-02 12:41:26 -06:00
|
|
|
that user's punishments in JSON format. An example URL would be `/api/punishments/78408086-1991-4c33-a571-d8fa325465b2`.
|
2025-01-24 09:58:46 -06:00
|
|
|
If your IP is not registered to a user in game, it cannot determine if you have the necessary permissions. The player
|
|
|
|
will need to have the `plex.httpd.punishments.access` to see IP addresses.
|
2024-11-30 14:00:25 -06:00
|
|
|
|
|
|
|
### /api/schematics/download
|
2024-12-02 12:41:26 -06:00
|
|
|
|
2025-01-24 09:58:46 -06:00
|
|
|
This page allows anyone to download schematics from the server. No permission is required to access the page.
|
2024-11-30 14:00:25 -06:00
|
|
|
|
|
|
|
### /api/schematics/upload
|
2024-12-02 12:41:26 -06:00
|
|
|
|
2025-01-24 09:58:46 -06:00
|
|
|
This page allows players who have the permission `plex.httpd.schematics.upload` in game to upload schematics.
|