REST API

Note

Beginning with License Server version 3.2.3, a selection of REST API queries has been deprecated. Some of these queries referred to internal model objects that caused confusion.

These deprecated queries include:

  • /api/groups/*
  • /api/rebels/*
  • /api/tokens/status
  • /api/leases/*
  • /api/statistics/*

REST API enables to get raw data for off-site analysis and storage. It is reachable via /api.


REST API authentication

Grab the API key from your profile page: License Server > Configuration > My Profile > API Key.

../_images/api-key.png

You need to append your API Key as a GET parameter to the URL of each REST API request:

GET /api/status/seats?token=<my authentication token>

Status queries

Query seat usage information

A query that will provide you with information about how many seats are available in the system and how many are in use, per license type and product.

Request:

GET /api/status/seats

Response:

{
   "seats.jrebel-standalone.total":1103,
   "seats.jrebel-standalone.used":101,
   "seats.jrebel-standalone.free":1002,
   "seats.jrebel-standalone.managed.total":999,
   "seats.jrebel-standalone.managed.used":101,
   "seats.jrebel-standalone.managed.free":898,
   "seats.jrebel-standalone.floating.total":104,
   "seats.jrebel-standalone.floating.used":0,
   "seats.jrebel-standalone.floating.free":104,
   "seats.xrebel-standalone.total":111,
   "seats.xrebel-standalone.used":6,
   "seats.xrebel-standalone.free":105
}