Updates device audit settings

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

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

Request URL

https://{serverurl}/dcapi/device/auditsettings/{customerID}

Scope

DesktopCentralCloud.DeviceControl.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/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://appdomains/dcapi/device/auditsettings/{customerID} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

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.