Detectors /   DETECTOR
Generate Code Validate Data   Nightfall Console

API Key

This is a DLP detector that you can easily use or extend upon in the Nightfall platform.

Description Detects API keys, credentials needed to authenticate and authorize a cloud provider's API request. Findings will include the vendor name and active key validation for the most popular services. See Detecting Secrets
Detector type AI Model (Entity Detection)
Category Secrets
Region Global
Tags secrets api key
Enum (for using this detector via the API)
API_KEY

Used in These Detection Rules

Used in These Policies


Use Detector via API

Read API Reference

curl --request POST \
     --url https://api.nightfall.ai/v3/scan \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer  REPLACE-WITH-YOUR-KEY' \
     --header 'Content-Type: application/json' \
     --data '
{
     "policy": {
          "detectionRules": [
               {
                    "detectors": [
                         {
                              "minNumFindings": 1,
                              "minConfidence": "LIKELY",
                              "displayName": "API Key",
                              "detectorType": "NIGHTFALL_DETECTOR",
                              "nightfallDetector": "API_KEY"
                         }                    ],
                    "name": "My Inline Detection Rule",
                    "logicalOp": "ANY"
               }
          ]
     },
     "payload": [
          "INSERT 1+ PAYLOAD(S)",
          "INSERT 1+ PAYLOAD(S)"
     ]
}
'

          import requests
          import json

          api_key = "REPLACE-WITH-YOUR-KEY"
          url = "https://api.nightfall.ai/v3/scan"

          headers = {
              "Accept": "application/json",
              "Authorization": f"Bearer {api_key}",
              "Content-Type": "application/json"
          }

          payload = {
              "policy": {
                  "detectionRules": [
                      {
                          "detectors": [
                              {
                                  "minNumFindings": 1,
                                  "minConfidence": "LIKELY",
                                  "displayName": "API Key",
                                  "detectorType": "NIGHTFALL_DETECTOR",
                                  "nightfallDetector": "API_KEY"
                              }
                          ],
                          "name": "My Inline Detection Rule",
                          "logicalOp": "ANY"
                      }
                  ]
              },
              "payload": [
                  "INSERT 1+ PAYLOAD(S)",
                  "INSERT 1+ PAYLOAD(S)"
              ]
          }

          response = requests.post(url, headers=headers, data=json.dumps(payload))
          print(response.status_code)
          print(response.json())
          

API Key Validator

Input any text to validate or test. The default minimum confidence is set to "Possible".