nsaptlicense

Last published : Oct 30, 2026
Configuration for aptlicense resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
serialno <String> Read-write Hardware Serial Number/License Activation Code(LAC).
useproxy <String> Read-write Specifies whether to use the licenseproxyserver to reach the internet. Make sure to configure licenseproxyserver to use this option.
Default value: NO
Possible values = YES, NO
id <String> Read-write License ID.
sessionid <String> Read-write Session ID.
bindtype <String> Read-write Bind type.
countavailable <String> Read-write The user can allocate one or more licenses. Ensure the value is less than (for partial allocation) or equal to the total number of available licenses.
licensedir <String> Read-write License Directory.
response <String> Read-only Response data as text blob.
counttotal <String> Read-only Count.
name <String> Read-only License name.
relevance <String> Read-only License relevance.
datepurchased <String> Read-only License purchase date.
datesa <String> Read-only License SA date.
dateexp <String> Read-only License expiry date.
features <String[]> Read-only Features.
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • GET (ALL)
  • COUNT
  • CHANGE
Some options that you can use for each operations:
  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
    To do this, you must specify the username and password in the request header of the NITRO request as follows:
    X-NITRO-USER: <username>
    X-NITRO-PASS: <password>
    Note: In such cases, make sure that the request header DOES not include the following:
    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note: * Mandatory parameters are marked in red and placeholder content is marked in green

change

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsaptlicense? action=update HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"nsaptlicense":{
<b>"id":<String_value>,
</b><b>"sessionid":<String_value>,
</b><b>"bindtype":<String_value>,
</b><b>"countavailable":<String_value>,
</b>"licensedir":<String_value>,
"useproxy":<String_value>
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsaptlicense Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/nsaptlicense? args= serialno:<String_value>, useproxy: <String_value>
Use this query-parameter to get nsaptlicense resources based on additional properties.
HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "nsaptlicense": [ {
<b>serialno:<String_value>,</b>useproxy:<String_value>"response":<String_value>,
"id":<String_value>,
"sessionid":<String_value>,
"bindtype":<String_value>,
"countavailable":<String_value>,
"counttotal":<String_value>,
"name":<String_value>,
"relevance":<String_value>,
"datepurchased":<String_value>,
"datesa":<String_value>,
"dateexp":<String_value>,
"features":<String[]_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsaptlicense? args= serialno:<String_value>, useproxy: <String_value> ;count=yes HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "nsaptlicense": [ { "__count": "#no"} ] }