API v2: License¶

Data Structures¶

`LicenseModel`¶
Attribute	Type	Required	Description
`serial`	string		License serial number. Read-only.
`fuid`	string		License fuid identifier. Read-only.
`expiration_date`	string	yes	Specifies the license validity period. Format: `YYYY-MM-DD` / `unlimited`. Read-only.
`expired`	boolean	yes	Indicates whether the license has expired. Read-only.
`owner`	string	yes	Specifies the name of the entity to which the license is issued. Read-only.
`type`	string	yes	Defines the license type: `test` for evaluation or `commercial` for official use. Read-only.
`nodes`	string		Limits the number of nodes that can be configured. Format: a positive integer or `unlimited`. Read-only.
`servers`	string		Limits the number of servers that can be configured. Format: a positive integer or `unlimited`. Read-only.
`activeusers`	string		The limit of active users. Format: a positive integer or `unlimited`. Read-only.
`changers`	string		The number of accounts that can have an assigned password changer. Format: a positive integer or `unlimited`. Read-only.
`sessions`	string		Limit how many concurrent sessions can be established. Format: a positive integer or `unlimited`. Read-only.
`procmaxocr`	string		Limit how many OCR tasks can be processed concurrently. Format: a positive integer or `unlimited`. Read-only.
`servers_inuse`	number	yes	Indicates how many servers are currently used. Read-only.
`activeusers_inuse`	number	yes	Number of active users currently in use. Read-only.
`changers_inuse`	number	yes	Number of accounts with password changers currently in use. Read-only.

Retrieve Available Attributes of the LicenseModel¶

Request

Method	`GET`
Path	`/api/v2/objspec/license`

GET /api/v2/objspec/license

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/objspec/license'

Data Structures¶

`LicenseUploadModel`¶
Attribute	Type	Required	Description
`license`	string	yes	The full contents of the license file, provided as a plain-text string.

Retrieve Available Attributes of the LicenseUploadModel¶

Request

Method	`GET`
Path	`/api/v2/objspec/license_upload`

GET /api/v2/objspec/license_upload

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/objspec/license_upload'

Get License Information¶

Request

Method	`GET`
Path	`/api/v2/license`

GET /api/v2/license

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/license'

Response

{
    "license": {
        "serial": "33333333",
        "expiration_date": "2027-12-31",
        "expired": false,
        "owner": "FudoSecurity",
        "type": "commercial",
        "nodes": "8",
        "servers": "5000",
        "changers": "1000",
        "procmaxocr": "15",
        "servers_inuse": 1468,
        "activeusers_inuse": 768,
        "changers_inuse": 0
    },
    "result": "success"
}

Upload the License¶

Request

Method	`POST`
Path	`/api/v2/license`
Headers	`Content-Type: Application/json`
Body	`LicenseUploadModel`

POST /api/v2/license

Example Request

curl -s -k -X POST \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  -H 'Content-Type: application/json' \
  'https://10.0.214.98/api/v2/license' \
  -d '{
    "license": "serial=33333333
servers=5000
changers=400
expire=20271231
mode=host
procmaxocr=15
license type: commercial
type=test
owner=FudoSecurity
nodes=8
languages=en,pl
key=NTXXXXXXXXXXXXXXXXXXXXXXXXXXXX...<truncated>
signature=dTJOftdo2i4ykvXUYTDnijSy...<truncated>"
}'

Response

{
    "result": "success"
}

Delete Uploaded License File 🆕¶

Request

Method	`DELETE`
Path	`/api/v2/license`

DELETE /api/v2/license

Example Request

curl -s -k -X DELETE \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.31.135.179/api/v2/license'

Response

{
    "result": "success"
}