Skip to content

API Reference

API Reference

Check License

The check-license API endpoint is designed to verify the validity of controllers' licenses. Also return the controller config.

Endpoint: POST /api/check-license/

Parameters:

  • guid (UUID v1) - Required. Controller Guid.
  • hostname (String) - Required System Hostname
  • version (String) - Required Controller Version
  • ip_addresses (List) - Required List of Controller IPs
  • mac_address (String) - Required Mac Address of the Controller
  • os (String) - Required OS of the Controller
  • label (String) - Required Label of the Machine
  • logdir (String) - Required Logdir of Controller

Get Active GUIDs

The get-licenses API endpoint retrieves the list of active GUIDs.

Endpoint: GET /api/get-licenses/

Description: Display the list of active licensed controllers.