Returns 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

Returns the device/file audit configuration for a specific customer.

Request URL

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

Scope

DeviceControl.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

customerIDstringMandatory

Customer identifier for audit settings

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/device/auditsettings/{customerID} \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
auditsettingJSON object

Audit settings configuration

Show Sub-Attributes
customerIDstring

Customer identifier

deviceReportEnabledboolean

Whether device audit reporting is enabled

daysToRetainDeviceinteger

Number of days to retain device audit data

fileReportEnabledboolean

Whether file audit reporting is enabled

daysToRetainFileinteger

Number of days to retain file audit data

fileShadowReportEnabledboolean

Whether file shadow reporting is enabled

daysToRetainFileShadowReportinteger

Number of days to retain file shadow report data

mailTemplatestring

Mail template content for audit notifications

archieveEnabledboolean

Whether archiving is enabled

daysToRetainArchivedFilesinteger

Number of days to retain archived files

archievePathstring

File system path for archived files

fileOperationsarray

File operation type IDs being audited

selectedDeviceTypesarray

Device type IDs being audited

- 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
500HTTP code

Sample Response: HTTP 200

Audit settings response

Copied!
  {
    "auditsetting": {
      "fileShadowReportEnabled": true,
      "deviceReportEnabled": true,
      "fileReportEnabled": true,
      "daysToRetainFileShadowReport": 60,
      "daysToRetainDevice": 120,
      "archieveEnabled": true,
      "mailTemplate": "",
      "selectedDeviceTypes": [
        "1",
        "2",
        "3"
      ],
      "fileOperations": [
        1,
        2,
        3,
        4
      ],
      "daysToRetainArchivedFiles": 60,
      "customerID": "1",
      "daysToRetainFile": 90,
      "archievePath": "C:\\Archive"
    }
  }
                
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.