DASL Client Documentation

Welcome to the documentation for the DASL (Databricks Antimatter Security Lakehouse) Python client library. This library provides an interface for interacting with DASL services, allowing you to manage datasources, rules, workspace configurations, and more from Databricks notebooks.

Note

This client is designed to work seamlessly within Databricks environments and can automatically authenticate using your current workspace context.

Key Features

• Simple Authentication: Automatic workspace detection in Databricks notebooks

• Datasource Management: Create, update, list, and delete datasources

• Rule Management: Define and manage security detection rules to identify threats

• Workspace Configuration: Update and retrieve DASL’s workspace-level settings

Quick Start

Install the DASL client from the Pypi repository:

pip install dasl-client

Get started in a Databricks notebook:

from dasl_client import Client

# Automatically authenticate using workspace context
client = Client.for_workspace()

# List existing datasources
for datasource in client.list_datasources():
    print(f"Datasource: {datasource.metadata.name}")

Documentation Contents

Getting Started

• Installation
  • Requirements
  • Install via pip
  • Dependencies
  • In a Databricks Notebook
  • Troubleshooting
  • Next Steps
• Quick Start Guide
  • Prerequisites
  • Authentication
  • Explore Your Workspace
  • Create Your First Datasource
  • Retrieve and Update a Datasource
  • Create a Detection Rule
  • Retrieve and Update a Detection Rule
  • Next Steps

User Guide

• Datasources
  • Overview
  • Listing Datasources
  • Getting Individual Datasources
  • Creating Datasources with Presets
  • Creating Custom Datasources
  • Updating Datasources
  • Deleting Datasources
  • Scheduling and Automation
  • Error Handling
  • Best Practices
  • Quick Reference
  • Next Steps
• Rules
  • Overview
  • Rule Structure
  • Quick Reference
  • Listing Rules
  • Getting Individual Rules
  • Create a Detection Rule
  • Retrieve and Update a Detection Rule
  • Deleting Rules
  • Next Steps
• Workspace Configuration
  • Overview
  • Getting Configuration
  • Understanding Configuration Structure
  • Storage Configuration
  • Detection Rule Configuration
  • Updating Configuration
  • Custom Notebook Configuration
  • Datasource-Specific Configuration
  • Rules-Specific Configuration
  • Error Handling
  • Next Steps

API Reference

• Overview
  • Overview
  • Search and Index
• Client
  • Main Client Class
  • Authentication Factory Methods
  • Datasource Operations
  • Rule Operations
  • Workspace Configuration
• Data Types
  • Core Data Models
  • Common Helper Types
  • Datasource Helper Types
  • Configuration Helper Types
• Error Handling
  • ConflictError
  • NotFoundError
  • BadRequestError
  • UnauthorizedError
  • ForbiddenError
  • handle_errors()
  • error_handler()
  • Error Handling Utilities

Support

• Documentation: https://dasl-client.readthedocs.io

• Support: support@antimatter.io

Indices and tables

• Index

• Module Index

• Search Page