Get API7 Enterprise license details

GET /api/license

Get API7 Enterprise license details

Retrieve current API7 Enterprise license information, including validity and licensed capabilities. Use this endpoint to inspect license status for operations and troubleshooting.

Parameters

Responses

• 200: Successfully retrieved the current license information.

• allOf variant 1

• value (object, optional): The specific resource.

• allOf variant 2

• value (object, optional): The license object.

• allOf variant 1

• value.customer (string, optional): The customer name.

• value.effective_at (integer, optional): The timestamp when the license becomes effective.

• value.expired_at (integer, optional): The timestamp when the license expires.

• value.max_dp_cores (integer, optional): The maximum number of DP cores available to production gateway groups.

• value.max_non_production_dp_cores (integer, optional): The maximum number of DP cores available to non-production gateway groups. Licenses issued before the production / non-production split carry no such allowance, so this reads as 0 and any gateway group flagged non-production is immediately over its limit.

• value.feature_list (array, optional): An array of licensed features.

• value.deployment_id (string, optional): A unique identifier that is automatically generated with each deployment of API7 Enterprise.

• value.free_trial (boolean, optional): If true, the license is for free trial only.

• value.is_test_env (boolean, optional): If true, license is for test environment.

• value.issuance_date (integer, optional): The license issuance timestamp.

• value.ai_gateway (object, optional): AI Gateway authorization status.

• value.ai_gateway.status (string, optional): The AI Gateway authorization status:

• not_authorized: AI Gateway is not included in the license.

• not_effective: AI Gateway license has not yet taken effect.

• normal: AI Gateway is authorized and active.

• expired: AI Gateway license has expired. Existing configurations remain active, but modifications are not allowed.

• value.ai_gateway.effective_at (integer, optional): The timestamp when the AI Gateway license becomes effective.

• value.ai_gateway.expired_at (integer, optional): The timestamp when the AI Gateway license expires.

• allOf variant 2

• value.runtime (object, optional): The runtime state of the license DP core allowances. The top-level fields describe the production allowance; non_production describes the non-production one. The two are metered and restricted independently.

• value.runtime.status (string, optional): The runtime status of one DP core allowance:

• normal: usage is within the allowance.

• dp_core_exceeded: usage is over the allowance and the grace period is still running.

• dp_core_exceeded_restricted: the grace period has elapsed, so writes against gateway groups drawing from this allowance are rejected.

• value.runtime.dp_core_exceeded_start_at (integer, optional): The start time when the number of DP cores exceeds the maximum number of DP cores of the license (buffering state).

• value.runtime.dp_core_exceeded_end_at (integer, optional): The end time when the number of DP cores exceeds the maximum number of DP cores of the license (buffering state). In this case, API usage will be restricted.

• value.runtime.max_dp_cores (integer, optional): The highest number of cores during the buffering period, which is 0 in normal conditions.

• value.runtime.non_production (object, optional): The runtime state of the non-production DP core allowance.

• value.runtime.non_production.status (string, optional): The runtime status of one DP core allowance:

• normal: usage is within the allowance.

• dp_core_exceeded: usage is over the allowance and the grace period is still running.

• dp_core_exceeded_restricted: the grace period has elapsed, so writes against gateway groups drawing from this allowance are rejected.

• value.runtime.non_production.dp_core_exceeded_start_at (integer, optional): The start time when non-production DP core usage exceeded the allowance (buffering state).

• value.runtime.non_production.dp_core_exceeded_end_at (integer, optional): The end time of the buffering state. Past this point, writes against non-production gateway groups are restricted.

• value.runtime.non_production.max_dp_cores (integer, optional): The highest number of non-production cores measured, which is 0 when no gateway group is flagged non-production.

• allOf variant 3

• value.status (string, optional): The license status, which can be either normal or expired.

• 400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.

• value (object, optional): The specific resource.

• error_msg (string, optional): The error message.

cURL

curl -X GET '$API_BASE_URL/api/license'