The Immuta API
Audience: All Immuta Users
Content Summary: This page provides an overview of both versions of the Immuta API.
Undocumented API Endpoints and Attributes
Any endpoints or attributes that are not documented are for internal purposes and should not be used.
Version 2 API
Version 2 of the API allows Data Engineers to manage their data sources, projects, and policies as code, providing a way to track, approve, and easily update data sources and their associated policies.
The benefits of the V2 API are outlined below:
Reduces Complexity. The data source API has been simplified to only require the connection information in most instances and one endpoint for all database technologies.
Maintains Less State. Whether updating or creating, the same endpoint is used, and the same data is passed. No IDs are required, so no additional state is required.
Requires Fewer Steps. Only an API key is required; no additional authentication step is required before using the API.
Integrates with Git. Define data sources and policies in files that can be tracked in Git and easily pushed to Immuta. Both JSON and YAML are supported for more flexibility. (For example, use YAML to add comments in files.)
Version 1 API
Version 1 of Immuta's API is still supported and can be accessed through the Immuta CLI. However, users are encouraged to use Version 2 of Immuta's API because of all the benefits outlined above.
- V2 API: This section includes an overview of the V2 API, its endpoint details, and example requests, payloads, and responses.
- V1 API: This section includes an overview of the V1 API, its endpoint details, and example requests, payloads, and responses.