Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nightfall AI Scans API

The Scans API from Nightfall AI — 1 operation(s) for scans.

Nightfall AI Scans API is one of 2 APIs that Nightfall AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scans. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 22 schemas. It is described by OpenAPI 3.0.1, at version 0.0.1.

Requests are made against a single base URL, https://api.nightfall.ai/.

1 operations 1 paths 22 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0.0.1
Server
https://api.nightfall.ai/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Nightfall AI Scans API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (apiKeyAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Scans 1
POST
/v2/scan
Nightfall AI Scan for sensitive information in your data
ScanPayloadV2 body → 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Detector (7 properties), ExclusionRule (4 properties), ScanResponseV2 (4 properties), ContextRule (3 properties). Each schema is shown below with its type and property counts.

ScanRequestV2
object
The request body of the /v2/scan endpoint
2 properties
Detector
object
7 properties
ScanResponse_location_unicodeRange
object
2 properties
ExclusionRule
object
An exclusion rule removes findings that match the rule's given exlusion.
4 properties
ExclusionType
string
The type of exclusion rule.
WordList
object
The WordList object for wordList detector and exclusion rules.
2 properties
ScanRequestV2_config_conditionSet
object
A conditionSet contains a list of conditions with which you wish to scan the request payload.
2 properties
ContextRule_confidenceAdjustment
object
The object containing the confidence level to adjust findings to.
1 property
MatchType
string
The type of match for a pattern.
ScanRequestV2_config
object
Config can contain either a conditionSetUUID or a list of inline conditions to scan the request payload with.
2 properties
ContextRule
object
A context rule adjusts the finding confidence based on surrounding context.
3 properties
NightfallDetectorType
string
The name for a Nightfall detector.
EachItemV2Array
array
ContextRule_proximity
object
The object containing the length of characters before and after finding to evaluate context.
2 properties
ScanResponseV2Array
array
DetectorType
string
The type of detector.
Confidence
string
The confidence level of a finding.
ScanResponse_location
object
2 properties
ScanResponse_location_byteRange
object
2 properties
ScanResponseV2
object
4 properties
Condition
object
An inclusion condition within a condition set.
3 properties
Regex
object
The regex object for the regex detector, context rules, and exclusion rules.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nightfall-ai-scans-api-openapi.yml Raw ↑

Other APIs Nightfall AI publishes across the network.

Nightfall AI Scan API