license_file

Configuration for License File resource.

Read/write properties

file_location_path<String>

File Location on Client for upload/download.
Minimum length = 1

file_name<String>

File Name.
Minimum length = 1
Maximum length = 256

Read only properties

file_size<Integer>

file_size.

file_last_modified_epoch<Double>

Last Modified (Epoch).

file_last_modified<String>

Last Modified.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror   <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

delete

URL:https://<MGMT-IP>/nitro/v2/config/license_file/file_name_value<String>

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/license_file

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/license_file?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of license_file resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/license_file?pagesize=#no&pageno=#no

Use this query-parameter to get the license_file resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/license_file?count=yes

Use this query-parameter to get the count of license_file resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "license_file":[{
      "file_size":<Integer_value>,
      "file_last_modified_epoch":<Double_value>,
      "file_last_modified":<String_value>,
      "file_location_path":<String_value>,
      "file_name":<String_value>}]}

get

URL:https://<MGMT-IP>/nitro/v2/config/license_file/file_name_value<String>

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "license_file":[{
      "file_size":<Integer_value>,
      "file_last_modified_epoch":<Double_value>,
      "file_last_modified":<String_value>,
      "file_location_path":<String_value>,
      "file_name":<String_value>}]}

download

URL:https://<MGMT-IP>/nitro/v2/download/license_file/file_name_value<String>

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Headers:

Content-Type:application/json

Response Payload:Binary Stream

upload

URL:https://<MGMT-IP>/nitro/v2/upload/license_file

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:Multi-part form data with File Stream

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done }