Set license key

Set or sync license key

PUT/appid-{appId}/ee/license

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Header parameters

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Request body

application/json

licenseKeystring

Responses

200The operation was successful

One of:

object

statusstatusOK

Allowed:OK

object

statusstring

Allowed:MISSING_EE_FOLDER_ERROR

object

statusstring

Allowed:INVALID_LICENSE_KEY_ERROR

400error code 400

string

401error code 401

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

cdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

licenseKeystring

Request

curl -X PUT "/appid-{appId}/ee/license" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "licenseKey": "eyJhbGciOiJIUzI1NiIsIn..."
}'

const response = await fetch("/appid-{appId}/ee/license", {
  method: "PUT",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "licenseKey": "eyJhbGciOiJIUzI1NiIsIn..."
})
});

import requests

response = requests.put(
    "/appid-{appId}/ee/license",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "licenseKey": "eyJhbGciOiJIUzI1NiIsIn..."
},
)

Response

{
  "status": "OK"
}

"string"

"Invalid API key"

"Internal Error"