Skip to main content

API

ALTR's APIs enable you to customize, automate, and integrate key parts of the ALTR platform. ALTR exposes multiple APIs for configuration, data management, and tokenization. ALTR's APIs use HTTP Basic Authentication, where the username is an API key name and the password is an API key secret.

To create an API key, refer to Manage API Keys.

API

Description

Auto Tagging API

Sets tags based on an ALTR classification report.

Access Tokens API

Manages data consumer access tokens.

Datastore Information Service API (DIS)

Manages key information around metadata and classification. This API can be used to trigger data classifications, access classification results, and manage information on ALTR tags.

Key Management API

Manages keys and tweaks used in format-preserving encryption.

Management API (MAPI)

Controls the configuration of most ALTR functionality, including settings, administrator management, data source connections, and policy.

Query Audits API

Obtains query audits generated by ALTR, which are records of all access to sensitive data protected by ALTR.

Role-Based Access Control (RBAC) API

Creates and revokes grants on roles inside a Snowflake or a Databricks database. This feature is also referred to as headless access request enforcement (HARE).

Service User Service API

Manages service users, which are used to connect to third-party applications such as Snowflake.

Sidecar Audit API

Obtains all audits generated by ALTR sidecars.

Sidecar Repo Config API

Manges sidecar repository data.

Sidecar Telemetry API

Manages sidecar telemetry data.

Tag-based governance policy on Databricks

Defines tag-based governance on tagged columns in Databricks.

Note

Before using this API:

  • Ensure this API is enabled for your ALTR organization. Contact ALTR Support for assistance.

  • Register your Databricks service principal and workspace with using the POST /databases endpoint in the Management API.

Tag Masking API

Manages access control of Snowflake Object Tags. This API can be used to connect, remove, and modify connections of Snowflake Object Tags to ALTR.

Tag Value Refresh API

Refreshes the list of allowed values that ALTR caches for tags connected using the Tag Masking API.

Unified Policy API

Reads high-level policy information. Creating and editing policies is managed by the Management API (MAPI)

Vaulted Tokenization API

Tokenizes and detokenizes sensitive data using a PCI-compliant and highly scalable tokenization platform. This platform is suitable for both On-Line-Analytical-Processing (OLAP) and On-Line-Transactional-Processing (OLTP) workloads with minimal overhead.

Note

Access to the Vaulted Tokenization APIs and OpenAPI Specification is restricted. You must have access to ALTR Tokenization to access these endpoints and documentation. For help accessing these endpoints, contact ALTR Support.

Snowflake Metadata API

Provides Snowflake object metadata.

In this section: