diff --git a/api-specs/Gateway-EE/3.4/kong-ee-3.4.yaml b/api-specs/Gateway-EE/3.4/kong-ee-3.4.yaml index d1ec03132ab..f868717c1e2 100644 --- a/api-specs/Gateway-EE/3.4/kong-ee-3.4.yaml +++ b/api-specs/Gateway-EE/3.4/kong-ee-3.4.yaml @@ -2053,55 +2053,142 @@ components: type: object x-examples: Example 1: + checksum: 38b06b3c3c69299740e1f2d48a1a197d17864b99 + consumers_count: 0 counters: - - bucket: 2021-12 - request_count: 0 - db_version: postgres 9.6.19 - kong_version: 3.2.2.1 - license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + total_requests: 10 + buckets: + - bucket: 2025-01 + request_count: 10 + db_version: postgres 13.18 + deployment_info: + type: hybrid + kong_version: 3.9.0.0 + license: + license_expiration_date: "2025-02-20" + license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + plugins_count: + tiers: + custom: 0 + enterprise: + rate-limiting-advanced: 1 + free: + basic-auth: 1 + unique_route_kafkas: 0 + unique_route_lambdas: 0 rbac_users: 0 + routes_count: 0 services_count: 0 system_info: cores: 4 hostname: 13b867agsa008 uname: Linux x86_64 + timestamp: a1737692223 workspaces_count: 1 properties: + checksum: + type: string + description: The checksum of the current report. + example: 38b06b3c3c69299740e1f2d48a1a197d17864b99 counters: - type: array + type: object description: | Counts the number of requests made in a given month. - items: - type: object - properties: - bucket: - type: string - description: 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. - example: 2021-12 - request_count: - type: integer - description: Number of requests processed in the given month and year. - example: 0 + properties: + total_requests: + type: number + description: The total number of requests made in all buckets. + example: 10 + buckets: + type: array + description: A list of year-month buckets and the number of requests made in each one. + items: + properties: + bucket: + type: string + description: 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. + example: 2025-01 + request_count: + type: integer + description: Number of requests processed in the given month and year. + example: 10 db_version: type: string description: | The type and version of the data store Kong Gateway is using. - example: postgres 9.6.19 + example: postgres 13.18 + deployment_info: + type: object + description: Displays information about the deployment running Kong Gateway. + properties: + type: + type: string + description: Type of the deployment mode. + example: traditional + connected_dp_count: + type: number + description: Number of data planes across the cluster. If the deployment is not hybrid mode, the field is not displayed. kong_version: type: string description: | The version of the Kong Gateway instance. - example: 3.2.2.1 - license_key: - type: string - description: | - An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. - example: ASDASDASDASDASDASDASDASDASD_ASDASDA + example: 3.9.0.0 + license: + type: object + description: Information about the license. + properties: + license_expiration_date: + type: string + description: The date current license expires. If no license is present, the field displays as 2017-7-20. + example: "2025-02-20" + license_key: + type: string + description: | + An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. + example: ASDASDASDASDASDASDASDASDASD_ASDASDA rbac_users: type: integer description: | The number of users registered with through RBAC. example: 0 + consumers_count: + type: integer + description: The number of configured consumers in the Kong Gateway instance. + example: 0 + plugins_count: + type: object + description: Counts the number of plugins in use. + properties: + unique_route_lambdas: + type: number + description: | + Number of AWS Lambda plugins in use. Only counts in case of the plugin is defined on a service-less route level and have a unique function name. + example: 0 + unique_route_kafkas: + type: number + description: Number of unique broker IPs listed in broker array across Kafka Upstream plugins defined on a service-less route level. + example: 0 + tiers: + type: object + description: The number of configured plugins in each subscription tier. + properties: + custom: + type: object + description: A list of all configured custom plugins and the number of instances of each. + enterprise: + type: object + description: A list of all configured Enterprise plugins and the number of instances of each. + example: + rate-limiting-advanced: 1 + free: + type: object + description: A list of all configured free plugins and the number of instances of each. + example: + basic-auth: 1 + routes_count: + type: integer + description: The number of configured routes in the Kong Gateway instance. + example: 0 services_count: type: integer description: | @@ -2124,6 +2211,10 @@ components: type: string description: Operating system example: Linux x86_64 + timestamp: + type: string + description: The timestamp of the current response. + example: 1737692223 workspaces_count: type: integer description: | diff --git a/api-specs/Gateway-EE/3.5/kong-ee-3.5.yaml b/api-specs/Gateway-EE/3.5/kong-ee-3.5.yaml index ece80699dd0..09e68c12f27 100644 --- a/api-specs/Gateway-EE/3.5/kong-ee-3.5.yaml +++ b/api-specs/Gateway-EE/3.5/kong-ee-3.5.yaml @@ -2047,55 +2047,142 @@ components: type: object x-examples: Example 1: + checksum: 38b06b3c3c69299740e1f2d48a1a197d17864b99 + consumers_count: 0 counters: - - bucket: 2021-12 - request_count: 0 - db_version: postgres 9.6.19 - kong_version: 3.2.2.1 - license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + total_requests: 10 + buckets: + - bucket: 2025-01 + request_count: 10 + db_version: postgres 13.18 + deployment_info: + type: hybrid + kong_version: 3.9.0.0 + license: + license_expiration_date: "2025-02-20" + license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + plugins_count: + tiers: + custom: 0 + enterprise: + rate-limiting-advanced: 1 + free: + basic-auth: 1 + unique_route_kafkas: 0 + unique_route_lambdas: 0 rbac_users: 0 + routes_count: 0 services_count: 0 system_info: cores: 4 hostname: 13b867agsa008 uname: Linux x86_64 + timestamp: a1737692223 workspaces_count: 1 properties: + checksum: + type: string + description: The checksum of the current report. + example: 38b06b3c3c69299740e1f2d48a1a197d17864b99 counters: - type: array + type: object description: | Counts the number of requests made in a given month. - items: - type: object - properties: - bucket: - type: string - description: 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. - example: 2021-12 - request_count: - type: integer - description: Number of requests processed in the given month and year. - example: 0 + properties: + total_requests: + type: number + description: The total number of requests made in all buckets. + example: 10 + buckets: + type: array + description: A list of year-month buckets and the number of requests made in each one. + items: + properties: + bucket: + type: string + description: 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. + example: 2025-01 + request_count: + type: integer + description: Number of requests processed in the given month and year. + example: 10 db_version: type: string description: | The type and version of the data store Kong Gateway is using. - example: postgres 9.6.19 + example: postgres 13.18 + deployment_info: + type: object + description: Displays information about the deployment running Kong Gateway. + properties: + type: + type: string + description: Type of the deployment mode. + example: traditional + connected_dp_count: + type: number + description: Number of data planes across the cluster. If the deployment is not hybrid mode, the field is not displayed. kong_version: type: string description: | The version of the Kong Gateway instance. - example: 3.2.2.1 - license_key: - type: string - description: | - An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. - example: ASDASDASDASDASDASDASDASDASD_ASDASDA + example: 3.9.0.0 + license: + type: object + description: Information about the license. + properties: + license_expiration_date: + type: string + description: The date current license expires. If no license is present, the field displays as 2017-7-20. + example: "2025-02-20" + license_key: + type: string + description: | + An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. + example: ASDASDASDASDASDASDASDASDASD_ASDASDA rbac_users: type: integer description: | The number of users registered with through RBAC. example: 0 + consumers_count: + type: integer + description: The number of configured consumers in the Kong Gateway instance. + example: 0 + plugins_count: + type: object + description: Counts the number of plugins in use. + properties: + unique_route_lambdas: + type: number + description: | + Number of AWS Lambda plugins in use. Only counts in case of the plugin is defined on a service-less route level and have a unique function name. + example: 0 + unique_route_kafkas: + type: number + description: Number of unique broker IPs listed in broker array across Kafka Upstream plugins defined on a service-less route level. + example: 0 + tiers: + type: object + description: The number of configured plugins in each subscription tier. + properties: + custom: + type: object + description: A list of all configured custom plugins and the number of instances of each. + enterprise: + type: object + description: A list of all configured Enterprise plugins and the number of instances of each. + example: + rate-limiting-advanced: 1 + free: + type: object + description: A list of all configured free plugins and the number of instances of each. + example: + basic-auth: 1 + routes_count: + type: integer + description: The number of configured routes in the Kong Gateway instance. + example: 0 services_count: type: integer description: | @@ -2118,6 +2205,10 @@ components: type: string description: Operating system example: Linux x86_64 + timestamp: + type: string + description: The timestamp of the current response. + example: 1737692223 workspaces_count: type: integer description: | diff --git a/api-specs/Gateway-EE/3.6/kong-ee-3.6.yaml b/api-specs/Gateway-EE/3.6/kong-ee-3.6.yaml index a954875767c..8f7847d0d53 100644 --- a/api-specs/Gateway-EE/3.6/kong-ee-3.6.yaml +++ b/api-specs/Gateway-EE/3.6/kong-ee-3.6.yaml @@ -2085,55 +2085,142 @@ components: type: object x-examples: Example 1: + checksum: 38b06b3c3c69299740e1f2d48a1a197d17864b99 + consumers_count: 0 counters: - - bucket: 2021-12 - request_count: 0 - db_version: postgres 9.6.19 - kong_version: 3.2.2.1 - license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + total_requests: 10 + buckets: + - bucket: 2025-01 + request_count: 10 + db_version: postgres 13.18 + deployment_info: + type: hybrid + kong_version: 3.9.0.0 + license: + license_expiration_date: "2025-02-20" + license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + plugins_count: + tiers: + custom: 0 + enterprise: + rate-limiting-advanced: 1 + free: + basic-auth: 1 + unique_route_kafkas: 0 + unique_route_lambdas: 0 rbac_users: 0 + routes_count: 0 services_count: 0 system_info: cores: 4 hostname: 13b867agsa008 uname: Linux x86_64 + timestamp: a1737692223 workspaces_count: 1 properties: + checksum: + type: string + description: The checksum of the current report. + example: 38b06b3c3c69299740e1f2d48a1a197d17864b99 counters: - type: array + type: object description: | Counts the number of requests made in a given month. - items: - type: object - properties: - bucket: - type: string - description: 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. - example: 2021-12 - request_count: - type: integer - description: Number of requests processed in the given month and year. - example: 0 + properties: + total_requests: + type: number + description: The total number of requests made in all buckets. + example: 10 + buckets: + type: array + description: A list of year-month buckets and the number of requests made in each one. + items: + properties: + bucket: + type: string + description: 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. + example: 2025-01 + request_count: + type: integer + description: Number of requests processed in the given month and year. + example: 10 db_version: type: string description: | The type and version of the data store Kong Gateway is using. - example: postgres 9.6.19 + example: postgres 13.18 + deployment_info: + type: object + description: Displays information about the deployment running Kong Gateway. + properties: + type: + type: string + description: Type of the deployment mode. + example: traditional + connected_dp_count: + type: number + description: Number of data planes across the cluster. If the deployment is not hybrid mode, the field is not displayed. kong_version: type: string description: | The version of the Kong Gateway instance. - example: 3.2.2.1 - license_key: - type: string - description: | - An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. - example: ASDASDASDASDASDASDASDASDASD_ASDASDA + example: 3.9.0.0 + license: + type: object + description: Information about the license. + properties: + license_expiration_date: + type: string + description: The date current license expires. If no license is present, the field displays as 2017-7-20. + example: "2025-02-20" + license_key: + type: string + description: | + An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. + example: ASDASDASDASDASDASDASDASDASD_ASDASDA rbac_users: type: integer description: | The number of users registered with through RBAC. example: 0 + consumers_count: + type: integer + description: The number of configured consumers in the Kong Gateway instance. + example: 0 + plugins_count: + type: object + description: Counts the number of plugins in use. + properties: + unique_route_lambdas: + type: number + description: | + Number of AWS Lambda plugins in use. Only counts in case of the plugin is defined on a service-less route level and have a unique function name. + example: 0 + unique_route_kafkas: + type: number + description: Number of unique broker IPs listed in broker array across Kafka Upstream plugins defined on a service-less route level. + example: 0 + tiers: + type: object + description: The number of configured plugins in each subscription tier. + properties: + custom: + type: object + description: A list of all configured custom plugins and the number of instances of each. + enterprise: + type: object + description: A list of all configured Enterprise plugins and the number of instances of each. + example: + rate-limiting-advanced: 1 + free: + type: object + description: A list of all configured free plugins and the number of instances of each. + example: + basic-auth: 1 + routes_count: + type: integer + description: The number of configured routes in the Kong Gateway instance. + example: 0 services_count: type: integer description: | @@ -2156,6 +2243,10 @@ components: type: string description: Operating system example: Linux x86_64 + timestamp: + type: string + description: The timestamp of the current response. + example: 1737692223 workspaces_count: type: integer description: | diff --git a/api-specs/Gateway-EE/3.7/kong-ee-3.7.yaml b/api-specs/Gateway-EE/3.7/kong-ee-3.7.yaml index 785a7bab010..187c876f90b 100644 --- a/api-specs/Gateway-EE/3.7/kong-ee-3.7.yaml +++ b/api-specs/Gateway-EE/3.7/kong-ee-3.7.yaml @@ -2125,55 +2125,142 @@ components: type: object x-examples: Example 1: + checksum: 38b06b3c3c69299740e1f2d48a1a197d17864b99 + consumers_count: 0 counters: - - bucket: 2021-12 - request_count: 0 - db_version: postgres 9.6.19 - kong_version: 3.2.2.1 - license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + total_requests: 10 + buckets: + - bucket: 2025-01 + request_count: 10 + db_version: postgres 13.18 + deployment_info: + type: hybrid + kong_version: 3.9.0.0 + license: + license_expiration_date: "2025-02-20" + license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + plugins_count: + tiers: + custom: 0 + enterprise: + rate-limiting-advanced: 1 + free: + basic-auth: 1 + unique_route_kafkas: 0 + unique_route_lambdas: 0 rbac_users: 0 + routes_count: 0 services_count: 0 system_info: cores: 4 hostname: 13b867agsa008 uname: Linux x86_64 + timestamp: a1737692223 workspaces_count: 1 properties: + checksum: + type: string + description: The checksum of the current report. + example: 38b06b3c3c69299740e1f2d48a1a197d17864b99 counters: - type: array + type: object description: | Counts the number of requests made in a given month. - items: - type: object - properties: - bucket: - type: string - description: 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. - example: 2021-12 - request_count: - type: integer - description: Number of requests processed in the given month and year. - example: 0 + properties: + total_requests: + type: number + description: The total number of requests made in all buckets. + example: 10 + buckets: + type: array + description: A list of year-month buckets and the number of requests made in each one. + items: + properties: + bucket: + type: string + description: 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. + example: 2025-01 + request_count: + type: integer + description: Number of requests processed in the given month and year. + example: 10 db_version: type: string description: | The type and version of the data store Kong Gateway is using. - example: postgres 9.6.19 + example: postgres 13.18 + deployment_info: + type: object + description: Displays information about the deployment running Kong Gateway. + properties: + type: + type: string + description: Type of the deployment mode. + example: traditional + connected_dp_count: + type: number + description: Number of data planes across the cluster. If the deployment is not hybrid mode, the field is not displayed. kong_version: type: string description: | The version of the Kong Gateway instance. - example: 3.2.2.1 - license_key: - type: string - description: | - An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. - example: ASDASDASDASDASDASDASDASDASD_ASDASDA + example: 3.9.0.0 + license: + type: object + description: Information about the license. + properties: + license_expiration_date: + type: string + description: The date current license expires. If no license is present, the field displays as 2017-7-20. + example: "2025-02-20" + license_key: + type: string + description: | + An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. + example: ASDASDASDASDASDASDASDASDASD_ASDASDA rbac_users: type: integer description: | The number of users registered with through RBAC. example: 0 + consumers_count: + type: integer + description: The number of configured consumers in the Kong Gateway instance. + example: 0 + plugins_count: + type: object + description: Counts the number of plugins in use. + properties: + unique_route_lambdas: + type: number + description: | + Number of AWS Lambda plugins in use. Only counts in case of the plugin is defined on a service-less route level and have a unique function name. + example: 0 + unique_route_kafkas: + type: number + description: Number of unique broker IPs listed in broker array across Kafka Upstream plugins defined on a service-less route level. + example: 0 + tiers: + type: object + description: The number of configured plugins in each subscription tier. + properties: + custom: + type: object + description: A list of all configured custom plugins and the number of instances of each. + enterprise: + type: object + description: A list of all configured Enterprise plugins and the number of instances of each. + example: + rate-limiting-advanced: 1 + free: + type: object + description: A list of all configured free plugins and the number of instances of each. + example: + basic-auth: 1 + routes_count: + type: integer + description: The number of configured routes in the Kong Gateway instance. + example: 0 services_count: type: integer description: | @@ -2196,6 +2283,10 @@ components: type: string description: Operating system example: Linux x86_64 + timestamp: + type: string + description: The timestamp of the current response. + example: 1737692223 workspaces_count: type: integer description: | diff --git a/api-specs/Gateway-EE/3.8/kong-ee.yaml b/api-specs/Gateway-EE/3.8/kong-ee.yaml index b25efa247f6..f3d16d17bf1 100644 --- a/api-specs/Gateway-EE/3.8/kong-ee.yaml +++ b/api-specs/Gateway-EE/3.8/kong-ee.yaml @@ -2124,55 +2124,142 @@ components: type: object x-examples: Example 1: + checksum: 38b06b3c3c69299740e1f2d48a1a197d17864b99 + consumers_count: 0 counters: - - bucket: 2021-12 - request_count: 0 - db_version: postgres 9.6.19 - kong_version: 3.2.2.1 - license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + total_requests: 10 + buckets: + - bucket: 2025-01 + request_count: 10 + db_version: postgres 13.18 + deployment_info: + type: hybrid + kong_version: 3.9.0.0 + license: + license_expiration_date: "2025-02-20" + license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + plugins_count: + tiers: + custom: 0 + enterprise: + rate-limiting-advanced: 1 + free: + basic-auth: 1 + unique_route_kafkas: 0 + unique_route_lambdas: 0 rbac_users: 0 + routes_count: 0 services_count: 0 system_info: cores: 4 hostname: 13b867agsa008 uname: Linux x86_64 + timestamp: a1737692223 workspaces_count: 1 properties: + checksum: + type: string + description: The checksum of the current report. + example: 38b06b3c3c69299740e1f2d48a1a197d17864b99 counters: - type: array + type: object description: | Counts the number of requests made in a given month. - items: - type: object - properties: - bucket: - type: string - description: 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. - example: 2021-12 - request_count: - type: integer - description: Number of requests processed in the given month and year. - example: 0 + properties: + total_requests: + type: number + description: The total number of requests made in all buckets. + example: 10 + buckets: + type: array + description: A list of year-month buckets and the number of requests made in each one. + items: + properties: + bucket: + type: string + description: 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. + example: 2025-01 + request_count: + type: integer + description: Number of requests processed in the given month and year. + example: 10 db_version: type: string description: | The type and version of the data store Kong Gateway is using. - example: postgres 9.6.19 + example: postgres 13.18 + deployment_info: + type: object + description: Displays information about the deployment running Kong Gateway. + properties: + type: + type: string + description: Type of the deployment mode. + example: traditional + connected_dp_count: + type: number + description: Number of data planes across the cluster. If the deployment is not hybrid mode, the field is not displayed. kong_version: type: string description: | The version of the Kong Gateway instance. - example: 3.2.2.1 - license_key: - type: string - description: | - An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. - example: ASDASDASDASDASDASDASDASDASD_ASDASDA + example: 3.9.0.0 + license: + type: object + description: Information about the license. + properties: + license_expiration_date: + type: string + description: The date current license expires. If no license is present, the field displays as 2017-7-20. + example: "2025-02-20" + license_key: + type: string + description: | + An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. + example: ASDASDASDASDASDASDASDASDASD_ASDASDA rbac_users: type: integer description: | The number of users registered with through RBAC. example: 0 + consumers_count: + type: integer + description: The number of configured consumers in the Kong Gateway instance. + example: 0 + plugins_count: + type: object + description: Counts the number of plugins in use. + properties: + unique_route_lambdas: + type: number + description: | + Number of AWS Lambda plugins in use. Only counts in case of the plugin is defined on a service-less route level and have a unique function name. + example: 0 + unique_route_kafkas: + type: number + description: Number of unique broker IPs listed in broker array across Kafka Upstream plugins defined on a service-less route level. + example: 0 + tiers: + type: object + description: The number of configured plugins in each subscription tier. + properties: + custom: + type: object + description: A list of all configured custom plugins and the number of instances of each. + enterprise: + type: object + description: A list of all configured Enterprise plugins and the number of instances of each. + example: + rate-limiting-advanced: 1 + free: + type: object + description: A list of all configured free plugins and the number of instances of each. + example: + basic-auth: 1 + routes_count: + type: integer + description: The number of configured routes in the Kong Gateway instance. + example: 0 services_count: type: integer description: | @@ -2195,6 +2282,10 @@ components: type: string description: Operating system example: Linux x86_64 + timestamp: + type: string + description: The timestamp of the current response. + example: 1737692223 workspaces_count: type: integer description: | diff --git a/api-specs/Gateway-EE/3.9/kong-ee.yaml b/api-specs/Gateway-EE/3.9/kong-ee.yaml index 0d222bba3f8..e92f7b3df5e 100644 --- a/api-specs/Gateway-EE/3.9/kong-ee.yaml +++ b/api-specs/Gateway-EE/3.9/kong-ee.yaml @@ -2248,55 +2248,142 @@ components: type: object x-examples: Example 1: + checksum: 38b06b3c3c69299740e1f2d48a1a197d17864b99 + consumers_count: 0 counters: - - bucket: 2021-12 - request_count: 0 - db_version: postgres 9.6.19 - kong_version: 3.2.2.1 - license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + total_requests: 10 + buckets: + - bucket: 2025-01 + request_count: 10 + db_version: postgres 13.18 + deployment_info: + type: hybrid + kong_version: 3.9.0.0 + license: + license_expiration_date: "2025-02-20" + license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + plugins_count: + tiers: + custom: 0 + enterprise: + rate-limiting-advanced: 1 + free: + basic-auth: 1 + unique_route_kafkas: 0 + unique_route_lambdas: 0 rbac_users: 0 + routes_count: 0 services_count: 0 system_info: cores: 4 hostname: 13b867agsa008 uname: Linux x86_64 + timestamp: a1737692223 workspaces_count: 1 properties: + checksum: + type: string + description: The checksum of the current report. + example: 38b06b3c3c69299740e1f2d48a1a197d17864b99 counters: - type: array + type: object description: | Counts the number of requests made in a given month. - items: - type: object - properties: - bucket: - type: string - description: 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. - example: 2021-12 - request_count: - type: integer - description: Number of requests processed in the given month and year. - example: 0 + properties: + total_requests: + type: number + description: The total number of requests made in all buckets. + example: 10 + buckets: + type: array + description: A list of year-month buckets and the number of requests made in each one. + items: + properties: + bucket: + type: string + description: 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. + example: 2025-01 + request_count: + type: integer + description: Number of requests processed in the given month and year. + example: 10 db_version: type: string description: | The type and version of the data store Kong Gateway is using. - example: postgres 9.6.19 + example: postgres 13.18 + deployment_info: + type: object + description: Displays information about the deployment running Kong Gateway. + properties: + type: + type: string + description: Type of the deployment mode. + example: traditional + connected_dp_count: + type: number + description: Number of data planes across the cluster. If the deployment is not hybrid mode, the field is not displayed. kong_version: type: string description: | The version of the Kong Gateway instance. - example: 3.2.2.1 - license_key: - type: string - description: | - An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. - example: ASDASDASDASDASDASDASDASDASD_ASDASDA + example: 3.9.0.0 + license: + type: object + description: Information about the license. + properties: + license_expiration_date: + type: string + description: The date current license expires. If no license is present, the field displays as 2017-7-20. + example: "2025-02-20" + license_key: + type: string + description: | + An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. + example: ASDASDASDASDASDASDASDASDASD_ASDASDA rbac_users: type: integer description: | The number of users registered with through RBAC. example: 0 + consumers_count: + type: integer + description: The number of configured consumers in the Kong Gateway instance. + example: 0 + plugins_count: + type: object + description: Counts the number of plugins in use. + properties: + unique_route_lambdas: + type: number + description: | + Number of AWS Lambda plugins in use. Only counts in case of the plugin is defined on a service-less route level and have a unique function name. + example: 0 + unique_route_kafkas: + type: number + description: Number of unique broker IPs listed in broker array across Kafka Upstream plugins defined on a service-less route level. + example: 0 + tiers: + type: object + description: The number of configured plugins in each subscription tier. + properties: + custom: + type: object + description: A list of all configured custom plugins and the number of instances of each. + enterprise: + type: object + description: A list of all configured Enterprise plugins and the number of instances of each. + example: + rate-limiting-advanced: 1 + free: + type: object + description: A list of all configured free plugins and the number of instances of each. + example: + basic-auth: 1 + routes_count: + type: integer + description: The number of configured routes in the Kong Gateway instance. + example: 0 services_count: type: integer description: | @@ -2319,6 +2406,10 @@ components: type: string description: Operating system example: Linux x86_64 + timestamp: + type: string + description: The timestamp of the current response. + example: 1737692223 workspaces_count: type: integer description: | diff --git a/api-specs/Gateway-EE/latest/kong-ee.yaml b/api-specs/Gateway-EE/latest/kong-ee.yaml index 7dbad26ebd5..859954f44e4 100644 --- a/api-specs/Gateway-EE/latest/kong-ee.yaml +++ b/api-specs/Gateway-EE/latest/kong-ee.yaml @@ -2124,55 +2124,142 @@ components: type: object x-examples: Example 1: + checksum: 38b06b3c3c69299740e1f2d48a1a197d17864b99 + consumers_count: 0 counters: - - bucket: 2021-12 - request_count: 0 - db_version: postgres 9.6.19 - kong_version: 3.2.2.1 - license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + total_requests: 10 + buckets: + - bucket: 2025-01 + request_count: 10 + db_version: postgres 13.18 + deployment_info: + type: hybrid + kong_version: 3.9.0.0 + license: + license_expiration_date: "2025-02-20" + license_key: ASDASDASDASDASDASDASDASDASD_ASDASDA + plugins_count: + tiers: + custom: 0 + enterprise: + rate-limiting-advanced: 1 + free: + basic-auth: 1 + unique_route_kafkas: 0 + unique_route_lambdas: 0 rbac_users: 0 + routes_count: 0 services_count: 0 system_info: cores: 4 hostname: 13b867agsa008 uname: Linux x86_64 + timestamp: a1737692223 workspaces_count: 1 properties: + checksum: + type: string + description: The checksum of the current report. + example: 38b06b3c3c69299740e1f2d48a1a197d17864b99 counters: - type: array + type: object description: | Counts the number of requests made in a given month. - items: - type: object - properties: - bucket: - type: string - description: 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. - example: 2021-12 - request_count: - type: integer - description: Number of requests processed in the given month and year. - example: 0 + properties: + total_requests: + type: number + description: The total number of requests made in all buckets. + example: 10 + buckets: + type: array + description: A list of year-month buckets and the number of requests made in each one. + items: + properties: + bucket: + type: string + description: 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. + example: 2025-01 + request_count: + type: integer + description: Number of requests processed in the given month and year. + example: 10 db_version: type: string description: | The type and version of the data store Kong Gateway is using. - example: postgres 9.6.19 + example: postgres 13.18 + deployment_info: + type: object + description: Displays information about the deployment running Kong Gateway. + properties: + type: + type: string + description: Type of the deployment mode. + example: traditional + connected_dp_count: + type: number + description: Number of data planes across the cluster. If the deployment is not hybrid mode, the field is not displayed. kong_version: type: string description: | The version of the Kong Gateway instance. - example: 3.2.2.1 - license_key: - type: string - description: | - An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. - example: ASDASDASDASDASDASDASDASDASD_ASDASDA + example: 3.9.0.0 + license: + type: object + description: Information about the license. + properties: + license_expiration_date: + type: string + description: The date current license expires. If no license is present, the field displays as 2017-7-20. + example: "2025-02-20" + license_key: + type: string + description: | + An encrypted identifier for the current license key. If no license is present, the field displays as UNLICENSED. + example: ASDASDASDASDASDASDASDASDASD_ASDASDA rbac_users: type: integer description: | The number of users registered with through RBAC. example: 0 + consumers_count: + type: integer + description: The number of configured consumers in the Kong Gateway instance. + example: 0 + plugins_count: + type: object + description: Counts the number of plugins in use. + properties: + unique_route_lambdas: + type: number + description: | + Number of AWS Lambda plugins in use. Only counts in case of the plugin is defined on a service-less route level and have a unique function name. + example: 0 + unique_route_kafkas: + type: number + description: Number of unique broker IPs listed in broker array across Kafka Upstream plugins defined on a service-less route level. + example: 0 + tiers: + type: object + description: The number of configured plugins in each subscription tier. + properties: + custom: + type: object + description: A list of all configured custom plugins and the number of instances of each. + enterprise: + type: object + description: A list of all configured Enterprise plugins and the number of instances of each. + example: + rate-limiting-advanced: 1 + free: + type: object + description: A list of all configured free plugins and the number of instances of each. + example: + basic-auth: 1 + routes_count: + type: integer + description: The number of configured routes in the Kong Gateway instance. + example: 0 services_count: type: integer description: | @@ -2195,6 +2282,10 @@ components: type: string description: Operating system example: Linux x86_64 + timestamp: + type: string + description: The timestamp of the current response. + example: 1737692223 workspaces_count: type: integer description: |