License Information

This chapter focuses on information from the license file.

Get information from the Premium license file

A GET to /license/info returns information from the Premium license file.

HTTP request

GET /api/rest/latest/license/info HTTP/1.1
Accept: application/json
Host: localhost:8080

Request parameters

Parameter Description

fields

which fields of the elements should be returned (optional)

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 465

{
  "_type" : "license-info",
  "max_users" : 15,
  "expiration_date" : "2022-10-12T08:00:00.000+00:00",
  "license_plugins" : [ {
    "_type" : "license-plugin",
    "key" : "api-rest-admin",
    "available" : true
  }, {
    "_type" : "license-plugin",
    "key" : "automation-result-publisher",
    "available" : false
  } ],
  "valid_license" : false,
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/license/info"
    }
  }
}

Response fields

Path Type Description

_type

String

the type of the entity

max_users

Number

max users number allowed by the license

expiration_date

String

expiration date of the license

license_plugins

Array

all the license plugins

license_plugins[]._type

String

the type of the license plugins

license_plugins[].key

String

key of the license plugin

license_plugins[].available

Boolean

availability of the plugin by the license

valid_license

Boolean

indicates if the license is valid : expiration date + a tolerance period

_links

Object

related links

Links

Relation Description

self

link to the license information