API Endpoints

FiestaBoard provides a REST API powered by FastAPI. Interactive API documentation is available at http://localhost:8000/docs when FiestaBoard is running.

Base URL

http://localhost:8000

System Endpoints

Health & Status

Method	Endpoint	Description
GET	/health	Health check — returns service health status
GET	/status	Service status, uptime, and current configuration
GET	/config	Current configuration settings

Display Control

Method	Endpoint	Description
POST	/refresh	Refresh the current display
POST	/force-refresh	Force refresh (bypasses preview cache)
POST	/send-message	Send a custom message to the board
POST	/dev-mode	Toggle development mode

Service Control

Method	Endpoint	Description
POST	/service/start	Start the display service
POST	/service/stop	Stop the display service
POST	/service/restart	Restart the display service

Page Endpoints

Method	Endpoint	Description
GET	/pages	List all pages
POST	/pages	Create a new page
GET	/pages/{id}	Get a specific page
PUT	/pages/{id}	Update a page
DELETE	/pages/{id}	Delete a page
GET	/pages/{id}/preview	Preview a page (with variables resolved)

Batch Operations

Method	Endpoint	Description
POST	/pages/preview/batch	Preview multiple pages at once
POST	/displays/raw/batch	Get raw display data for multiple pages

Schedule Endpoints

Method	Endpoint	Description
GET	/schedules	List all schedule entries
POST	/schedules	Create a new schedule entry
GET	/schedules/{id}	Get a specific schedule entry
PUT	/schedules/{id}	Update a schedule entry
DELETE	/schedules/{id}	Delete a schedule entry

Plugin Endpoints

Method	Endpoint	Description
GET	/plugins	List all plugins with status
GET	/plugins/{id}	Get plugin details
GET	/plugins/{id}/config	Get plugin configuration
PUT	/plugins/{id}/config	Update plugin configuration
POST	/plugins/{id}/enable	Enable a plugin
POST	/plugins/{id}/disable	Disable a plugin
GET	/plugins/{id}/data	Get current plugin data
GET	/plugins/{id}/variables	Get available template variables

Settings Endpoints

Method	Endpoint	Description
GET	/settings	Get all settings
PUT	/settings	Update settings
GET	/settings/all	Get all settings in a single call

Example Requests

Get Service Status

curl http://localhost:8000/status

Send a Message

curl -X POST http://localhost:8000/send-message \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello World!"}'

List Plugins

curl http://localhost:8000/plugins

Preview a Page

curl http://localhost:8000/pages/1/preview

Interactive Documentation

For a complete interactive API explorer with request/response schemas, visit:

http://localhost:8000/docs

This provides a Swagger UI where you can try out any endpoint directly in your browser.

Next Steps

• Docker Setup — Understanding the API architecture
• Plugin Configuration — Configuring plugins via API