Immuta V2 API
Policy as code benefits
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.)
Authentication
Before using the Immuta API, users need to authenticate with an API key. To generate an API key, complete the following steps in the Immuta UI.
Click your initial in the top right corner of the screen and select Profile.
Go to the API Keys tab and then click Generate Key.
Complete the required fields in the modal and click Create.
Pass the key that is provided in the Authorization header:
Endpoints and details
All of the API endpoints described below take either JSON or YAML, and the endpoint and payload are the same for both creating and updating data sources, policies, projects, and purposes.
Create a data source
The V2 API is built to easily enable an “as-code” approach to managing your data sources, so each time you POST data to this endpoint, you are expected to provide complete details of what you want in Immuta. The two examples below illustrate this design:
Through this endpoint, you can create or update all data sources for a given schema or database.
POST /api/v2/data
Query parameters
Payload
Request payload examples
Create a policy
POST /api/v2/policy
Requirements:
Immuta permission
GOVERNANCE
Query parameters
Payload
Request payload examples**
Data Policies:
Create a project
POST /api/v2/project
Query parameters
Payload
Request payload examples
Create a purpose
POST /api/v2/purpose
Query parameters
Payload
Request payload examples
Best practices
Last updated