Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

systemfile

August 17, 2023
Contributed by: 
C

Configuration for file resource.

Properties

(click to see Operations)

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

Operations

(click to see Properties)

ADD DELETE GET (ALL)

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

add

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/systemfile

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"systemfile":{
<b>"filename":<String_value>,
</b><b>"filecontent":<String_value>,
</b><b>"filelocation":<String_value>,
</b>"fileencoding":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

delete

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/systemfile/filename_value<String>

HTTP Method:DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/systemfile

Query-parameters:

args

http://<Citrix-ADC-IP-address(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

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "systemfile": [ {
filename:<String_value>,<b>filelocation:<String_value>,</b>"filecontent":<String_value>,
"fileencoding":<String_value>,
"fileaccesstime":<String_value>,
"filemodifiedtime":<String_value>,
"filemode":<String[]_value>,
"filesize":<Double_value>
}]}

<!--NeedCopy-->
systemfile
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.