Infrastructure¶
Use the endpoints described below to manage cluster licenses.
GET /api/v2/clusterLicense/¶
Retrieve the information about the currently deployed cluster license.
Example responses¶
200 Response
{
"properties": {
"licenseInfo": {
"description": "The license info object will describe detailed information about the deployed license",
"properties": {
"concurrentWorkersCount": {
"description": "The number of allowed simultaneously running jobs(concurrent workers)",
"minimum": 0,
"type": "integer"
},
"expirationTimestamp": {
"description": "The time of the license expiration in UTC ISO format,ex. 2020-12-21T23:59:59.000000Z",
"type": "string"
},
"expired": {
"description": "A value indicating whether the license has already expired",
"type": "boolean"
},
"featureFlags": {
"additionalProperties": {
"properties": {
"uiLabel": {
"description": "String representation of the feature flag",
"type": "string"
},
"uiTooltip": {
"description": "Detailed description of the feature flag",
"type": "string"
},
"value": {
"description": "Value of the feature flag",
"type": "boolean"
}
},
"required": [
"value"
],
"type": "object"
},
"description": "An object containing enforced feature flags. Each key is a name of a feature flag and value is an object described below.",
"type": "object"
},
"genAiSeatLicensesLimit": {
"description": "The number of available GenAI seat licenses (0: unlimited, -1: no seats available).",
"minimum": -1,
"type": "integer",
"x-versionadded": "v2.36"
},
"maxDeploymentLimit": {
"description": "The number of maximum deployments limit (0: unlimited)",
"minimum": 0,
"type": "integer"
},
"maximumActiveUsers": {
"description": "The number of maximum active users allowed in the system(0: unlimited",
"minimum": 0,
"type": "integer"
},
"prepaidDeploymentLimit": {
"description": "The number of prepaid deployments limit (0: unlimited)",
"minimum": 0,
"type": "integer"
}
},
"required": [
"concurrentWorkersCount",
"expirationTimestamp",
"expired",
"featureFlags",
"genAiSeatLicensesLimit",
"maxDeploymentLimit",
"maximumActiveUsers",
"prepaidDeploymentLimit"
],
"type": "object"
},
"uploadInfo": {
"description": "The upload info object will describe detailed information about the user who uploaded the current license",
"properties": {
"uploadTimestamp": {
"description": "the time when the current license was uploaded in UTC ISO format, ex. '2020-12-21T23:59:59.000000Z'",
"type": "string"
},
"uploaderUserId": {
"description": "Id of the user who uploaded the current license",
"type": "string"
},
"uploaderUsername": {
"description": "The username of the user who uploaded the current license",
"type": "string"
}
},
"required": [
"uploadTimestamp",
"uploaderUserId",
"uploaderUsername"
],
"type": "object"
}
},
"required": [
"licenseInfo",
"uploadInfo"
],
"type": "object"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | ClusterLicenseRetrieveResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PUT /api/v2/clusterLicense/¶
Create or replace the cluster license.
Body parameter¶
{
"properties": {
"licenseKey": {
"description": "The license key provided by customer support",
"type": "string"
}
},
"required": [
"licenseKey"
],
"type": "object"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | ClusterLicenseUpdate | false | none |
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | None |
422 | Unprocessable Entity | License is invalid or has expired. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/clusterLicenseValidation/¶
Check if a cluster license is valid.
Body parameter¶
{
"properties": {
"licenseKey": {
"description": "The license key provided by customer support",
"type": "string"
}
},
"required": [
"licenseKey"
],
"type": "object"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | ClusterLicenseUpdate | false | none |
Example responses¶
200 Response
{
"properties": {
"licenseInfo": {
"description": "The license info object will describe detailed information about the deployed license",
"properties": {
"concurrentWorkersCount": {
"description": "The number of allowed simultaneously running jobs(concurrent workers)",
"minimum": 0,
"type": "integer"
},
"expirationTimestamp": {
"description": "The time of the license expiration in UTC ISO format,ex. 2020-12-21T23:59:59.000000Z",
"type": "string"
},
"expired": {
"description": "A value indicating whether the license has already expired",
"type": "boolean"
},
"featureFlags": {
"additionalProperties": {
"properties": {
"uiLabel": {
"description": "String representation of the feature flag",
"type": "string"
},
"uiTooltip": {
"description": "Detailed description of the feature flag",
"type": "string"
},
"value": {
"description": "Value of the feature flag",
"type": "boolean"
}
},
"required": [
"value"
],
"type": "object"
},
"description": "An object containing enforced feature flags. Each key is a name of a feature flag and value is an object described below.",
"type": "object"
},
"genAiSeatLicensesLimit": {
"description": "The number of available GenAI seat licenses (0: unlimited, -1: no seats available).",
"minimum": -1,
"type": "integer",
"x-versionadded": "v2.36"
},
"maxDeploymentLimit": {
"description": "The number of maximum deployments limit (0: unlimited)",
"minimum": 0,
"type": "integer"
},
"maximumActiveUsers": {
"description": "The number of maximum active users allowed in the system(0: unlimited",
"minimum": 0,
"type": "integer"
},
"prepaidDeploymentLimit": {
"description": "The number of prepaid deployments limit (0: unlimited)",
"minimum": 0,
"type": "integer"
}
},
"required": [
"concurrentWorkersCount",
"expirationTimestamp",
"expired",
"featureFlags",
"genAiSeatLicensesLimit",
"maxDeploymentLimit",
"maximumActiveUsers",
"prepaidDeploymentLimit"
],
"type": "object"
}
},
"required": [
"licenseInfo"
],
"type": "object"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | ClusterLicenseValidationResponse |
422 | Unprocessable Entity | License is invalid or has expired. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/version/¶
Provides the version information for the current version of the API.
Example responses¶
200 Response
{
"properties": {
"major": {
"description": "The major version number.",
"type": "integer"
},
"minor": {
"description": "The minor version number.",
"type": "integer"
},
"versionString": {
"description": "The full version string.",
"type": "string"
}
},
"required": [
"major",
"minor",
"versionString"
],
"type": "object"
}
Responses¶
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | none | VersionRetrieveResponse |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas¶
ClusterLicenseRetrieveResponse
{
"properties": {
"licenseInfo": {
"description": "The license info object will describe detailed information about the deployed license",
"properties": {
"concurrentWorkersCount": {
"description": "The number of allowed simultaneously running jobs(concurrent workers)",
"minimum": 0,
"type": "integer"
},
"expirationTimestamp": {
"description": "The time of the license expiration in UTC ISO format,ex. 2020-12-21T23:59:59.000000Z",
"type": "string"
},
"expired": {
"description": "A value indicating whether the license has already expired",
"type": "boolean"
},
"featureFlags": {
"additionalProperties": {
"properties": {
"uiLabel": {
"description": "String representation of the feature flag",
"type": "string"
},
"uiTooltip": {
"description": "Detailed description of the feature flag",
"type": "string"
},
"value": {
"description": "Value of the feature flag",
"type": "boolean"
}
},
"required": [
"value"
],
"type": "object"
},
"description": "An object containing enforced feature flags. Each key is a name of a feature flag and value is an object described below.",
"type": "object"
},
"genAiSeatLicensesLimit": {
"description": "The number of available GenAI seat licenses (0: unlimited, -1: no seats available).",
"minimum": -1,
"type": "integer",
"x-versionadded": "v2.36"
},
"maxDeploymentLimit": {
"description": "The number of maximum deployments limit (0: unlimited)",
"minimum": 0,
"type": "integer"
},
"maximumActiveUsers": {
"description": "The number of maximum active users allowed in the system(0: unlimited",
"minimum": 0,
"type": "integer"
},
"prepaidDeploymentLimit": {
"description": "The number of prepaid deployments limit (0: unlimited)",
"minimum": 0,
"type": "integer"
}
},
"required": [
"concurrentWorkersCount",
"expirationTimestamp",
"expired",
"featureFlags",
"genAiSeatLicensesLimit",
"maxDeploymentLimit",
"maximumActiveUsers",
"prepaidDeploymentLimit"
],
"type": "object"
},
"uploadInfo": {
"description": "The upload info object will describe detailed information about the user who uploaded the current license",
"properties": {
"uploadTimestamp": {
"description": "the time when the current license was uploaded in UTC ISO format, ex. '2020-12-21T23:59:59.000000Z'",
"type": "string"
},
"uploaderUserId": {
"description": "Id of the user who uploaded the current license",
"type": "string"
},
"uploaderUsername": {
"description": "The username of the user who uploaded the current license",
"type": "string"
}
},
"required": [
"uploadTimestamp",
"uploaderUserId",
"uploaderUsername"
],
"type": "object"
}
},
"required": [
"licenseInfo",
"uploadInfo"
],
"type": "object"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
licenseInfo | ClusterLicenseRetrieveResponseLicense | true | The license info object will describe detailed information about the deployed license | |
uploadInfo | ClusterLicenseRetrieveResponseUploadInfo | true | The upload info object will describe detailed information about the user who uploaded the current license |
ClusterLicenseRetrieveResponseLicense
{
"description": "The license info object will describe detailed information about the deployed license",
"properties": {
"concurrentWorkersCount": {
"description": "The number of allowed simultaneously running jobs(concurrent workers)",
"minimum": 0,
"type": "integer"
},
"expirationTimestamp": {
"description": "The time of the license expiration in UTC ISO format,ex. 2020-12-21T23:59:59.000000Z",
"type": "string"
},
"expired": {
"description": "A value indicating whether the license has already expired",
"type": "boolean"
},
"featureFlags": {
"additionalProperties": {
"properties": {
"uiLabel": {
"description": "String representation of the feature flag",
"type": "string"
},
"uiTooltip": {
"description": "Detailed description of the feature flag",
"type": "string"
},
"value": {
"description": "Value of the feature flag",
"type": "boolean"
}
},
"required": [
"value"
],
"type": "object"
},
"description": "An object containing enforced feature flags. Each key is a name of a feature flag and value is an object described below.",
"type": "object"
},
"genAiSeatLicensesLimit": {
"description": "The number of available GenAI seat licenses (0: unlimited, -1: no seats available).",
"minimum": -1,
"type": "integer",
"x-versionadded": "v2.36"
},
"maxDeploymentLimit": {
"description": "The number of maximum deployments limit (0: unlimited)",
"minimum": 0,
"type": "integer"
},
"maximumActiveUsers": {
"description": "The number of maximum active users allowed in the system(0: unlimited",
"minimum": 0,
"type": "integer"
},
"prepaidDeploymentLimit": {
"description": "The number of prepaid deployments limit (0: unlimited)",
"minimum": 0,
"type": "integer"
}
},
"required": [
"concurrentWorkersCount",
"expirationTimestamp",
"expired",
"featureFlags",
"genAiSeatLicensesLimit",
"maxDeploymentLimit",
"maximumActiveUsers",
"prepaidDeploymentLimit"
],
"type": "object"
}
The license info object will describe detailed information about the deployed license
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
concurrentWorkersCount | integer | true | minimum: 0 |
The number of allowed simultaneously running jobs(concurrent workers) |
expirationTimestamp | string | true | The time of the license expiration in UTC ISO format,ex. 2020-12-21T23:59:59.000000Z | |
expired | boolean | true | A value indicating whether the license has already expired | |
featureFlags | object | true | An object containing enforced feature flags. Each key is a name of a feature flag and value is an object described below. | |
» additionalProperties | FeatureFlagObject | false | none | |
genAiSeatLicensesLimit | integer | true | minimum: -1 |
The number of available GenAI seat licenses (0: unlimited, -1: no seats available). |
maxDeploymentLimit | integer | true | minimum: 0 |
The number of maximum deployments limit (0: unlimited) |
maximumActiveUsers | integer | true | minimum: 0 |
The number of maximum active users allowed in the system(0: unlimited |
prepaidDeploymentLimit | integer | true | minimum: 0 |
The number of prepaid deployments limit (0: unlimited) |
ClusterLicenseRetrieveResponseUploadInfo
{
"description": "The upload info object will describe detailed information about the user who uploaded the current license",
"properties": {
"uploadTimestamp": {
"description": "the time when the current license was uploaded in UTC ISO format, ex. '2020-12-21T23:59:59.000000Z'",
"type": "string"
},
"uploaderUserId": {
"description": "Id of the user who uploaded the current license",
"type": "string"
},
"uploaderUsername": {
"description": "The username of the user who uploaded the current license",
"type": "string"
}
},
"required": [
"uploadTimestamp",
"uploaderUserId",
"uploaderUsername"
],
"type": "object"
}
The upload info object will describe detailed information about the user who uploaded the current license
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
uploadTimestamp | string | true | the time when the current license was uploaded in UTC ISO format, ex. '2020-12-21T23:59:59.000000Z' | |
uploaderUserId | string | true | Id of the user who uploaded the current license | |
uploaderUsername | string | true | The username of the user who uploaded the current license |
ClusterLicenseUpdate
{
"properties": {
"licenseKey": {
"description": "The license key provided by customer support",
"type": "string"
}
},
"required": [
"licenseKey"
],
"type": "object"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
licenseKey | string | true | The license key provided by customer support |
ClusterLicenseValidationResponse
{
"properties": {
"licenseInfo": {
"description": "The license info object will describe detailed information about the deployed license",
"properties": {
"concurrentWorkersCount": {
"description": "The number of allowed simultaneously running jobs(concurrent workers)",
"minimum": 0,
"type": "integer"
},
"expirationTimestamp": {
"description": "The time of the license expiration in UTC ISO format,ex. 2020-12-21T23:59:59.000000Z",
"type": "string"
},
"expired": {
"description": "A value indicating whether the license has already expired",
"type": "boolean"
},
"featureFlags": {
"additionalProperties": {
"properties": {
"uiLabel": {
"description": "String representation of the feature flag",
"type": "string"
},
"uiTooltip": {
"description": "Detailed description of the feature flag",
"type": "string"
},
"value": {
"description": "Value of the feature flag",
"type": "boolean"
}
},
"required": [
"value"
],
"type": "object"
},
"description": "An object containing enforced feature flags. Each key is a name of a feature flag and value is an object described below.",
"type": "object"
},
"genAiSeatLicensesLimit": {
"description": "The number of available GenAI seat licenses (0: unlimited, -1: no seats available).",
"minimum": -1,
"type": "integer",
"x-versionadded": "v2.36"
},
"maxDeploymentLimit": {
"description": "The number of maximum deployments limit (0: unlimited)",
"minimum": 0,
"type": "integer"
},
"maximumActiveUsers": {
"description": "The number of maximum active users allowed in the system(0: unlimited",
"minimum": 0,
"type": "integer"
},
"prepaidDeploymentLimit": {
"description": "The number of prepaid deployments limit (0: unlimited)",
"minimum": 0,
"type": "integer"
}
},
"required": [
"concurrentWorkersCount",
"expirationTimestamp",
"expired",
"featureFlags",
"genAiSeatLicensesLimit",
"maxDeploymentLimit",
"maximumActiveUsers",
"prepaidDeploymentLimit"
],
"type": "object"
}
},
"required": [
"licenseInfo"
],
"type": "object"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
licenseInfo | ClusterLicenseRetrieveResponseLicense | true | The license info object will describe detailed information about the deployed license |
FeatureFlagObject
{
"properties": {
"uiLabel": {
"description": "String representation of the feature flag",
"type": "string"
},
"uiTooltip": {
"description": "Detailed description of the feature flag",
"type": "string"
},
"value": {
"description": "Value of the feature flag",
"type": "boolean"
}
},
"required": [
"value"
],
"type": "object"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
uiLabel | string | false | String representation of the feature flag | |
uiTooltip | string | false | Detailed description of the feature flag | |
value | boolean | true | Value of the feature flag |
VersionRetrieveResponse
{
"properties": {
"major": {
"description": "The major version number.",
"type": "integer"
},
"minor": {
"description": "The minor version number.",
"type": "integer"
},
"versionString": {
"description": "The full version string.",
"type": "string"
}
},
"required": [
"major",
"minor",
"versionString"
],
"type": "object"
}
Properties¶
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
major | integer | true | The major version number. | |
minor | integer | true | The minor version number. | |
versionString | string | true | The full version string. |