License settings

Control license settings of the system

API

Get the current state of the license on the device

Path: /api/system/license
Method: GET
Minimum user role: admin
Response:
```
{
    "key": "AAAA-BBBB-CCCC-DDDD-EEEE",
    "state": "active",
    "description": "license is activated successfully",
    "expiry": 4832342389,
    "maintenance_max_version": "2023.07",
    "ssd_key_seed": "hidden",
    "zerotier_expiry": "2023.07",
    "zerotier_available": true,
    "graid_key": "set",
    "features":
      {
        "tcp_analysis_available": true,
        "dns_analysis_available": true,
        "voip_analysis_available": false,
        "http_analysis_available": false,
        "icmp_analysis_available": false,
        "tls_analysis_available": false,
        "rtp_analysis_available": false
      }
}
```
- key - license key
- state - one of:
  - “inactive”
  - “active”
  - “expired”
  - “suspended”
  - “grace_period_over”
  - “machine_fingerprint_changed”
  - “error”
- description - string containing additional info about the license state, for instance, a human-readable error
- expiry - epoch in seconds of when the license is going to expire
- maintenance_max_version - maximum maintenance date in YYYY.MM format
- ssd_key_seed - obfuscated indicator for the SSD key seed; "hidden" when present, null when not set (the actual value is never exposed)
- zerotier_expiry - maximum ZeroTier availability date in YYYY.MM format
- zerotier_available - shows if ZeroTier functionality is allowed by the license
- graid_key - "set" when a graid key is stored on the device, "not set" otherwise (the actual value is never exposed)
- features.tcp_analysis_available - shows if tcp analysis is allowed by the license
- features.dns_analysis_available - shows if dns analysis is allowed by the license
- features.voip_analysis_available - shows if voip analysis is allowed by the license
- features.http_analysis_available - shows if http analysis is allowed by the license
- features.icmp_analysis_available - shows if icmp analysis is allowed by the license
- features.tls_analysis_available - shows if tls analysis is allowed by the license
- features.rtp_analysis_available - shows if rtp analysis is allowed by the license

Change the license key:

Path: /api/system/license
Method: PUT
Minimum user role: admin

Request body:

{
    "key": "AAAA-BBBB-CCCC-DDDD-EEEE"
}

Response: on success, 200 OK with the updated license object (same shape as GET response, with state = "active"); on failure, 400 Bad Request with the error description.