Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.3.x (latest)
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Older Enterprise versions (2.1-2.5)
  • Older OSS versions (2.1-2.5)
  • Archive (pre-2.1)

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this pageOn this page
  • Generate a License Report
  • Report Structure
Kong Gateway
3.0.x
  • Home
  • Kong Gateway
  • Licenses
  • Monitor License Usage
You are browsing documentation for an outdated version. See the latest documentation here.

Monitor License Usage

Obtain information about your Kong Gateway 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:

JSON response
TAR file

For a JSON response, send an HTTP request to the Kong node endpoint /license/report. For example, use this cURL command:

curl {ADMIN_API_URL}/license/report

A JSON response returns, similar to the example below:

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Origin: http://localhost:8002
Connection: keep-alive
Content-Length: 814
Content-Type: application/json; charset=utf-8
Date: Mon, 06 Dec 2021 12:04:28 GMT
Server: kong/3.0.2.0-enterprise-edition
Vary: Origin
X-Kong-Admin-Request-ID: R1jmopI6fjkOLdOuPJVLEmGh4sCLMpSY
{
   "counters": [
    {
        "bucket": "2021-09",
        "request_count": 30
    },
    {
        "bucket": "2020-10",
        "request_count": 42
    },

    {
        "bucket": "2021-11",
        "request_count": 296
    },
    {
        "bucket": "2021-12",
        "request_count": 58
    },
    {
        "bucket": "UNKNOWN",
        "request_count": 50
    }
  ],
   "db_version": "postgres 9.6.24",
   "kong_version": "3.0.2.0-enterprise-edition",
   "license_key": "KONGLICENSEKEY_NOTVALIDFORREAL_USAGE",
   "rbac_users": 0,
   "services_count": 27,
   "system_info": {
      "cores": 6,
      "hostname": "akongnode",
      "uname": "Linux x86_64"
   },
   "workspaces_count":1
}

For a TAR file, enter the following cURL command to make a call to the 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 archived to a *.tar file.

Report Structure

Field Description
counters Counts the number of requests made in a given month.

• bucket: Year and month when the requests were processed. If the value in bucket is UNKNOWN, then the requests were processed before Kong Gateway 2.7.0.1.
• request_count: Number of requests processed in the given month and year.
db_version The type and version of the datastore Kong Gateway is using.
kong_version The version of the Kong Gateway instance.
license_key An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED.
rbac_users The number of users registered with through RBAC.
services_count The number of configured services in the Kong Gateway instance.
system_info Displays information about the system running Kong Gateway.

• cores: Number of CPU cores on the node
• hostname: Encrypted system hostname
• uname: Operating system
workspaces_count The number of workspaces configured in the Kong Gateway instance.
Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023