Jump to Content
Nightfall Docs | Data Loss Prevention (DLP) API
HomeGuidesAPI Reference
Help centerLog inStart for freeNightfall Docs | Data Loss Prevention (DLP) API
Help centerLog inStart for free
HomeGuidesAPI Reference

Introduction

  • Welcome to the Nightfall API
  • Authentication and Security
  • Quickstart
  • Use Cases
  • Pricing

Key Concepts

  • Entities and Terms to Know
  • Setting Up Nightfall
    • Creating an API Key
    • Creating a Detector
    • Creating Detection Rules
    • Creating Policies
  • Webhooks and Asynchronous Notifications
    • Accessing Your Webhook Signing Key
    • Creating a Webhook Server
    • Alerting
  • Scanning Text
    • Using Pre-Configured Detection Rules
    • Creating an Inline Detection Rule
    • Using Exclusion Rules
    • Using Context Rules
    • Using Redaction
    • Using Policies
  • Scanning Files
    • Supported File Types
    • File Scanning and Webhooks
    • Uploading and Scanning API Calls
  • Rate Limiting
  • Errors
  • Detector Glossary
  • Playground
  • FAQs

Nightfall SDKs

  • Nightfall SDKs
  • Java SDK
  • Python SDK
  • Go SDK
  • Node SDK

Tutorials & Examples

  • Intro: Tutorials & Examples
  • Language Specific Guides
    • Basic Usage (Python SDK)
    • Basic Usage (Ruby)
    • Basic Usage (Java)
  • 3rd Party Integrations
    • Integrating with Airtable (Python)
    • Integrating with Amazon Kinesis (Python)
    • Integrating with Amazon RDS — Full RDS Scan
    • Integrating with Amazon RDS (Python)
    • Integrating with Amazon S3 (Python)
    • Integrating with Datadog (Python)
    • Integrating with Elasticsearch (Python)
    • Integrating with HubSpot (Python)
    • Integrating with New Relic (Python)
    • Integrating with Snowflake (Python)
    • Integrating with Zendesk (Python)
  • Scenario Library
    • Detecting Sensitive Data in Transactional Email & SMS
    • Deploy a File Scanner for Sensitive Data in 40 Lines of Code
    • Redacting Sensitive Data in 4 Lines of Code
    • Building Endpoint DLP to Detect PII on Your Machine in Real-Time

Scanning Text

Suggest Edits

The scan endpoint allows you to apply Detection Rules to text strings.

You may use Pre-Configured Detection Rules or Create Inline Detection Rules

See also examples for Using Exclusion Rules and Using Context Rules as part of your scan requests.

For scanning files, see Scanning Files.

Note that you must generate an API key to send requests to the Nightfall API.

Updated 8 months ago