API
ALTR provides a set of APIs for managing platform configuration, policies, classification, tokenization, and audit data programmatically.
In this section
Section titled “In this section”- API Keys – Create and manage API keys for programmatic access to ALTR.
ALTR APIs
Section titled “ALTR APIs”ALTR APIs use HTTP Basic Authentication with an API key; see API Keys to create one.
Most APIs below use a common domain. A few, such as the Key Management API, are organization-specific: the URL includes your organization ID as a subdomain, in the pattern https://<organization-id>.kma.live.altr.com/v1/docs. Find your organization ID on Organization Preferences or in your ALTR URL.
| API | Description |
|---|---|
| Management API (MAPI) | Core platform configuration – data sources, policies, users, and settings. |
| Unified Policy API | Policy CRUD and rule management across all policy types. |
| Role-Based Access Control (RBAC) API | Creates and revokes grants on roles inside a Snowflake database. |
| Classification API | Manages classifiers, collections, and classification jobs for ALTR’s classification engine. |
| Auto Tagging API | Sets tags automatically based on classification results. |
| Datastore Information Service API (DIS) | Triggers classification for Snowflake using Google DLP. Databricks classification now uses the Classification API instead. |
| Tag Masking API | Connects, removes, and modifies connections of Snowflake Object Tags to ALTR. |
| Tag Value Refresh API | Refreshes the list of allowed values ALTR caches for tags connected using the Tag Masking API. |
| Tag-based Governance Policy on Databricks | Defines tag-based access policies (masking) for tagged columns in Databricks. |
| Query Audits API | Retrieves query audit records generated by ALTR for access to protected data. |
| Query Dashboard API | Serves dashboard metrics using sidecar and Snowflake audit data. |
| Critical Tokenization API | Tokenizes and detokenizes values using a PCI-compliant API. |
| Vaulted Tokenization API | Tokenizes and detokenizes sensitive data for Online Analytical Processing (OLAP) and OLTP workloads. Contact ALTR to enable Vaulted Tokenization. |
| AI Data Shield API | Registers applications, authors Shield policy, and protects and restores sensitive values in application payloads. See AI Data Shield. |
| Key Management API | Manages keys and tweaks used in Format-Preserving Encryption (FPE). Organization-specific; replace your-organization-id with your actual organization ID – see the note above. |
| Snowflake Metadata API | Provides Snowflake object metadata. |
| Sidecar Repo Config API | Manages sidecar repository configuration data. |
| Sidecar Audit API | Retrieves audits generated by ALTR sidecars. |
| Sidecar Telemetry API | Manages sidecar telemetry data. |
| Access Tokens API | Manages data consumer access tokens. |
| Service User Service API | Manages service users, which connect ALTR to third-party applications such as Snowflake. |
| Audit Report API | Manages audit definitions and on-demand and scheduled report execution and retrieval. |
| DAM Alerting API | Manages alert rules, triggered alerts, and alert acknowledgment for Database Activity Monitoring. |
| Notification Integration API | Configures third-party delivery integrations and event subscriptions that route events by filter criteria. |