Skip to main content
A newer release of this product is available.

Update administrative audit settings for GET requests

Contributors
PDFs

PATCH /security/audit

Introduced In: 9.6

Updates administrative audit settings for GET requests. All of the fields are optional. An empty body will make no changes.

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Request Body

Name Type Description

cli

boolean

Enable auditing of CLI GET Operations. Valid in PATCH

http

boolean

Enable auditing of HTTP GET Operations. Valid in PATCH

ontapi

boolean

Enable auditing of ONTAP API GET operations. Valid in PATCH

  • Introduced in: 9.6

Response

Status: 202, Accepted
Name Type Description

cli

boolean

Enable auditing of CLI GET Operations. Valid in PATCH

http

boolean

Enable auditing of HTTP GET Operations. Valid in PATCH

ontapi

boolean

Enable auditing of ONTAP API GET operations. Valid in PATCH

  • Introduced in: 9.6

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

security_audit

Name Type Description

cli

boolean

Enable auditing of CLI GET Operations. Valid in PATCH

http

boolean

Enable auditing of HTTP GET Operations. Valid in PATCH

ontapi

boolean

Enable auditing of ONTAP API GET operations. Valid in PATCH

  • Introduced in: 9.6

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.