Documentation for api module

main

FastAPI application for the wolproxypy API.

This module is the main module of the application. It is responsible for the routing of the requests. The root path is '/' and shows the login and main pages. The path '/mac' invokes the wakeonlan module. TODO: must be access protected.

root() async

Root path, termporarily redirected to doc.

It will display the web app login and main pages.

run()

Run the application.

send_wol_packet_mac(mac_address=Path(Ellipsis)) async

Invokes the module to send a Wake-On-Lan packet to a MAC address.

Parameters:

  • mac_address (str) – the MAC address to send the packet to.
Returns:

  • Dict[str, Any] – The status of the wake-on-lan packet.