Estimated reading time:
Table of Contents
Obtain information about your Kong Enterprise deployment, including license usage and deployment information using the License Report module. Share this information with Kong to perform a health-check analysis of product utilization and overall deployment performance to ensure your organization is optimized with the best license and deployment plan for your needs.
How the license report module works:
- The license report module manually generates a report containing usage and deployment data by sending a request to an endpoint, as defined below.
- Share this report with your Kong representative to perform an analysis of your deployment.
What the license report module does not do:
- The license report module does not automatically generate a report or send any data to any Kong servers.
- The license report module does not track or generate any data other than the data that is returned in the response after you send a request to the endpoint.
Generate a License Report
Run the license report module and share the output information with your Kong representative for a deployment analysis.
Prerequisites: You must have Admin privileges to generate a license report.
To generate a license report, from an HTTP client:
For a JSON response, send an HTTP request to the Kong node endpoint
/license/report. For example, use this cURL command:
A JSON response returns, similar to the example below.
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 19 Feb 2020 05:54:23 GMT
For a TAR file, enter the following cURL command to make a call to Kong Admin API.
curl <ADMIN_API_URL>/license/report -o response.json && tar -cf report-$(date +"%Y_%m_%d_%I_%M_%p").tar response.json
A license report file is generated and archives a report to *.tar file.
||Kong Enterprise version
||Current license key identifier
||Storage name and version of node/cluster
||System CPU cores of node
||Number of workspaces
||Number of RBAC users
||Number of requests node/cluster processed