BigID API Overview

BigID was designed as an open platform. Any action that can be performed in our UI can also be done programmatically. This allows you to connect anything and everything to the data discovery capabilities of your BigID system. Whether you are automating a script, integrating a portal, or running a headless engine, the API is here and open for you to use.

Note

Before developing, be sure to read our Best Practices Guide to set yourself up for success!

Authentication

Every API request to BigID must be authenticated. Learn how to securely manage sessions and tokens.

User Authentication

Learn how to authenticate using a standard Username and Password.

Token Authentication

Learn how to authenticate using long-lived API tokens.

Tutorials & Workflows

Learn how to use BigID programmatically through a series of step-by-step tutorials covering commonly automated tasks.

Manage Data Sources

Learn how to create and manage data sources automatically.

Manage Scan Profiles

Configure and execute system scans via API.

Execute DSARs

Trigger and retrieve Data Subject Access Requests.

Export Metadata

Export classification and object metadata to external tools.

Scan Data in Motion

Analyze streaming data from tools like Kafka and Kinesis.

Scan Payload

Send unstructured text directly to BigID for immediate classification.

Find Duplicate Data

Identify and eliminate redundant files across your ecosystem.