Platform - License

Delete license

Deletes the license.

Request

DELETE /api/v1/platform/license

Responses

200
(EmptyResponse) The license was deleted.
400
(BasicFailedReply) The license could not be deleted. (code: 'license.license_deletion_failed')
404
(BasicFailedReply) The license cannot be found. (code: 'license.license_not_found')
449
(BasicFailedReply) Elevated permissions are required. (code: 'root.needs_elevated_permissions')
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XDELETE {{hostname}}/api/v1/platform/license \
-u $CLOUD_USER:$CLOUD_KEY

Get license

Retrieves the license.

Request

GET /api/v1/platform/license

Responses

200
(LicenseObject) The information for the license.
404
(BasicFailedReply) The license cannot be found. (code: 'license.license_not_found')
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/license \
-u $CLOUD_USER:$CLOUD_KEY

Add or update license

Adds a new or updates an existing license.

Request

PUT /api/v1/platform/license

Request body

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

Responses

201
(EmptyResponse) The license was updated.
400
(BasicFailedReply) The license could not be updated. (code: 'license.invalid_license')
449
(BasicFailedReply) Elevated permissions are required. (code: 'root.needs_elevated_permissions')
Warning

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPUT {{hostname}}/api/v1/platform/license \
-u $CLOUD_USER:$CLOUD_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,
      "operation_mode" : "string",
      "signature" : "string",
      "start_date_in_millis" : 0,
      "subscription_type" : "string",
      "type" : "string",
      "uid" : "string",
      "version" : 0
   }
}
'