Creating Template

Using cURL

curl -X POST -H "Content-Type: application/json" -H "x-javelin-apikey: $JAVELIN_API_KEY" -d '{
        "name": "InspectPII",
        "description": "Inspect sensitive data",
        "enabled": true,
        "type": "inspect",
        "config": {
            "infoTypes": [ 
                {"name": "MAC_ADDRESS_LOCAL"},
                {"name": "EMAIL_ADDRESS"},
                {"name": "STREET_ADDRESS"},
                {"name": "PHONE_NUMBER"},
                {"name": "VEHICLE_IDENTIFICATION_NUMBER"},
                {"name": "PERSON_NAME"},
                {"name": "US_DRIVERS_LICENSE_NUMBER"},
                {"name": "PASSPORT"},
                {"name": "US_SOCIAL_SECURITY_NUMBER"},
                {"name": "US_INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"},
                {"name": "MEDICAL_RECORD_NUMBER"},
                {"name": "MEDICAL_TERM"},
                {"name": "US_MEDICARE_BENEFICIARY_ID_NUMBER"},
                {"name": "US_HEALTHCARE_NPI"},
                {"name": "AUTH_TOKEN"},
                {"name": "AWS_CREDENTIALS"},
                {"name": "AZURE_AUTH_TOKEN"},
                {"name": "BASIC_AUTH_HEADER"},
                {"name": "GCP_API_KEY"},
                {"name": "GCP_CREDENTIALS"},
                {"name": "HTTP_COOKIE"},
                {"name": "JSON_WEB_TOKEN"},
                {"name": "ENCRYPTION_KEY"},
                {"name": "OAUTH_CLIENT_SECRET"},
                {"name": "PASSWORD"},
                {"name": "SSL_CERTIFICATE"},
                {"name": "STORAGE_SIGNED_POLICY_DOCUMENT"},
                {"name": "STORAGE_SIGNED_URL"},
                {"name": "WEAK_PASSWORD_HASH"},
                {"name": "XSRF_TOKEN"},
                {"name": "CREDIT_CARD_TRACK_NUMBER"},
                {"name": "US_EMPLOYER_IDENTIFICATION_NUMBER"},
                {"name": "US_ADOPTION_TAXPAYER_IDENTIFICATION_NUMBER"},
                {"name": "US_PREPARER_TAXPAYER_IDENTIFICATION_NUMBER"},
                {"name": "US_DEA_NUMBER"},
                {"name": "US_PASSPORT"},
                {"name": "CREDIT_CARD_NUMBER"}
            ],
            "likelihood": "Possible",
            "transformation": {
                "method": "Inspect"
            },
            "notify": true,
            "reject": false
        }
}' "https://your-api-domain.com/v1/admin/processors/dp/templates/inspect"

Using python SDK

Javelin Template Example

from javelin_sdk import (
    JavelinClient,
    JavelinConfig,
    Template
)

import os
    
# Retrieve environment variables
javelin_api_key = os.getenv('JAVELIN_API_KEY')

# create javelin client
config = JavelinConfig(
    base_url="https://your-api-domain.com",
    javelin_api_key=javelin_api_key
)
client = JavelinClient(config)

template_data = {
        "name": "InspectPII",
        "description": "Inspect sensitive data",
        "enabled": True,
        "type": "inspect",
        "config": {
            "infoTypes": [
                {"name": "MAC_ADDRESS_LOCAL"},
                {"name": "EMAIL_ADDRESS"},
                {"name": "STREET_ADDRESS"},
                {"name": "PHONE_NUMBER"},
                {"name": "VEHICLE_IDENTIFICATION_NUMBER"},
                {"name": "PERSON_NAME"},
                {"name": "US_DRIVERS_LICENSE_NUMBER"},
                {"name": "PASSPORT"},
                {"name": "US_SOCIAL_SECURITY_NUMBER"},
                {"name": "US_INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER"},
                {"name": "MEDICAL_RECORD_NUMBER"},
                {"name": "MEDICAL_TERM"},
                {"name": "US_MEDICARE_BENEFICIARY_ID_NUMBER"},
                {"name": "US_HEALTHCARE_NPI"},
                {"name": "AUTH_TOKEN"},
                {"name": "AWS_CREDENTIALS"},
                {"name": "AZURE_AUTH_TOKEN"},
                {"name": "BASIC_AUTH_HEADER"},
                {"name": "GCP_API_KEY"},
                {"name": "GCP_CREDENTIALS"},
                {"name": "HTTP_COOKIE"},
                {"name": "JSON_WEB_TOKEN"},
                {"name": "ENCRYPTION_KEY"},
                {"name": "OAUTH_CLIENT_SECRET"},
                {"name": "PASSWORD"},
                {"name": "SSL_CERTIFICATE"},
                {"name": "STORAGE_SIGNED_POLICY_DOCUMENT"},
                {"name": "STORAGE_SIGNED_URL"},
                {"name": "WEAK_PASSWORD_HASH"},
                {"name": "XSRF_TOKEN"},
                {"name": "CREDIT_CARD_TRACK_NUMBER"},
                {"name": "US_EMPLOYER_IDENTIFICATION_NUMBER"},
                {"name": "US_ADOPTION_TAXPAYER_IDENTIFICATION_NUMBER"},
                {"name": "US_PREPARER_TAXPAYER_IDENTIFICATION_NUMBER"},
                {"name": "US_DEA_NUMBER"},
                {"name": "US_PASSPORT"},
                {"name": "CREDIT_CARD_NUMBER"}
            ],
            "likelihood": "Likely",
            "transformation": {
                "method": "Inspect" // method can be set to: inspect, mask, redact, or replace.
            },
            "notify": True,
            "reject": False
        }
}

