Skip to content

REST API

The license server has a public REST API to make it possible to fetch the licenses installed and the current usage. This can be then be used in other tools like Grafana to visualize usage.

It's a versioned API, currently at v1.

Port setting

By default the API port will be set to 5083. But this can be changed to any value using the configuration menu by calling vinkvfxls -c.

Entry points

There are three entry points (using the GET method):

  1. /v1/clients
  2. /v1/licenses
  3. /v1/healthcheck

Clients

The clients data consists of a JSON representation of the current clients connected to the server. Example data looks like this: 

{
  "clients": [
    {
      "ip": "192.168.1.20",
      "first_heartbeat": "2024-09-12T15:32:36.455291014Z",
      "last_heartbeat": "2024-09-12T15:32:41.482754569Z",
      "gui": true,
      "hostname": "MachineHostname.local"
    }
  ]
}

It has an array of clients. Then each client has:

  • ip: ip address of client
  • first_heartbeat: moment of first connection
  • last_heartbeat: last time the client requested a license
  • gui: true if the client is using a GUI license, false if not.
  • hostname: hostname of the client machine.

Licenses

The licenses data consists of a JSON representation of the current installed and valid licenses on the server. Example data looks like this: 

{
  "licenses": [
    {
      "count": 20,
      "valid_until": "2025-09-11T20:18:21.028Z",
      "license_key": "6EE777-BD4425-A37555-97A4EE-4060D9-V3",
      "gui": true,
      "additional_data": null
    }
  ]
}

Mainly it has a licenses key with an array of licenses. Each license has these keys:

  • count: max numbers of clients this license can serve
  • valid_until: date until this license is valid
  • license_key: key that has been purchases
  • gui: if the license is able to be used in gui or is render only

Healthcheck

This will always respond OK. This makes it possible to add it to your own monitoring software to be alerted on its uptime.