License heartbeat

License Heartbeat

curl --request POST \
  --url https://app.lukittu.com/api/v1/client/teams/{teamId}/verification/heartbeat \
  --header 'Content-Type: application/json' \
  --data '
{
  "licenseKey": "<string>",
  "hardwareIdentifier": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "challenge": "<string>",
  "version": "<string>",
  "branch": "<string>"
}
'

{
  "data": {
    "license": {
      "ipLimit": 5,
      "hwidLimit": 3,
      "expirationType": "NEVER"
    }
  },
  "result": {
    "timestamp": "2023-09-15T14:30:00Z",
    "valid": true,
    "details": "Heartbeat successful",
    "code": "VALID"
  }
}

POST

api

client

teams

{teamId}

verification

heartbeat

License Heartbeat

curl --request POST \
  --url https://app.lukittu.com/api/v1/client/teams/{teamId}/verification/heartbeat \
  --header 'Content-Type: application/json' \
  --data '
{
  "licenseKey": "<string>",
  "hardwareIdentifier": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "challenge": "<string>",
  "version": "<string>",
  "branch": "<string>"
}
'

{
  "data": {
    "license": {
      "ipLimit": 5,
      "hwidLimit": 3,
      "expirationType": "NEVER"
    }
  },
  "result": {
    "timestamp": "2023-09-15T14:30:00Z",
    "valid": true,
    "details": "Heartbeat successful",
    "code": "VALID"
  }
}

Path Parameters

teamId

string<uuid>

required

Your team's UUID. You can find this value in your team's settings on the Lukittu dashboard. UUID v4 identifier

Body

application/json

licenseKey

string

required

Lukittu license key format: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX where X is an uppercase letter (A-Z) or digit (0-9)

hardwareIdentifier

string

required

Unique hardware identifier for client device (no spaces allowed)

Required string length: 10 - 1000

customerId

string<uuid>

UUID v4 identifier

productId

string<uuid>

UUID v4 identifier

challenge

string

Client-generated random string for request signing (no spaces allowed)

Maximum string length: 1000

version

string

Software version identifier (no spaces allowed)

Required string length: 3 - 255

branch

string

Product branch name

Required string length: 2 - 255

Response

Successful heartbeat response

data

object

required

Response data

Show child attributes

data.license

object

License details (included based on ReturnedFields configuration)

Show child attributes

data.license.ipLimit

integer | null

Maximum IP addresses allowed

data.license.hwidLimit

integer | null

Maximum hardware IDs allowed

data.license.expirationType

enum<string>

Defines how license expiration is calculated

Available options:

NEVER,

DATE,

DURATION

data.license.expirationStart

enum<string>

Defines when the license expiration countdown begins

Available options:

CREATION,

ACTIVATION

data.license.expirationDate

string<date-time> | null

data.license.expirationDays

integer | null

data.license.metadata

object[]

License metadata (filtered by ReturnedFields)

Show child attributes

data.license.metadata.key

string

required

data.license.metadata.value

string

required

data.customers

object[]

Customer details (included based on ReturnedFields configuration)

Show child attributes

data.customers.email

string<email>

Customer email address

data.customers.fullName

string

Customer full name

data.customers.username

string

Customer username

data.customers.metadata

object[]

Customer metadata (filtered by ReturnedFields configuration)

Show child attributes

data.customers.metadata.key

string

required

data.customers.metadata.value

string

required

data.products

object[]

Product details (included based on ReturnedFields configuration)

Show child attributes

data.products.name

string

Product name

data.products.url

string

Product URL

data.products.latestRelease

object

Information about the latest release for this product

Show child attributes

data.products.latestRelease.version

string

required

Latest release version

data.products.latestRelease.createdAt

string<date-time>

required

When the release was created

data.products.metadata

object[]

Product metadata (filtered by ReturnedFields configuration)

Show child attributes

data.products.metadata.key

string

required

data.products.metadata.value

string

required

result

object

required

Show child attributes

result.timestamp

string<date-time>

required

Timestamp when the response was generated Timestamp when the response was generated

result.valid

enum<boolean>

required

Indicates whether the operation was successful Always true for success responses Indicates whether the operation was successful

Available options:

true,

false

result.details

string

required

Human-readable description of the result Human-readable description of the result

result.code

enum<string>

required

Available options:

VALID

result.challengeResponse

string

Signed challenge response (present if challenge was provided)

⌘I

API Documentation

Client - Verify

Dev - Licenses

Dev - Customers

Path Parameters

Body

Response