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.
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${returnType} | Yes | string | Standard format option. See Making an API request for details. |
| standard report options | No | various | See Making an API request for details. |
Response
On success, this report will contain one row for each license server that was queried and is visible for the request. Each row consists of columns:
| Column | Full name | Type | Description | Visible by default in export |
|---|---|---|---|---|
| lsid | License Server ID | integer | Internal License Statistics identification of the license server |  No |
| lsn | License Server | string | License server name. |  Yes |
| lsh | Hostname | string | Hostname. | Yes |
| lsp | Port | integer | Port number. | Yes |
| lsd | Description | string | Description of the license server. | Yes |
| lsmn | Lic Manager | string | Manager type of the license server; e.g., LM-X, FlexNet, etc. | Yes |
| vn | Vendor | string | Name of the license server vendor. | Yes |
| lss | Status | enumeration | Current status of the license server. | Yes |
| gtn | Gathering | enumeration | See gathering type descriptions for details. | Yes |
| lshal | Redundant | boolean | True if server was configured with redundancy (HAL). |  Unavailable |
| lshf | Has Features | boolean | Indicates whether License Statistics detected any features hosted on the server. True for servers that were successfully queried or imported. | Unavailable |
Note that the order in the table is the default order of the columns in the exported file.
Examples
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"