How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nightfall AI Scan API

The Scan API from Nightfall AI — 1 operation(s) for scan.

Nightfall AI Scan API is published by Nightfall AI 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.2.0, 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.2.0
API Version
0.0.1
Server
https://api.nightfall.ai/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Nightfall AI Scan 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.

Scan 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), Condition (3 properties). Each schema is shown below with its type and property counts.

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

This is an independent, third-party profile of Nightfall AI Scan API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.