Get license status

GET 
/license/status

Returns the status of the Enterprise license installed on this server, including its holder, expiry, remaining days and node limits. Any authenticated user can call it.

Sign in with a bearer token or a local user's password; see Authentication.

Responses

200

The status of the installed Enterprise license, including its holder, expiry, remaining days and node limits.

application/vnd.gravitino.v1+json

Schema

Schema

issuedTo stringrequired

The customer the license is issued to

licenseId stringrequired

The license identifier

expiresAt date-timerequired

The license expiration time, at the start of the expiration day in UTC

daysRemaining int64required

Days remaining until the license expires, or until the grace period ends when the status is IN_GRACE_PERIOD. Negative when the status is EXPIRED: the absolute value is the number of days past the end of the grace period.

gracePeriodDays int32required

The number of days the server keeps working after the license expires

status stringrequired

Possible values: [VALID, EXPIRING_SOON, IN_GRACE_PERIOD, EXPIRED]

The license status

maxNodes int32required

The maximum number of server nodes allowed by the license; -1 means unlimited

activeNodes int32required

The number of server nodes currently active

Example (from schema)

{
  "issuedTo": "string",
  "licenseId": "string",
  "expiresAt": "2024-07-29T15:51:28.071Z",
  "daysRemaining": 0,
  "gracePeriodDays": 0,
  "status": "VALID",
  "maxNodes": 0,
  "activeNodes": 0
}

LicenseStatus

{
  "issuedTo": "Example Corp",
  "licenseId": "lic-2026-0001",
  "expiresAt": "2027-06-30T00:00:00Z",
  "daysRemaining": 288,
  "gracePeriodDays": 14,
  "status": "VALID",
  "maxNodes": 3,
  "activeNodes": 2
}

401

The request is not authenticated.

application/json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

5xx

The server hit an internal error that the client usually cannot fix by changing the request.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...