Skip to content
Product Docs

Get License Info

client.admin.getLicenseInfo(AdminGetLicenseInfoParams { include_scopes } query?, RequestOptionsoptions?): AdminGetLicenseInfoResponse { expires_at, status, message, scopes }
GET/api/v1/admin/license/info

Get License Info

ParametersExpand Collapse
query: AdminGetLicenseInfoParams { include_scopes }
include_scopes?: boolean

Whether to include scopes in the response

ReturnsExpand Collapse
AdminGetLicenseInfoResponse { expires_at, status, message, scopes }
expires_at: string

License expiration date

formatdate-time
status: string

License validation status

message?: string | null

License message

scopes?: Array<string> | null

License scopes

Get License Info

import LlamaCloudAdmin from '@llamaindex/llama-cloud-admin';

const client = new LlamaCloudAdmin({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.admin.getLicenseInfo();

console.log(response.expires_at);
{
  "expires_at": "2019-12-27T18:11:19.117Z",
  "status": "status",
  "message": "message",
  "scopes": [
    "string"
  ]
}
Returns Examples
{
  "expires_at": "2019-12-27T18:11:19.117Z",
  "status": "status",
  "message": "message",
  "scopes": [
    "string"
  ]
}