Download full document:

systemfile

Configuration for file resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
filename	<String>	Read-write	Name of the file. It should not include filepath.<br>Maximum length = 63
filecontent	<String>	Read-write	file content in Base64 format.
filelocation	<String>	Read-write	location of the file on NetScaler.<br>Maximum length = 127
fileencoding	<String>	Read-write	encoding type of the file content.<br>Default value: "BASE64"
fileaccesstime	<String>	Read-only	Last access time of the file.
filemodifiedtime	<String>	Read-only	last modified time of the file.
filemode	<String[]>	Read-only	file mode.<br>Possible values = DIRECTORY
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties)

ADD | DELETE | GET (ALL) | GET

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

add

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "override":<String_value>
},
"sessionid":"##sessionid",
"systemfile":{
      "filename":<String_value>,
      "filecontent":<String_value>,
      "filelocation":<String_value>,
      "fileencoding":<String_value>,
}}

Response Payload:

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

delete

URL: http://<NSIP>/nitro/v1/config/systemfile/filename_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/systemfile/filename_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

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

get (all)

URL: http://<NSIP>/nitro/v1/config/systemfile

Query-parameters:

args

http://<NSIP>/nitro/v1/config/systemfile?args= "filename":<String_value>, "filelocation":<String_value>,

Use this query-parameter to get systemfile resources based on additional properties.

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "systemfile": [ {
      "filename":<String_value>,
      "filelocation":<String_value>,
      "filecontent":<String_value>,
      "fileencoding":<String_value>,
      "fileaccesstime":<String_value>,
      "filemodifiedtime":<String_value>,
      "filemode":<String[]_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/systemfile/filename_value<String>

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "systemfile": [ {
      "filename":<String_value>,
      "filelocation":<String_value>,
      "filecontent":<String_value>,
      "fileencoding":<String_value>,
      "fileaccesstime":<String_value>,
      "filemodifiedtime":<String_value>,
      "filemode":<String[]_value>

}]}