Sign in
Server

Get product key

Changed on

Retrieve information about whether the server currently has a product key registered.

get/server/license

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/server/license
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Response

activatedAtstring date-time required

Activation date

activationKeystring required

Activation key

licenseKeystring required

License key (format: /^IM(SV|CL)(-[\dA-Za-z]{4}){8}$/)

Example response

{
  "activatedAt": "2024-01-01T00:00:00.000Z"
}

Changes