All Products
Search
Document Center

Security Center:CreateMaliciousFileWhitelistConfig

Last Updated:Feb 20, 2024

Creates an alert whitelist rule of sensitive files that are detected by using the agentless detection feature.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
EventNamestringNo

The name of the alert.

  • Set the value to ALL, which indicates all alert types.
ALL
FieldstringNo

The field that you want to use in the whitelist rule.

fileMd5
OperatorstringNo

The logical operator that you want to use in the whitelist rule.

  • Set the value to strEqual, which indicates the equality operator (=).
strEqual
FieldValuestringNo

The value of the field that you want to use in the whitelist rule.

b2cf9747ee49d8d9b105cf16e078cc16
TargetTypestringNo

The type of the assets on which you want the whitelist rule to take effect. Valid values:

  • ALL: all assets
  • SELECTION_KEY: selected assets
ALL
TargetValuestringNo

The assets on which you want the whitelist rule to take effect. Valid values:

  • ALL: all assets
  • Others: selected assets
ALL
SourcestringNo

The feature to which this operation belongs.

  • Set the value to agentless, which indicates the agentless detection feature.
agentless

Response parameters

ParameterTypeDescriptionExample
object

PlainResult

Dataobject

The response parameters.

GmtCreatestring

The creation time.

1671607025000
GmtModifiedstring

The modification time.

1671607025000
EventNamestring

The name of the alert.

  • The value is fixed as ALL, which indicates all alert types.
ALL
Fieldstring

The field that is used in the whitelist rule.

fileMd5
FieldValuestring

The value of the field that is used in the whitelist rule.

b2cf9747ee49d8d9b105cf16e078cc16
Operatorstring

The logical operator that is used in the whitelist rule.

  • The value is fixed as strEqual, which indicates the equality operator (=).
strEqual
TargetValuestring

The assets on which the whitelist rule takes effect. Valid values:

  • ALL: all assets
  • Others: selected assets
ALL
TargetTypestring

The type of the assets on which the whitelist rule takes effect. Valid values:

  • ALL: all assets
  • SELECTION_KEY: selected assets
ALL
Countstring

The number of the assets on which the whitelist rule takes effect.

Note The value of this parameter is returned only if the value of TargetType is SELECTION_KEY.
1
Sourcestring

The feature to which this operation belongs.

  • The value is fixed as agentless, which indicates the agentless detection feature.
agentless
Idstring

The ID of the whitelist rule.

1
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The HTTP status code.

200
Messagestring

The returned message.

successful
RequestIdstring

The request ID.

A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX
HttpStatusCodeinteger

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{
  "Data": {
    "GmtCreate": "1671607025000",
    "GmtModified": "1671607025000",
    "EventName": "ALL",
    "Field": "fileMd5",
    "FieldValue": "b2cf9747ee49d8d9b105cf16e078cc16",
    "Operator": "strEqual",
    "TargetValue": "ALL",
    "TargetType": "ALL",
    "Count": "1",
    "Source": "agentless",
    "Id": "1"
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX",
  "HttpStatusCode": 200
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionno permission-
400UnknownErrorUnknownError-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history