Get Current License Details

Get details for the current license of the system. This API does not require any parameters.

Resource name: /api/v1/license

Request Method: GET

cURL Example:

curl -X GET "https://<localhost>/api/v1/license" -H "Authorization: Bearer {token}"

Status codes:

Code	Description
200	OK - Successfully retrieved license details.
400	Bad Request - The request is invalid.
401	Unauthorized - Authentication failed.
403	Forbidden - Access to the resource is denied.
404	Not Found - The requested resource does not exist.
500	Internal Server Error - An error occurred on the server.

Response parameters:

Parameter	Type	Description
firewall_usage	string (numeric)	Number of firewalls currently in use.
Routers_quota	string (numeric)	Maximum number of routers allowed by the license.
Account_name	string	Name of the account associated with the license.
Modules_	string (semicolon-separated)	List of licensed modules.
Issued_on	string (date)	Date when the license was issued.
Monitored_devices_quota	string (numeric)	Maximum number of monitored devices permitted.
License_type	string	The type of license issued.
Firewalls_quota	string (numeric)	Maximum number of firewalls allowed by the license.
router_usage	string (numeric)	Number of routers currently in use.
Expires_on	string (date)	Expiration date of the license.
Issued_by	string	Name or identifier of the entity that issued the license.
License_id	string	Unique identifier for the license.
MAC_Address	string	MAC address associated with the license.
License_version	string	Version of the license.

Response example success 200:

Copy

{
  "firewall_usage": "66",
  "Routers_quota": "999999",
  "Account_name": "Algosec_QA_AFA_FF_Testing",
  "Modules_": "Core;Optimization;Risk;FireFlow;ActiveChange;BusinessFlow-5;AutoDiscovery-5",
  "Issued_on": "04-May-2022",
  "Monitored_devices_quota": "999999",
  "License_type": "PerFW-Online",
  "Firewalls_quota": "999999",
  "router_usage": "0",
  "Expires_on": "16-Jun-2032",
  "Issued_by": "root",
  "License_id": "b05fb11b",
  "MAC_Address": "005056AE5FE2",
  "License_version": "7.2"
}

Response example failure 400:

Copy

{
  "error": "Invalid request parameters",
  "description": "string",
  "fieldErrors": [
    {
      "field": "string",
      "error": "string"
    }
  ]
}