All Classes and Interfaces
Class
Description
The super class for all exceptions thrown by Nightfall.
The container object containing all parameters required to complete a file upload.
Confidence describes the certainty that a piece of content matches a detector.
Describes how to adjust confidence on a given finding.
An object that describes how a regular expression may be used to adjust the confidence of a candidate finding.
An object that specifies how findings should be encrypted when returned by the API.
An object that contains a set of detectors to be used when scanning content.
An object that represents a data type or category of information.
A container for minimal information representing a detector.
An object that describes a regular expression or list of keywords that may be used to disqualify a
candidate finding from triggering a detector match.
The request payload that is sent by Nightfall to a client-configured webhook URL to report the findings from
an asynchronous file scan.
An object representing a file upload.
An object representing an occurrence of a configured detector (i.e.
An object that specifies that findings should be substituted with the name of the info type that matched
the request data.
An object representing a request to upload a new file to Nightfall.
An object representing where a finding was discovered in content.
An object that contains references to the start and end of the eponymous range.
A modifier that is used to decide when a finding should be surfaced in the context of a detection rule.
An object that specifies how findings should be masked when returned by the API.
The exception thrown when the Nightfall API returns an HTTP status code in the range [400, 599].
Provides a client for accessing the Nightfall Developer Platform.
A builder class that configures, validates, then creates instances of a Nightfall Client.
The exception thrown when the Nightfall client is unable to process a request due to an unexpected error.
The error model returned by Nightfall API requests that are unsuccessful.
An exception that indicates that a timeout was exceeded while processing a request.
An object representing a range of bytes to consider around a candidate finding.
An object that configures how any detected findings should be redacted when returned to the client.
An object representing a regular expression to customize the behavior of a detector while Nightfall performs a scan.
A container for a request to scan a file that was uploaded via the Nightfall API.
The object returned by the Nightfall API when an (asynchronous) file scan request was successfully triggered.
An object containing configuration that describes how to scan a file.
The configuration object to use when scanning inline plaintext with the Nightfall API.
An object representing a request to scan inline plaintext with the Nightfall API.
The response object returned by a text scan request.
An object that specifies how findings should be substituted when returned by the API.
An object representing a request to upload a chunk of file data to the Nightfall API.
A class that implements Nightfall webhook signature validation.
A list of words that can be used to customize the behavior of a detector while Nightfall performs a scan.