Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

name path methods description
AuthApiController
  • /auth
  • /auth/form
  • /auth/password
  • /auth/qr
  • POST
  • POST
  • PATCH
  • GET POST
Controller for authorizations.
ClusterApiController
  • /cluster/host
  • GET
Controller for cluster actions.
HardwareApiController
  • /hardware
  • /hardware/{interface}
  • /hardware/{interface}/{key}
  • /hardware/{interface}/{key}/drivers
  • /hardware/{interface}/{key}/settings
  • GET
  • GET
  • GET
  • GET
  • GET
Controller for controlling and maintaining the configurations, adding and removing of peripherals to the system.
PersonApiController
  • /person
  • /person/{id}
  • GET PATCH POST
  • DELETE GET PATCH
Controller for the person API.
SystemApiController
  • /system/discovery
  • /system/locale
  • /system/locales
  • /system/network
  • POST
  • GET PUT
  • GET
  • GET
Controller for system API's.
UserApiController
  • /user
  • /user/{id}
  • GET POST PUT
  • DELETE GET
API Controller for the UserLogin object.