A newer version is available. For the latest information, see the
current release documentation.
Add or update licenseedit
Adds a new or updates an existing license.
Requestedit
PUT /api/v1/platform/license
Request bodyedit
(LicenseObject) (required) The license to add or update.
Responsesedit
-
200 -
(
EmptyResponse) The license was updated. -
400 -
(
BasicFailedReply) The license could not be updated. (code:license.invalid_license)Headers
-
x-cloud-error-codes(string; allowed values: [license.invalid_license]) - The error codes associated with the response
-
-
449 -
(
BasicFailedReply) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPUT https://{{hostname}}/api/v1/platform/license \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"license" : {
"cluster_licenses" : [
{
"license" : {}
}
],
"expiry_date_in_millis" : 0,
"issue_date_in_millis" : 0,
"issued_to" : "string",
"issuer" : "string",
"max_allocators" : 0,
"max_instances" : 0,
"max_ram_per_allocator_mb" : 0,
"max_resource_units" : 0,
"operation_mode" : "string",
"signature" : "string",
"start_date_in_millis" : 0,
"subscription_type" : "string",
"type" : "string",
"uid" : "string",
"version" : 0
},
"usage_stats" : {
"total_connected_memory_total" : 0
}
}
'