Skip to navigation
API ReferenceThreat DetectionFinding Exclusions

Create Finding Exclusion

Excludes matching files, tables, or databases from threat detection.

The exclusion can be scoped either to a single resource or to all resources in the Eon account. Creating an exclusion has no effect on in-progress scans.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequiredformat: "uuid"

ID of the project the finding exclusion is in. You can get your project ID from the API Credentials page in your global management console.

Request

This endpoint expects an object.
scopeenumRequired

Whether the exclusion applies to a single resource or to all resources in the Eon account.

If set to RESOURCE, a resource ID must be set in providerResourceId.

Allowed values:
valuestringRequired>=1 character

Matching value to exclude. The value set in this field depends on the specified type.

  • PATH: Matches files whose path starts with the specified value, case-sensitive. For example, /data/tmp matches /data/tmp2/report.csv.

    Linux paths are case-sensitive.

    Windows paths are case-insensitive, normalize for the file separator, and start with the drive letter. For example, C:\Users\App\Cache matches c:/users/app/cache.

  • TABLE: Exact table name.

  • DATABASE: Exact database name.

  • KMS_KEY: Either a KMS key ARN, or an AWS account ID to trust all keys in the account. Available for the ransomware detector only.

typeenumRequired

Whether the finding is set to a file path, a database table, a whole database, or objects encrypted with a trusted KMS key. Used in combination with value.

Allowed values:
detectorenumRequired

Detector type the exclusion applies to. If set to MALWARE, only paths can be excluded.

Allowed values:
providerResourceIdstringOptional>=1 character

Cloud-provider-assigned ID of the resource to apply the exclusion to.

Required for RESOURCE scope. Must be omitted for ACCOUNT scope.

Response

Finding exclusion created.
findingExclusionobject
Exclusion that stops a detector from reporting findings for matching files, tables, or databases. Can be scoped either to a single resource or to all resources in your inventory.

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
Was this page helpful?