Method: legacySystem.legacyGetLicenseStatus

Full name: projects.locations.instances.legacySystem.legacyGetLicenseStatus

Legacy endpoint for getting the license status.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to get the license status for. Format: projects/{project}/locations/{location}/instances/{instance}/legacySystem:legacyGetLicenseStatus

Request body

The request body must be empty.

Response body

Response message for legacySystem.legacyGetLicenseStatus.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "licenceRemainingDays": integer,
  "usersAmountLimit": integer,
  "collaboratorUsersAmountLimit": integer,
  "viewOnlyUsersAmountLimit": integer,
  "managedUserUsersAmountLimit": integer,
  "managedUserPlusUsersAmountLimit": integer,
  "environmentsAmountLimit": integer,
  "environmentsThatIncludesAgentsLimit": integer,
  "usersInUsage": integer,
  "collaboratorUsersInUsage": integer,
  "viewOnlyUsersInUsage": integer,
  "managedUserUsersInUsage": integer,
  "managedUserPlusUsersInUsage": integer,
  "environmentsThatIncludesAgentsUsage": integer,
  "environmentsInUsage": integer,
  "remainingUsers": integer,
  "alertsPerDayLimit": integer,
  "alertsPerDayInUsage": integer,
  "remainingViewOnlyUsers": integer,
  "remainingCollaboratorUsers": integer,
  "remainingManagedUserUsers": integer,
  "remainingManagedUserPlusUsers": integer,
  "playbooksInUsage": integer,
  "playbooksAmountLimit": integer,
  "connectorsInUsage": integer,
  "connectorsAmountLimit": integer,
  "webhooksInUsage": integer,
  "webhooksAmountLimit": integer,
  "remainingEnvironments": integer,
  "remainingEnvironmentsThatIncludesAgents": integer,
  "serverVersion": string,
  "systemModules": [
    {
      object (LicenceModuleStatus)
    }
  ],
  "isEvaluation": boolean,
  "maxDataRetentionDuration": integer,
  "licenseType": enum (LicenseType),
  "customerId": string,
  "expirationDateUnixTimeInMs": string,
  "warRoomEnvironmentLimit": integer,
  "warRoomEnvironmentUsage": integer,
  "advancedReportsUserLimit": string,
  "advancedReportsUserUsage": integer
}
Fields
licenceRemainingDays

integer

The remaining license days.
usersAmountLimit

integer

The number of users allowed.
collaboratorUsersAmountLimit

integer

The number of collaborator users allowed.
viewOnlyUsersAmountLimit

integer

The number of view only users allowed.
managedUserUsersAmountLimit

integer

The number of managed user users allowed.
managedUserPlusUsersAmountLimit

integer

The number of managed user plus users allowed.
environmentsAmountLimit

integer

The number of environments allowed.
environmentsThatIncludesAgentsLimit

integer

The number of environments that includes agents allowed.
usersInUsage

integer

The number of users in usage.
collaboratorUsersInUsage

integer

The number of collaborator users in usage.
viewOnlyUsersInUsage

integer

The number of view only users in usage.
managedUserUsersInUsage

integer

The number of managed user users in usage.
managedUserPlusUsersInUsage

integer

The number of managed user plus users in usage.
environmentsThatIncludesAgentsUsage

integer

The number of environments that includes agents in usage.
environmentsInUsage

integer

The number of environments in usage.
remainingUsers

integer

The number of remaining users.
alertsPerDayLimit

integer

The number of alerts per day limit.
alertsPerDayInUsage

integer

The number of alerts per day in usage.
remainingViewOnlyUsers

integer

The number of remaining view only users.
remainingCollaboratorUsers

integer

The number of remaining collaborator users.
remainingManagedUserUsers

integer

The number of remaining managed user users.
remainingManagedUserPlusUsers

integer

The number of remaining managed user plus users.
playbooksInUsage

integer

The number of playbooks in usage.
playbooksAmountLimit

integer

The number of playbooks allowed.
connectorsInUsage

integer

The number of connectors in usage.
connectorsAmountLimit

integer

The number of connectors allowed.
webhooksInUsage

integer

The number of webhooks in usage.
webhooksAmountLimit

integer

The number of webhooks allowed.
remainingEnvironments

integer

The number of remaining environments.
remainingEnvironmentsThatIncludesAgents

integer

The number of remaining environments that includes agents.
serverVersion

string

The server version.
systemModules[]

object (LicenceModuleStatus)

The list of system modules.
isEvaluation

boolean

Whether the instance is an evaluation instance.
maxDataRetentionDuration

integer

The maximum data retention value time in months.
licenseType

enum (LicenseType)

The license type.
customerId

string

The customer id.
expirationDateUnixTimeInMs

string (int64 format)

The expiration date in unix time in milliseconds.
warRoomEnvironmentLimit

integer

The number of war room environments allowed.
warRoomEnvironmentUsage

integer

The number of war room environments in usage.
advancedReportsUserLimit

string

The number of advanced reports users allowed.
advancedReportsUserUsage

integer

The number of advanced reports users in usage.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

LicenceModuleStatus

The license module status.

JSON representation 
{
  "name": string,
  "identifier": string,
  "isActive": boolean
}
Fields
name

string

The name of the license module.
identifier

string

The identifier of the license module.
isActive

boolean

Whether the license module is active.

LicenseType

The license type.

Enums
LICENSE_TYPE_UNSPECIFIED Unspecified license type.
ENTERPRISE Enterprise license type.
COMMUNITY Community license type.
EVALUATION Evaluation license type.
CLOUD Cloud license type.