Activate license

Request Body

application/jsonRequired

licenseKeyRequiredstring

The key of the license to activate.

deviceIdentifierRequiredstring

A unique identifier of the device. Must have at most 96 characters.

deviceNameRequiredstring

The name of the device. Must have at most 64 characters.

productIdRequiredstring | array<string>

The product ID of the license. Can be a single string or an array of strings.

curl -X POST "https://keyforge.dev/api/v1/public/licenses/activate" \
  -H "Content-Type: application/json" \
  -d '{
    "licenseKey": "ABCDE-ABCDE-ABCDE-ABCDE-ABCDE",
    "deviceIdentifier": "some_device_id",
    "deviceName": "My computer name",
    "productId": "p_123456"
  }'

Success. The license is valid and has been activated on the device.

The token will only be present if license tokens are configured for the product.

{
  "isValid": true,
  "token": "...",
  "device": {
    "identifier": "some_device_id",
    "name": "My computer name",
    "activationDate": "2023-05-19T18:39:33.000Z"
  },
  "license": {
    "key": "ABCDE-ABCDE-ABCDE-ABCDE-ABCDE",
    "productId": "p_123456",
    "type": "perpetual",
    "revoked": false,
    "maxDevices": 5,
    "expiresAt": null,
    "createdAt": "2023-05-19T18:39:33.000Z"
  }
}

Request Body

Response

TypeScript