Get License Key Instance

Retrieve complete administrative details of a specific software license instance.

GET /v1/licenses/{id}/instances/{instanceId}

TypeScript SDK

TypeScript

import { Solifyn } from 'solifyn';

const solifyn = new Solifyn({ apiKey: 'your_private_api_key_here' });

// Retrieve administrative details of an instance
const instance = await solifyn.licenses.getInstanceAdmin('lic_019e56a1...', 'inst_019e56a2...');
console.log('Instance Details:', instance);

200

{
  "id": "7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "licenseId": "lic_hyQQhhNzfEuvv",
  "instanceId": "machine-ID-abc123",
  "instanceName": "MacBook Pro 16\"",
  "ipAddress": "203.0.113.42",
  "activatedAt": "2026-05-15T10:30:00.000Z",
  "lastSeenAt": "2026-05-18T08:00:00.000Z"
}

Authorizations

Authorization · string · header · required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Path Parameters

id · string<uuid> · required

The unique administrative identifier (ID) of the parent license key.

instanceId · string · required

The client-generated instance ID (hardware hash) or the internal database ID of the instance.

Example:

"inc_123"

Response

200 - application/json

Successfully retrieved instance.

Represents an active device or software instance that has been activated against a license key.

id · string · required

The unique database identifier of this instance record.

Example:

"7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c"

licenseId · string · required

The internal ID of the parent license key this instance belongs to.

Example:

"lic_hyQQhhNzfEuvv"

instanceId · string | null · required

The unique hardware hash or client-generated identifier of the activated device/machine.

Example:

"machine-ID-abc123"

instanceName · string | null · required

A human-readable display name for this instance, assigned by the client application.

Example:

"MacBook Pro 16\""

ipAddress · string | null · required

The IP address recorded at the time of activation.

Example:

"203.0.113.42"

activatedAt · string · required

Timestamp when this device instance was first activated.

Example:

"2026-05-15T10:30:00.000Z"

lastSeenAt · string | null · required

Timestamp of the most recent activation heartbeat or re-activation check from this device.

Example:

"2026-05-18T08:00:00.000Z"