LexFloatServer API Endpoints

LexFloatServer provides several API endpoints for retrieving information related to its status, license details, leased floating licenses, meter attributes, and feature entitlements.

These are protected endpoints and require an apiKey to be included as a query parameter in the request URL. The apiKey can be configured in the config.yml file under the auth section of LexFloatServer.

Getting server stats

LexFloatServer exposes a stats API endpoint that can be used to get the current stats of the server.

Gets the server stats

GET http://localhost:8090/api/server/stats

Gets the current server stats

200

{
    "leaseDuration": 60,
    "maxOfflineLeaseDuration": 30,
    "allowedFloatingClients": 10,
    "allowedOfflineFloatingClients": 0,
    "totalFloatingClients": 5,
    "totalOfflineFloatingClients": 0,
    "leasingStrategy": "per-machine",
    "version": "4.13.3",
    "status": "ok",
    "expiresAt": 1751178927,
    "serverSyncGracePeriodExpiresAt": 0
}

Getting server license info

LexFloatServer exposes a license info API endpoint that can be used to get the information related to the license used to activate the LexFloatServer.

Gets the license info

GET http://localhost:8090/api/server/license-info

Gets the license info of the license used to activate the LexFloatServer

200: OK

{
  "key": "280D2B-B48A03-406BBC-2EEE4A-C20FB3-749630",
  "allowedFloatingClients": 10,
  "createdAt": 1680518500,
  "activatedAt": 1680518506,
  "expiresAt": 1681814506,
  "serverSyncGracePeriodExpiresAt": 1680775357,
  "activationMode": {
    "initial": "online",
    "current": "online"
  },
  "user": {
    "name": "John Doe",
    "email": "[email protected]",
    "company": "My Example Company"
  },
  "organization": null
}

Getting the list of floating licenses

LexFloatServer exposes a floating-licenses API endpoint that can be used to get the leased floating licenses.

Gets the list of floating licenses

GET http://localhost:8090/api/floating-licenses

Gets the current server stats

200

[
  {
    "id": "3a13465d984ef1f4b21b2117e0b3f591116f6b027fa8a19f332fbc43651f3d2c",
    "ip": "127.0.0.1",
    "os": "macos",
    "osVersion": "10.14",
    "hostname": "MB-Pro.local",
    "clientVersion": "4.0.0",
    "expiresAt": 1545019266,
    "updatedAt": 1545019236,
    "createdAt": 1545019236,
    "metadata": [
      {
        "key": "name",
        "value": "John Doe"
      }
    ]
  }
]

Getting server license meter attributes

LexFloatServer exposes a license meter attributes API endpoint that can be used to get the list of all the meter attributes of the license used to activate the LexFloatServer.

Gets the list of license meter attributes

GET http://localhost:8090/api/server/license-meter-attributes

Gets the list of meter attributes of the license used to activate the LexFloatServer

200: OK

[
  {
    "id": "string",
    "name": "string",
    "allowedUses": 0,
    "totalUses": 0,
    "grossUses": 0,  
  }
]

Getting server license feature entitlements

LexFloatServer exposes a feature entitlement API endpoint that can be used to get the list of all the feature entitlements associated with the license used to activate the LexFloatServer.

Gets the list of feature entitlements

GET http://localhost:8090/api/server/feature-entitlements

Gets the list of feature entitlements associated with the license used to activate the LexFloatServer.

200: OK

[
  {
    "featureName": "string",
    "featureDisplayName": "string",
    "value": "string",
  }
]