Skip to main content

API Endpoints

Basic​

There are two endpoints which can be used to retrieve data about the running dash. instance:

/info​

Gives information about the static data of the running instance. Mostly needed to read the speed-test result at network.speedDown and network.speedUp.

  • Example: https://<YOUR_SERVER_URL>/info

/config​

Gives information about the configurations of the runnning instance. Mostly needed to read the enabled widgets at config.widget_list.

  • Example: https://<YOUR_SERVER_URL>/config

/load​

Has multiple sub-routes, each returning the current load of the given type.

  • /load/cpu
  • /load/storage
  • /load/ram
  • /load/network
  • /load/gpu

  • Example: https://<YOUR_SERVER_URL>/load/cpu

URL Preview​

Info

https://dash.mauz.dev/info
null

Config

https://dash.mauz.dev/config
null

CPU Load

https://dash.mauz.dev/load/cpu
null

Storage Load

https://dash.mauz.dev/load/storage
null

RAM Load

https://dash.mauz.dev/load/ram
null

Network Load

https://dash.mauz.dev/load/network
null

GPU Load

https://dash.mauz.dev/load/gpu
null