It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Get license Platform - Repository - CRUD »

› › › ›

Add or update license

edit

Add or update license

edit

Adds a new or updates an existing license.

Request

edit

PUT /api/v1/platform/license

Request body

edit

(LicenseObject) (required) The license to add or update.

Responses

edit

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 example

edit

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
   }
}
'

« Get license Platform - Repository - CRUD »