GetLicenseStatus

Response-body reference for GET /get_license_status.

Example

{
  "success": true,
  "message": null,
  "data": {
    "license_key": "<redacted>",
    "valid": true,
    "license_type": "Internet",
    "permissions": {
      "max_streams": 100,
      "images": true,
      "live_video": true,
      "archived_video": true,
      "archive_search": true,
      "live_search": true,
      "face_recognition": true
    }
  }
}

Fields

Field	Type	Description
success	boolean	Indicates whether the request succeeded.
message	string	Optional server message.
data.license_key	string	Configured license key. Treat this value as sensitive.
data.valid	boolean	Whether the current license validates successfully.
data.license_type	string	License mode reported by the server, such as Internet or Air-gapped.
data.permissions.max_streams	number	Maximum licensed stream count.
data.permissions.images	boolean	Whether image processing is allowed.
data.permissions.live_video	boolean	Whether live video monitoring is allowed.
data.permissions.archived_video	boolean	Whether archived video processing is allowed.
data.permissions.archive_search	boolean	Whether archive search is allowed.
data.permissions.live_search	boolean	Whether live search is allowed.
data.permissions.face_recognition	boolean	Whether face recognition workflows are allowed.