Build custom solutions that enable data intelligence across your enterprise
Collibra APIs
Getting started
Learn the basics of the REST standard, the different REST applications Collibra provides.
Using the Collibra APIs, you can build custom solutions that enable data intelligence across your enterprise. Whether creating applications to automate business processes, transform data, or communicate with external clients, the APIs help you build seamless solutions on top of the Collibra platform.
API first
Collibra is an API first company. It is our guarantee to treat our APIs as first-class products so you can focus on building quality applications and integrations on top of Collibra Data Intelligence Cloud.
API visibility
The Collibra Data Intelligence Platform exposes public APIs so you can build extensions. The APIs are safe, easy to use, and backwards/forwards compatible within the same major release. If a break does occur, it will only happen in the next major release and you will receive a deprecation message ahead of time.
You can find a list of APIs and documentation in your environment at https://<your_collibra_url>/docs/index.html.
For workflows, we also consider the following libraries as public:
- Java.time.**
- Java.math.**
- Java.lang.**
- Java.text.**
- Groovy.**
We also use specific APIs internally to build our platform. These APIs are private and are intended for our use only. It is important to note that these APIs are not publicly documented and can break at any time.
API technologies
The Collibra platform provides three main technologies for public APIs:
- Java APIs.
- REST APIs.
- GraphQL APIs.
The Java APIs are exclusively available through Collibra workflows and allow you to build and interact with your governance processes. Java API scripts run on the same Java Virtual Machine (JVM) as the product and can impact the overall platform performance. Avoid using workflow scripts in for heavy processes.
Collibra provides public REST APIs that allow you to integrate with your organization’s technology. Using your favorite language, you can create, update, and retrieve data, write complex scripts, or build friendly user interfaces.
The REST APIs are documented following the OpenAPI Specification 3.0. They are language agnostic and you can use them to generate clients that interact with your data. Each API endpoint has the following characteristics:
- Stateless: No context is stored and each client must provide all the necessary information to service the request.
- Cacheable: The client's intermediary can cache the responses.
- Uniform interface: All responses are provided as JSON.
Temporary files used by the APIs for processing are available for 8 hours, unless they are actively being used by a long running process.
User guides
The Hitchhiker’s Guide to the Output Module
The Output Module is a lightweight graph query engine exposed through the public API. It allows different output formats, such as JSON, XML, Excel, and CSV. It also provides a single API to query most of the Collibra entities, such as assets, communities, domains and types, using SQL-like filtering capabilities. You can sort entities using any of the available properties and page results and view permissions for authenticated users who issue REST calls.
Import API documentation
Learn about the basic building blocks of the Collibra REST Import API, which allows you to create or edit data in bulk in Collibra Data Intelligence Cloud. By importing, you can create and edit communities, domains, assets, mappings or complex relations and their characteristics such as attributes, relations and tags.
Knowledge Graph API documentation
Meet the Knowledge Graph API, a new GraphQL API, which simplifies the retrieval of Knowledge Graph data, including communities, domains, assets, and complex relations, in a synchronous manner. You can also sort entities using any of the available properties and page the results.
SCIM documentation
The System for Cross-domain Identity Management (SCIM) is an open standard formulated to oversee user and group identity information in a seamless manner. Collibra has developed SCIM capabilities to align with industry standards.
APIs
Core REST API (Version 2)
The Core API is the main entry point to interact with your Collibra Data Intelligence Cloud environment. Create, update or delete all resources such as users, assets, domains or trigger workflows.
Import REST API (Version 2)
The Import API is an efficient way to load large volumes of data into Collibra Data Intelligence Cloud. The API can automatically differentiate between creating and updating data.
Search REST API (Version 2)
The Search API allows you to create your own integration with Collibra Search Engine. Find your data!
Catalog REST API (Version 1)
The Catalog API offers functionality related to the catalog product. It is mainly focused on facilitating the ingestion of information into Catalog. The API enables users to more easily connect Catalog to sources that are not necessarily natively supported in the product.
Catalog Data Classification REST API (Version 1)
The Catalog Data Classification API allows classifying datasets, databases, schemas, tables or columns based on sample data. Additionally, the API facilitates searching and managing the data classification labels available in the product.
Catalog Data Classification REST API (Version 2)
Version 2 of the Catalog Data Classification API offers functionality related to the classification process and facilitates searching for and managing the associations between a data class and a data category. Use version 1 of the API for managing classifications and legacy data classes.
Catalog Database Registration REST API (Version 1)
This API allows you to manage the metadata ingestion, profiling, and classification of databases via Edge.
Catalog Sampling REST API (Version 1)
This API allows you to use sample data. Via the API, you can request samples from an Edge data source and temporarily add them in the Edge cache, and you can read the samples available in the Collibra Data Intelligence Cloud repository or the Edge cache.
Catalog Cloud Ingestions REST API (Version 1)
This API allows you to handle synchronizations with external cloud systems.
Catalog External Profiling Upload REST API (Version 1)
This API allows you to manually push profiling data.
Catalog Technical Lineage REST API (Version 1)
This API allows you to interact with technical lineage functionality.
Collibra Assessments API (Version 1)
This API allows you to interact with the Assessments application in a programmatic way and perform actions such as retrieving data from conducted assessments or triggering new assessments.
Collibra Protect REST API (Version 1)
This API allows you to manage groups for the purpose of creating data access rules.
Collibra Protect Partner API (beta)
This API allows you to retrieve the data access rule set it needs to synchronize.
Management Console REST API (Version 1)
The Console REST API allows you to manage your backups, configuration, and environment. Create your own UI or script and get the most of your Collibra Console!
Knowledge Graph GraphQL API
The Knowledge Graph API is a lightweight graph query engine based on industry-standard GraphQL language. It provides a single API to query most of the Collibra entities, such as assets, communities, domains and types, using SQL-like filtering capabilities.
Tutorial highlights
REST API authentication with JSON Web Token
Check the prerequisites for JSON Web Token (JWT) authentication with Collibra Data Intelligence Cloud, obtain the access token and test the authentication.
Getting started with the Search API
Perform your first query with the Collibra REST Search API, use wildcards to expand your search and filters to refine it.
Getting started with the Import API
Learn about the basic building blocks of the Collibra REST Import API: the JSON file format, the identifiers and the import commands.
Getting started with the REST API
Learn the basics of the REST standard, the different REST applications Collibra provides, where to find the general documentation and how to use it.
Collibra REST API authentication
Install Postman, an API Development Environment, and learn how to log in and out of Collibra Data Governance Center as well as how to verify if your current session is authenticated.
Create data with Collibra REST API
Create a community, a domain, some assets and definitions in Collibra Data Governance Center using the Collibra REST API.