License¶

Data Structures¶

`LicenseModel`¶
Attribute	Type	Required	Description
`serial`	string		Read-only. License serial number.
`fuid`	string		Read-only. License fuid identifier.
`expiration_date`	string	yes	Read-only. Specifies the license validity period. Format: `YYYY-MM-DD` / `unlimited`. Deprecated, use `psm_expiration_date` instead.
`expired`	boolean	yes	Read-only. License has expired? Deprecated, use `psm_expired` instead.
`psm_expiration_date`	string	yes	Read-only. Specifies the license validity period for the PSM module. Format: `YYYY-MM-DD` / `unlimited`.
`psm_expired`	boolean	yes	Read-only. License has expired for the PSM Module?
`vault_expiration_date`	string		Read-only. Specifies the license validity period for the Vault module. Format: `YYYY-MM-DD` / `unlimited`.
`vault_expired`	boolean		Read-only. License has expired for the Vault Module?
`owner`	string	yes	Read-only. Specifies the name of the entity to which the license is issued.
`type`	string {commercial, test}	yes	Read-only. Specifies the type of license. The value can be set to `test` for test purposes or to `commercial` for commercial use.
`tier`	string {basic, full}	yes	Read-only. License tier.
`nodes`	string		Read-only. Limit how many nodes can be configured. Format: a positive integer or `unlimited`.
`servers`	string		Read-only. Limit how many servers can be configured. Format: a positive integer or `unlimited`.
`activeusers`	string		Read-only. The limit of active users. Format: a positive integer or `unlimited`. Deprecated, use `psm_activeusers` instead.
`psm_activeusers`	string		Read-only. The limit of active users is defined in the license for the PSM module. Number of users or `unlimited` for an infinite user limit.
`vault_activeusers`	string		Read-only. The limit of active users is defined in the license for the Vault module. Number of users or `unlimited` for an infinite user limit.
`changers`	string		Read-only. The number of accounts and secrets that can have an assigned password changer. Format: a positive integer or `unlimited`.
`sessions`	string		Read-only. Limit how many concurrent sessions can be established. Format: a positive integer or `unlimited`.
`procmaxocr`	string		Read-only. Limit how many OCR tasks can be processed concurrently. Format: a positive integer or `unlimited`.
`servers_inuse`	number	yes	Read-only. Number of servers currently used.
`activeusers_inuse`	number	yes	Read-only. Number of active users currently used. Deprecated, use `psm_activeusers_inuse` instead.
`psm_activeusers_inuse`	number	yes	Read-only. Current number of active users in the PSM module.
`vault_activeusers_inuse`	number	yes	Read-only. Current number of active users in the Vault module.
`changers_inuse`	number	yes	Read-only. Number of accounts and secrets with password changers currently used.

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	License file.

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": "84088956",
        "expiration_date": "2026-07-08",
        "expired": false,
        "psm_expiration_date": "2026-07-08",
        "psm_expired": false,
        "vault_expiration_date": "2026-09-08",
        "vault_expired": false,
        "owner": "Fudo Security",
        "type": "commercial",
        "tier": "full",
        "nodes": "3",
        "servers": "100",
        "activeusers": "50",
        "psm_activeusers": "50",
        "vault_activeusers": "99",
        "changers": "9",
        "servers_inuse": 2,
        "activeusers_inuse": 1,
        "psm_activeusers_inuse": 1,
        "vault_activeusers_inuse": 3,
        "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"
}