Update file system audit policy

NAS File Storage REST API Reference

Version

15.6.x

File Size

1291 KB

Audience

anonymous

Part Number

MK-92HNAS100-07

ft:lastEdition

2026-04-07

patch /v9/storage/filesystems/{filesystemId}/audit-policy

Update file system audit policy.

Note: Accepted parameter values may be restricted based on the virtual server access granted by the API key used for authentication.

Authentication: x_subsystem_user Api Key "X-Subsystem-User"

Authentication: x_subsystem_password Api Key "X-Subsystem-Password"

Authentication: api_key Api Key "X-Api-Key"

Authentication: basicAuth HTTP - basic scheme

Path parameters

filesystemId String required

Either the file system ID or the object ID of the file system

Example: 7B263DFD1D71E65A0000000000000000

CLIENT REQUEST

          curl -X 'PATCH'

         -H "X-Subsystem-User: [[apiKey]]"
        
         \
      
         -H "X-Subsystem-Password: [[apiKey]]"
        
         \
      
         -H "X-Api-Key: [[apiKey]]"
        
         \
      
         -H "Authorization: Basic [[basicHash]]"
         \
      
        -H
        'Accept: application/json'
      
        -H
        'Content-Type: application/json'
      
      'https://172.27.146.40:8444/v9/storage/filesystems/{filesystemId}/audit-policy'
    
      -d
      ''

import http.client

conn = http.client.HTTPSConnection("172.27.146.40:8444")

payload = "{\"auditNfsv3\":true,\"auditNfsv4\":true,\"backupInterval\":0,\"backupLimit\":10,\"external\":true,\"isEnabled\":true,\"logFileName\":\"/.audit/events.evt\",\"logFileSize\":524288,\"rotatePolicy\":\"OVERWRITE\",\"unsafePolicy\":\"DENY\"}"

headers = {
    'Authorization': "Basic REPLACE_BASIC_AUTH",
    'content-type': "application/json"
    }

