License

Register a license

Set up a license for EmailEngine to unlock all features

post/v1/license

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/license
  • Auth: HTTP bearer

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Request body

licensestring required

License file

Example request

{
  "license": "-----BEGIN LICENSE-----\r\n..."
}

Response

Returns the registered license.

activeboolean

Whether a valid license is currently active

typestring

License type/product name

suspendedboolean

Whether email operations are suspended due to license issues

Example response

{
  "active": true,
  "type": "EmailEngine License",
  "details": {
    "application": "@postalsys/emailengine-app",
    "key": "1edf01e35e75ed3425808eba",
    "licensedTo": "Kreata OÜ",
    "hostname": "emailengine.example.com",
    "created": "2021-10-13T07:47:42.695Z",
    "expires": "2026-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.