Skip to content

You are viewing documentation for Immuta version 2024.1.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

Integrations API Reference Guides

The reference guides in this section define the integrations API endpoints, request and body parameters, and response schema.

Integrations API endpoints

The integrations API endpoints allow you to create, update, get, and delete integrations and generate scripts to run in your data platform to manually set up or remove Immuta-managed resources.

Consult this guide for endpoint descriptions and examples.

Integrations API payloads and objects

The integrations API request payloads accept JSON or YAML format, and each integration has parameters and objects specific to the data platform.

Consult this guide for parameter value types, requirements, definitions, and accepted values.

Response schema

The response returns the status of the integration configuration in JSON format.

Consult this guide for response schema definitions and integration state definitions.

HTTP status codes and error messages

The integrations API uses standard HTTP status codes. Status codes specific to the integrations API are described in this reference guide.

Consult this guide for a list of status codes, integration states, common error messages, and troubleshooting guidance.