template = Template.model_validate(template_data)

# create the template, for async use `await client.acreate_template(template)`
client.create_template(template)

Template with Redact Method

curl -X POST -H "Content-Type: application/json" -H "x-javelin-apikey: $JAVELIN_API_KEY" -d '{
        "name": "RedactPII",
        "description": "Redact sensitive data",
        "enabled": true,
        "type": "de-identify",
        "config": {
            "infoTypes": [
                {"name": "EMAIL_ADDRESS"},
                {"name": "PHONE_NUMBER"},
                {"name": "PERSON_NAME"},
                {"name": "US_SOCIAL_SECURITY_NUMBER"},
                {"name": "CREDIT_CARD_NUMBER"},
                {"name": "STREET_ADDRESS"},
                {"name": "US_PASSPORT"}
            ],
            "likelihood": "Possible",
            "transformation": {
                "method": "Redact" 
            },
            "notify": true,
            "reject": false
        }
}' "https://your-api-domain.com/v1/admin/processors/dp/templates/RedactPII"

Template with Mask Method

curl -X POST -H "Content-Type: application/json" -H "x-javelin-apikey: $JAVELIN_API_KEY" -d '{
        "name": "MaskPII",
        "description": "Mask sensitive data",
        "enabled": true,
        "type": "de-identify",
        "config": {
            "infoTypes": [
                {"name": "EMAIL_ADDRESS"},
                {"name": "PHONE_NUMBER"},
                {"name": "PERSON_NAME"},
                {"name": "US_SOCIAL_SECURITY_NUMBER"},
                {"name": "CREDIT_CARD_NUMBER"},
                {"name": "PASSWORD"},
                {"name": "ENCRYPTION_KEY"}
            ],
            "likelihood": "Possible",
            "transformation": {
                "method": "Mask",
                "maskingCharacter": "*",
                "numberToMask": 0
            },
            "notify": true,
            "reject": false
        }
}' "https://your-api-domain.com/v1/admin/processors/dp/templates/MaskPII"

Template with Replace Method

curl -X POST -H "Content-Type: application/json" -H "x-javelin-apikey: $JAVELIN_API_KEY" -d '{
        "name": "ReplacePII",
        "description": "Replace sensitive data",
        "enabled": true,
        "type": "de-identify",
        "config": {
            "infoTypes": [
                {"name": "EMAIL_ADDRESS"},
                {"name": "PHONE_NUMBER"},
                {"name": "PERSON_NAME"},
                {"name": "US_SOCIAL_SECURITY_NUMBER"},
                {"name": "CREDIT_CARD_NUMBER"},
                {"name": "PASSWORD"},
                {"name": "STREET_ADDRESS"}
            ],
            "likelihood": "Possible",
            "transformation": {
                "method": "Replace",
                "replacementConfig": {
                    "EMAIL_ADDRESS": "[EMAIL]",
                    "PHONE_NUMBER": "[PHONE]",
                    "PERSON_NAME": "[NAME]",
                    "US_SOCIAL_SECURITY_NUMBER": "[SSN]",
                    "CREDIT_CARD_NUMBER": "[CREDIT_CARD]",
                    "PASSWORD": "[PASSWORD]",
                    "STREET_ADDRESS": "[ADDRESS]"
                }
            },
            "notify": true,
            "reject": false
        }
}' "https://your-api-domain.com/v1/admin/processors/dp/templates/ReplacePII"

Template with Custom Regex

curl -X POST \
-H "Content-Type: application/json" \
-H "x-javelin-apikey: $JAVELIN_API_KEY" \
-d '{
    "name": "CustomRegexTemplate",
    "description": "Detect sensitive data with custom regex and reserved keywords",
    "enabled": true,
    "type": "inspect",
    "config": {
        "notify": true,
        "reject": false,
        "infoTypes": [
            {
                "name": "OPENAI_API_KEY",
                "regex": "sk-[a-zA-Z0-9]{48}"
            },
            {
                "name": "RESERVED_KEYWORD",
                "dictionary": {
                    "wordList": ["confidential", "secret", "private", "classified", "restricted"]
                }
            }
        ],
        "likelihood": "Possible",
        "rejectPrompt": "Unable to complete request, data protection policy has detected sensitive data leakage or enterprise violations in prompt",
        "transformation": {
            "method": "Inspect"
        }
    }
}' \
"https://your-api-domain.com/v1/admin/processors/dp/templates/inspect"