Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Next »

Obtaining a license server list

You can easily list license servers registered in License Statistics by sending the following HTTP request.

GET /api/v1/license-server/${returnType}

where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are described below.

${returnType}YesstringSpecifies the format in which data should be returned. The format can be one of the following: JSON, CSV, XLSX, or PDF.
fieldsVisibility Nojson/string
Specifies field visibility settings, for example:
{ "lsid": "1", "lsn": "1", "lsh": "1", "lsp": "1", "lsd": "1", "vn": "1", "gtn": "1"}

where number "1" indicates that a specific field is visible.
Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here.

rnNostringSpecifies the name of the report that will be displayed once the report has been exported to PDF or XLSX. For CSV and JSON formats this parameter will be ignored.
If you don't pass this parameter, it will be generated automatically for PDF and XLSX types. If provided, it cannot be left empty.

Applies filtering to narrow down the results.

To filter by a string column, use the following format: 

        "type": "string",
        "field": "${lsn | lsh | lsd | vn | gtn}",
        "value": "${value}"

To filter by a numeric column, use the following format: 

        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${lsid | lsp}",
        "value": "${value}"
limitNointegerSpecifies the number of records that must be returned. The value must be greater than zero.
offsetNointegerSpecifies the offset of the first row to return.

Specifies the field by which you want to order your data records. The field name can be one of the following:

lsid, lsn, lsh, lsp, lsd, vn, gtn
orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.


The following code block shows an example result of a successful request.

	"success": ${success}, 
	"msg": ${message}, 
	"data": [{
  		"lsid": ${licenseServerId}, 
  		"lsn": ${licenseServerName},
  		"lsh": ${licenseServerHostname},
  		"lsp": ${licenseServerPort},
  		"lsd": ${licenseServerDescription},
  		"vn": ${licenseServerVendorName},
  		"gtn": ${licenseServerGatheringType}
	"code": ${errorCode},
	"totalCount": ${totalCount}

where the response fields can be explained as follows:

lsidintegerLicense server ID.
lsnstringLicense server name.
lshstringLicense server host name.
lspintegerLicense server port.
lsdintegerLicense server description.
vnstringLicense server vendor name.
gtnstringGathering type (imported, realtime).
successbooleanIndicates whether your API request was successfully processed.

Error message returned on failure.


Error code for unsuccessful request.


Total number of all matching results.


The following examples make use of the GET method. 

Example 1

Say you want to obtain a list of all license servers. To generate this data set, enter a command similar to the following.

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/json"

Example 2

 If you want to generate license server information filtered by hostname in CSV format, enter the following command. 

curl --data "filter=[{\"type\"=\"string\", \"field\"=\"lsh\", \"value\"=\"some hostname\"}]" 
-H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/csv"

Example 3

In order to get information about a license server with an ID of 1, enter the following command.

curl --data-urlencode "filter=[{\"type\"=\"numeric\", \"field\"=\"lsid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/json"
  • No labels