Docs/Licenses/API/Activations & Client SDK

Activations & Client SDK API

Public endpoints invoked by client applications, desktop binaries, and server daemons for hardware node-locking, sliding heartbeat leases, and seat reclamation.

Base URL: https://api.vyntech.com.au/v1/public/licenses— These public endpoints do not require management API keys. They authenticate using the customer's license key and machine hardware fingerprint.

Activate Node Lease

Binds a machine to the license key. Checks max_activations limit. Returns an activation token and initial heartbeat expiration lease.

Activate Machine

Payload Example

{
  "license_key": "VYN-STUDIO-PRO-8F2B-9C1A-4X7D-2E9F",
  "machine_id": "hw_mac_a8f102c4b9d038e1",
  "hostname": "workstation-charlie.local",
  "os_name": "macOS Sonoma 14.5",
  "client_version": "3.2.0"
}

Status Codes

Name
200
Type
HTTP
Description
Activation granted or refreshed
Name
404
Type
HTTP
Description
License key not found
Name
409
Type
HTTP
Description
Activation limit reached (max_activations exceeded)
Name
422
Type
HTTP
Description
License is suspended or revoked

Request Parameters

Name
license_key
Type
string
Required
Description
Customer formatted license key.
Name
machine_id
Type
string
Required
Description
Deterministic hardware hash (e.g. SHA-256 of motherboard/CPU UUID).
Name
hostname
Type
string
Description
Machine network hostname for seat identification.

Request

POST/v1/public/licenses/activate

Response 200

Heartbeat Lease Renewal

Client applications periodically send heartbeats (e.g. every 12 hours) to extend their active lease window.

Heartbeat Renewal

Extend sliding heartbeat machine lease.

Payload Example

{
  "activation_token": "act_6f8b1a329d48e02c918347f123a04918e76",
  "machine_id": "hw_mac_a8f102c4b9d038e1"
}

Request

POST/v1/public/licenses/heartbeat

Response

Self-Deactivate Machine Seat

Invoked when unregistering, signing out, or migrating computers to immediately free seat capacity.

Deactivate Machine

Release active seat capacity back to pool.

Payload Example

{
  "activation_token": "act_6f8b1a329d48e02c918347f123a04918e76",
  "machine_id": "hw_mac_a8f102c4b9d038e1",
  "reason": "Hardware replacement"
}

Request

POST/v1/public/licenses/deactivate

Response