conn.request("PATCH", "/v9/storage/filesystems/7B263DFD1D71E65A0000000000000000/audit-policy", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://172.27.146.40:8444/v9/storage/filesystems/7B263DFD1D71E65A0000000000000000/audit-policy")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic REPLACE_BASIC_AUTH'
request["content-type"] = 'application/json'
request.body = "{\"auditNfsv3\":true,\"auditNfsv4\":true,\"backupInterval\":0,\"backupLimit\":10,\"external\":true,\"isEnabled\":true,\"logFileName\":\"/.audit/events.evt\",\"logFileSize\":524288,\"rotatePolicy\":\"OVERWRITE\",\"unsafePolicy\":\"DENY\"}"

response = http.request(request)
puts response.read_body

const data = JSON.stringify({
  "auditNfsv3": true,
  "auditNfsv4": true,
  "backupInterval": 0,
  "backupLimit": 10,
  "external": true,
  "isEnabled": true,
  "logFileName": "/.audit/events.evt",
  "logFileSize": 524288,
  "rotatePolicy": "OVERWRITE",
  "unsafePolicy": "DENY"
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://172.27.146.40:8444/v9/storage/filesystems/7B263DFD1D71E65A0000000000000000/audit-policy");
xhr.setRequestHeader("Authorization", "Basic REPLACE_BASIC_AUTH");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

HttpResponse<String> response = Unirest.patch("https://172.27.146.40:8444/v9/storage/filesystems/7B263DFD1D71E65A0000000000000000/audit-policy")
  .header("Authorization", "Basic REPLACE_BASIC_AUTH")
  .header("content-type", "application/json")
  .body("{\"auditNfsv3\":true,\"auditNfsv4\":true,\"backupInterval\":0,\"backupLimit\":10,\"external\":true,\"isEnabled\":true,\"logFileName\":\"/.audit/events.evt\",\"logFileSize\":524288,\"rotatePolicy\":\"OVERWRITE\",\"unsafePolicy\":\"DENY\"}")
  .asString();

import Foundation

let headers = [
  "Authorization": "Basic REPLACE_BASIC_AUTH",
  "content-type": "application/json"
]
let parameters = [
  "auditNfsv3": true,
  "auditNfsv4": true,
  "backupInterval": 0,
  "backupLimit": 10,
  "external": true,
  "isEnabled": true,
  "logFileName": "/.audit/events.evt",
  "logFileSize": 524288,
  "rotatePolicy": "OVERWRITE",
  "unsafePolicy": "DENY"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://172.27.146.40:8444/v9/storage/filesystems/7B263DFD1D71E65A0000000000000000/audit-policy")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8444",
  CURLOPT_URL => "https://172.27.146.40:8444/v9/storage/filesystems/7B263DFD1D71E65A0000000000000000/audit-policy",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "{\"auditNfsv3\":true,\"auditNfsv4\":true,\"backupInterval\":0,\"backupLimit\":10,\"external\":true,\"isEnabled\":true,\"logFileName\":\"/.audit/events.evt\",\"logFileSize\":524288,\"rotatePolicy\":\"OVERWRITE\",\"unsafePolicy\":\"DENY\"}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic REPLACE_BASIC_AUTH",
    "content-type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "https://172.27.146.40:8444/v9/storage/filesystems/7B263DFD1D71E65A0000000000000000/audit-policy");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Basic REPLACE_BASIC_AUTH");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"auditNfsv3\":true,\"auditNfsv4\":true,\"backupInterval\":0,\"backupLimit\":10,\"external\":true,\"isEnabled\":true,\"logFileName\":\"/.audit/events.evt\",\"logFileSize\":524288,\"rotatePolicy\":\"OVERWRITE\",\"unsafePolicy\":\"DENY\"}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://172.27.146.40:8444/v9/storage/filesystems/7B263DFD1D71E65A0000000000000000/audit-policy");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Basic REPLACE_BASIC_AUTH");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"auditNfsv3\":true,\"auditNfsv4\":true,\"backupInterval\":0,\"backupLimit\":10,\"external\":true,\"isEnabled\":true,\"logFileName\":\"/.audit/events.evt\",\"logFileSize\":524288,\"rotatePolicy\":\"OVERWRITE\",\"unsafePolicy\":\"DENY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Body parameters

application/json

auditNfsv3boolean

True indicates that NFSv3 file access will be audited

auditNfsv4boolean

True indicates that NFSv4 file access will be audited

backupIntervalintegerint32

Time between backups of the active audit log, in seconds. A value of 0 indicates that backups are disabled

backupLimitintegerint32

Number of backup audit log files that will be retained

Example:10

externalboolean

True indicates that the logging is external, and not stored on the file system

isEnabledboolean

True if enabled, false for disabled

logFileNamestring

Name of the auditing log file. Must start with a / and have the extension .evt

Example:"/.audit/events.evt"

logFileSizeintegerint32

Maximum size that the log file can grow to, in bytes - maximum 50MB

Example:524288

rotatePolicystring (Enum)

Whether the audit log file overwrites old entries when the file is full, or if a new file is created

Allowed values:"OVERWRITE""CREATE"

unsafePolicystring (Enum)

Action taken when a non-audited protocol attempts access to a file system

Allowed values:"DENY""IGNORE"

REQUEST
{
  "auditNfsv3": false,
  "auditNfsv4": false,
  "backupInterval": 0,
  "backupLimit": 10,
  "external": false,
  "isEnabled": false,
  "logFileName": "/.audit/events.evt",
  "logFileSize": 524288,
  "rotatePolicy": "OVERWRITE",
  "unsafePolicy": "DENY"
}

Responses

No Content - the resource was updated successfully

Bad Request

Body

application/json

errorCodeintegerint32

Generic error code

Example:1081353

errorMsgstring

Main error message

Example:

"Invalid description parameter - the optional parameter must be between 2 and 30 characters long to be valid, if supplied"

RESPONSE
{
  "errorCode": 1081353,
  "errorMsg": "Invalid description parameter - the optional parameter must be between 2 and 30 characters long to be valid, if supplied"
}

Unauthorized - the request was rejected because the credentials or API key were either missing or invalid

Forbidden - the client does not have the required permissions to perform the operation

Body

application/json

errorMsgstring

Main error message

Example:"Forbidden request - the client does not have the required permissions to perform the operation"

RESPONSE
{
  "errorMsg": "Forbidden request - the client does not have the required permissions to perform the operation"
}

Not Found - a resource specified was not found

Body

application/json

errorCodeintegerint32

Generic error code

Example:1081345

errorDetailobject

Detailed error information

detailstring

More details on why the error occurred

faultstring

fileNamestring

Source file where the error occurred

Example:"RestApiFilesystems.cpp"

functionstring

Internal function name where the error occurred

Example:"mountFilesystem"

lineNumberintegerint32

Line number within the source file, where the error occurred

messagestring

Reason why the error(s) occurred

Example:"The file system is currently unassigned"

reasonstring

Reason why the error(s) occurred

Example:"The file system is currently unassigned"

returnedValueintegerint32

Not used

subCodeintegerint32

Specific failure error code

errorMsgstring

Main error message

Example:"Cannot find the object of the operation on the device"

RESPONSE
{
  "errorCode": 1081345,
  "errorDetail": {
    "detail": "",
    "fault": "",
    "fileName": "RestApiFilesystems.cpp",
    "function": "mountFilesystem",
    "lineNumber": 0,
    "message": "The file system is currently unassigned",
    "reason": "The file system is currently unassigned",
    "returnedValue": 0,
    "subCode": 0
  },
  "errorMsg": "Cannot find the object of the operation on the device"
}

Internal Server Error

Body

application/json

errorCodeintegerint32

Generic error code

errorDetailobject

Detailed error information

detailstring

More details on why the error occurred

faultstring

fileNamestring

Source file where the error occurred

Example:"RestApiFilesystems.cpp"

functionstring

Internal function name where the error occurred

Example:"mountFilesystem"

lineNumberintegerint32

Line number within the source file, where the error occurred

messagestring

Reason why the error(s) occurred

Example:"The file system is currently unassigned"

reasonstring

Reason why the error(s) occurred

Example:"The file system is currently unassigned"

returnedValueintegerint32

Not used

subCodeintegerint32

Specific failure error code

errorMsgstring

Main error message

Example:"Failed to mount file system"

RESPONSE
{
  "errorCode": 0,
  "errorDetail": {
    "detail": "",
    "fault": "",
    "fileName": "RestApiFilesystems.cpp",
    "function": "mountFilesystem",
    "lineNumber": 0,
    "message": "The file system is currently unassigned",
    "reason": "The file system is currently unassigned",
    "returnedValue": 0,
    "subCode": 0
  },
  "errorMsg": "Failed to mount file system"
}