Data Loss Prevention API

The DLP API provides access to metadata about sensitive data fields. It helps classify data by type and assess the risk level associated with it. This makes it easier for systems to apply protective measures where needed.

What is DLP?

DLP stands for Data Loss Prevention. It is a security strategy used to prevent sensitive information from being accidentally shared, leaked, or accessed by unauthorized users. DLP solutions identify, monitor, and protect data such as personal information, financial details, and confidential records.

• API Endpoint: https://api.predic8.de/dlp/fields/{fieldName}
  

  Replace {fieldName} with the field you want to check (e.g. email, card_number, last_name).

• OpenAPI: https://api.predic8.de/dlp/dlp-api-v1.0.0.yml

How to call the API

You can call the API using curl, Postman, or directly in your application code. Here are some examples with curl:

Single Field Check (GET)

curl https://api.predic8.de/dlp/fields/email

Response:

{
  "field": "email",
  "category": "Contact",
  "risk": "High"
}

{
  "field": "email",
  "category": "Contact",
  "risk": "High"
}

Multiple Fields Check (POST)

curl https://api.predic8.de/dlp/fields \
-H "Content-Type: application/json" \
-d '{"fieldNames":["email","card_number","last_name"]}'

curl https://api.predic8.de/dlp/fields \
-H "Content-Type: application/json" \
-d '{"fieldNames":["email","card_number","last_name"]}'

Response:

[
  {
    "field": "email",
    "category": "Contact",
    "risk": "High"
  },
  {
    "field": "card_number",
    "category": "Financial",
    "risk": "High"
  },
  {
    "field": "last_name",
    "category": "Personally Identifiable Information",
    "risk": "High"
  }
]

[
  {
    "field": "email",
    "category": "Contact",
    "risk": "High"
  },
  {
    "field": "card_number",
    "category": "Financial",
    "risk": "High"
  },
  {
    "field": "last_name",
    "category": "Personally Identifiable Information",
    "risk": "High"
  }
]

Responses will contain classification details for each field, including field, category, and risk.

Key Features:

• Single Field Check: Retrieve the DLP category and risk level for a specific field, e.g. email or card_number.

  Returns classification details for the field email.

• Multiple Fields Check: Send a list of field names and get classification details for all of them at once.

  Returns classification details for all listed fields.

• Classification Info: Each field returns:
  • field: the field name
  • category: the data classification (e.g. Financial, Contact)
  • risk: the risk level (e.g. HIGH, MEDIUM, LOW)

Handling Unknown Fields

If the API returns Unknown for a field, this information is stored in a database. This allows us to track how often unrecognized field names are requested and gain insights into which fields might need to be added to the classification system in the future.