Updates device audit settings

Updates an existing device/file audit configuration by customer identifier.

Endpoints

put /dcapi/device/auditsettings/{customerID}

Copy full URL

Request URL

https://{server-hostname}:8383/dcapi/device/auditsettings/{customerID}

Scope

DeviceControl.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

- Path Parameters

customerIDstringMandatory

Customer identifier for audit settings

- Request Body

application/json

JSON object

Hide Sub-Attributes

auditsettingJSON objectOptional

Audit settings object containing configuration

Show Sub-Attributes

deviceReportEnabledbooleanOptional

Whether device audit reporting is enabled

daysToRetainDeviceintegerOptional

Number of days to retain device audit data

fileReportEnabledbooleanOptional

Whether file audit reporting is enabled

daysToRetainFileintegerOptional

Number of days to retain file audit data

fileShadowReportEnabledbooleanOptional

Whether file shadow reporting is enabled

daysToRetainFileShadowReportintegerOptional

Number of days to retain file shadow report data

archieveEnabledbooleanOptional

Whether archiving is enabled

daysToRetainArchivedFilesintegerOptional

Number of days to retain archived files

archievePathstringOptional

File system path for archived files

fileOperationsarrayOptional

File operation type IDs to audit

selectedDeviceTypesarrayOptional

Device type IDs to audit. Fetch from Get Supported Devices

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/dcapi/device/auditsettings/{customerID} \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"auditsetting":{"fileShadowReportEnabled":true,"selectedDeviceTypes":["1","2","3"],"fileOperations":[1,2,3,4],"deviceReportEnabled":true,"fileReportEnabled":true,"daysToRetainFileShadowReport":60,"daysToRetainArchivedFiles":60,"daysToRetainFile":90,"archievePath":"C:\\Archive","daysToRetainDevice":120,"archieveEnabled":true}}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/dcapi/device/auditsettings/{customerID}"))
        .header("Content-Type", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"auditsetting\":{\"fileShadowReportEnabled\":true,\"selectedDeviceTypes\":[\"1\",\"2\",\"3\"],\"fileOperations\":[1,2,3,4],\"deviceReportEnabled\":true,\"fileReportEnabled\":true,\"daysToRetainFileShadowReport\":60,\"daysToRetainArchivedFiles\":60,\"daysToRetainFile\":90,\"archievePath\":\"C:\\\\Archive\",\"daysToRetainDevice\":120,\"archieveEnabled\":true}}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"auditsetting\":{\"fileShadowReportEnabled\":true,\"selectedDeviceTypes\":[\"1\",\"2\",\"3\"],\"fileOperations\":[1,2,3,4],\"deviceReportEnabled\":true,\"fileReportEnabled\":true,\"daysToRetainFileShadowReport\":60,\"daysToRetainArchivedFiles\":60,\"daysToRetainFile\":90,\"archievePath\":\"C:\\\\Archive\",\"daysToRetainDevice\":120,\"archieveEnabled\":true}}"

headers = {
    'Content-Type': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/dcapi/device/auditsettings/{customerID}", payload, headers)

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

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


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data_auditsetting=Map();
    data_auditsetting.put("deviceReportEnabled",true);
    data_auditsetting.put("daysToRetainDevice","1");
    data_auditsetting.put("fileReportEnabled",true);
    data_auditsetting.put("daysToRetainFile","1");
    data_auditsetting.put("fileShadowReportEnabled",true);
    data_auditsetting.put("daysToRetainFileShadowReport","1");
    data_auditsetting.put("archieveEnabled",true);
    data_auditsetting.put("daysToRetainArchivedFiles","1");
    data_auditsetting.put("archievePath","value");
    data_auditsetting_fileOperations=List();
    data_auditsetting.put("fileOperations",data_auditsetting_fileOperations);
    data_auditsetting_selectedDeviceTypes=List();
    data_auditsetting.put("selectedDeviceTypes",data_auditsetting_selectedDeviceTypes);
    data.put("auditsetting",data_auditsetting);

    response = invokeUrl
    [
        url: "https://appDomain/dcapi/device/auditsettings/{customerID}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/device/auditsettings/{customerID}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"auditsetting":{"fileShadowReportEnabled":true,"selectedDeviceTypes":["1","2","3"],"fileOperations":[1,2,3,4],"deviceReportEnabled":true,"fileReportEnabled":true,"daysToRetainFileShadowReport":60,"daysToRetainArchivedFiles":60,"daysToRetainFile":90,"archievePath":"C:\\Archive","daysToRetainDevice":120,"archieveEnabled":true}}'

▼ Show full

Sample Request Body

Update audit settings

Copied!

  {
    "auditsetting": {
      "fileShadowReportEnabled": true,
      "selectedDeviceTypes": [
        "1",
        "2",
        "3"
      ],
      "fileOperations": [
        1,
        2,
        3,
        4
      ],
      "deviceReportEnabled": true,
      "fileReportEnabled": true,
      "daysToRetainFileShadowReport": 60,
      "daysToRetainArchivedFiles": 60,
      "daysToRetainFile": 90,
      "archievePath": "C:\\Archive",
      "daysToRetainDevice": 120,
      "archieveEnabled": true
    }
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object

Hide Sub-Attributes

idlong

Audit settings identifier

- HTTP code 400

Response Body - application/json

JSON object

Hide Sub-Attributes

errorCodestring

Error code identifying the type of error

errorMsgstring

Human-readable error message

- HTTP code 500

Response Body - application/json

JSON object

Hide Sub-Attributes

errorCodestring

Error code identifying the type of error

errorMsgstring

Human-readable error message

Possible Response Codes

200HTTP code

400HTTP code

500HTTP code

Sample Response: HTTP 200

Audit settings update response

Copied!

  {
    "id": 1
  }

▼ Show full

Sample Response: HTTP 400

Bad request - invalid input or sensitive path

Copied!

  {
    "errorCode": "INCORRECT_REQUEST_DATA",
    "errorMsg": "Invalid audit settings data"
  }

▼ Show full

Sample Response: HTTP 500

Internal server error

Copied!

  {
    "errorCode": "INTERNAL_ERROR",
    "errorMsg": "Internal Server Error!"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.