Skip to main content

Collibra

Collibra is a data catalog platform and tool that helps organizations better understand and manage their data assets.

Collibra icon

Power end-to-end data operations for your Collibra API with Nexla. Our bi-directional Collibra connector is purpose-built for Collibra, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Collibra or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Collibra workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Collibra credential, you need to obtain authentication credentials from your Collibra account. Collibra uses Basic Authentication with a username (or personal API key) and password combination to authenticate API requests.

To use Collibra with Nexla, you need:

  • Access to your Collibra account
  • A Collibra account with appropriate permissions to access the resources you want to work with
  • Your username or personal API key for Basic Authentication
  • Your password for Basic Authentication
  • Your Collibra environment URL

The Collibra API requires your environment URL, which is the base URL of your Collibra instance (e.g., https://your-instance.collibra.com). For detailed information about Collibra authentication, credential setup, and available resources, refer to the Collibra API documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
Username Or API KeyYesNoYour username or personal API Key
PasswordYesYesYour password.
Environment URLYesNoYour Environment URL.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Collibra

CollibraCred.png
  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  2. Enter your Collibra username or personal API key in the Username Or API Key field. This is the username or personal API key associated with your Collibra account that will be used for Basic Authentication.

  3. Enter your Collibra password in the Password field. This is the password associated with your Collibra account that will be used together with the username or API key for Basic Authentication.

  4. Enter your Collibra environment URL in the Environment URL field. This should be the base URL of your Collibra instance, including the protocol (https://) but without any trailing slashes (e.g., https://your-instance.collibra.com). The environment URL is used to construct all API endpoint URLs.

    Keep your authentication credentials secure and do not share them publicly. The credentials provide access to your Collibra account and should be treated as sensitive information. Basic Authentication credentials are sent in the Authorization header for all API requests to the Collibra API. The environment URL determines which Collibra instance your credential will access. For detailed information about obtaining and managing credentials, see the Collibra API documentation.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Collibra connector tile, then select the credential that will be used to connect to the Collibra instance, and click Next; or, create a new Collibra credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Collibra endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Search Views

This endpoint lists all search views in the account. Use this endpoint when you need to access search view information, search configurations, or available search views in your Collibra account.

  • This endpoint automatically retrieves all search views from your Collibra account. No additional configuration is required beyond selecting this endpoint template.
  • The endpoint uses GET requests to https://{environment_url}/rest/2.0/search/views where {environment_url} is your Collibra environment URL from the credential configuration. The endpoint URL is automatically constructed based on your credential's environment URL configuration.
  • The endpoint does not use pagination and returns all search views in a single request.
  • The endpoint will return all search views in your account. The response data is extracted from the results array in the API response ($.results[*]), with each search view record processed individually.

The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $.results[*], which extracts all items from the results array in the API response. For detailed information about listing search views, see the Collibra API documentation.

Search

This endpoint performs a search and returns a list of resources which meet the search criteria defined in the request body. Use this endpoint when you need to search for specific resources, assets, or data elements in your Collibra account based on custom search criteria.

  • Enter the search criteria in the Search criteria field. This should be a JSON payload that defines the search parameters, filters, and criteria for the search operation. The search criteria should follow the Collibra API specification for search requests.

  • Select the API version number from the Version Number dropdown menu. Available options are:

    • 2.0: Collibra API v2.0 (default, recommended)
    • 1.0: Collibra API v1.0 (legacy)

    You can also add custom version numbers if needed. The default value is 2.0 if not specified.

  • The endpoint uses POST requests to https://{environment_url}/rest/{version_number}/search where {environment_url} is your Collibra environment URL and {version_number} is the selected API version. The endpoint URL is automatically constructed based on your credential's environment URL configuration and the selected version number.
  • The endpoint uses offset-based pagination, automatically fetching additional pages as needed using the offset and limit query parameters. The endpoint starts from offset 0 and continues fetching pages until all available results have been retrieved. By default, the endpoint retrieves up to 20 items per page.
  • The endpoint will return all resources matching the search criteria. The response data is extracted from the results array in the API response ($.results[*]), with each resource record processed individually.

The search criteria must be properly formatted JSON that matches the Collibra API specification for search requests. This endpoint supports pagination through offset and limit query parameters. Nexla automatically handles pagination to retrieve all available records by incrementing the offset until no more data is returned. The endpoint uses offset-based pagination (iteration.type: paging.incrementing.offset), starting from offset 0. By default, the endpoint retrieves up to 20 items per page (page.expected.rows: 20). The response data path is $.results[*], which extracts all items from the results array in the API response. For detailed information about performing searches, see the Collibra API documentation.

Read Sample Data

This endpoint reads the available sample data from the Collibra cloud repository or Edge cache depending on how the data is collected. Use this endpoint when you need to access sample data, data previews, or data samples for specific assets in your Collibra catalog.

  • Enter the asset ID for which you want to retrieve sample data in the Asset ID field. This is the unique identifier of the asset in your Collibra catalog for which you want to read sample data.

  • The endpoint uses GET requests to https://{environment_url}/rest/catalogSampling/v1/samples/{asset_id} where {environment_url} is your Collibra environment URL and {asset_id} is the asset ID you provide. The endpoint URL is automatically constructed based on your credential's environment URL configuration and the provided asset ID.
  • The endpoint does not use pagination and returns the complete sample data in a single request.
  • The endpoint will return sample data for the specified asset. The response data is extracted from the root-level object in the API response ($), and Nexla will process the entire response structure.

Asset IDs can be obtained from other Collibra API endpoints, such as the Search endpoint, which returns assets with their corresponding IDs. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $, which extracts the entire root-level object from the API response. For detailed information about reading sample data, see the Collibra API documentation.

List Catalog Database Details

This endpoint lists catalog database details from the API endpoints. Use this endpoint when you need to access database metadata, database configurations, or database details from your Collibra catalog.

  • Enter the resource type you want to retrieve in the Resource Type field. This should be the type of catalog database resource you want to list (e.g., databases, schemas, tables). The resource type determines which catalog database details will be retrieved.

  • The endpoint uses GET requests to https://{environment_url}/rest/catalogDatabase/v1/{resource_type} where {environment_url} is your Collibra environment URL and {resource_type} is the resource type you provide. The endpoint URL is automatically constructed based on your credential's environment URL configuration and the provided resource type.
  • The endpoint does not use pagination and returns all catalog database details for the specified resource type in a single request.
  • The endpoint will return all catalog database details for the specified resource type. The response data is extracted from the results array in the API response ($.results[*]), with each database detail record processed individually.

Resource types should match the Collibra catalog database API specification. Common resource types include databases, schemas, tables, and columns. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $.results[*], which extracts all items from the results array in the API response. For detailed information about listing catalog database details, see the Collibra API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Collibra data sources can also be manually configured to ingest data from any valid Collibra API endpoint, including endpoints not covered by the pre-built templates or endpoints that require chained API calls or custom parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Collibra API endpoints typically follow the pattern https://{environment_url}/rest/{version}/{endpoint_path}, where {environment_url} is your Collibra environment URL. Basic Authentication is handled automatically based on your credential configuration. Collibra API responses typically use a results array ($.results[*]) for list endpoints, or a root-level object ($) for single-resource endpoints.

Once all configuration steps have been completed, click the Save button to save and create the new Collibra data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Collibra destination, and select the Send to Destination option from the menu. Select the Collibra connector from the list of available destination connectors, then select the credential that will be used to connect to the Collibra organization, and click Next; or, create a new Collibra credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Collibra endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Catalog Database Resources

This endpoint creates resources in the catalog database. Use this endpoint when you need to create database metadata, schema configurations, or database resources in your Collibra catalog.

  • Enter the resource type you want to create in the Resource Type field. This should be the type of catalog database resource you want to create (e.g., databases, schemas, tables). The resource type determines which catalog database resource will be created.

  • The endpoint uses POST requests to https://{environment_url}/rest/catalogDatabase/v1/{resource_type} where {environment_url} is your Collibra environment URL from the credential configuration and {resource_type} is the resource type you provide. The endpoint URL is automatically constructed based on your credential's environment URL configuration and the provided resource type.
  • The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the catalog database resource data to create. The request body should follow the Collibra API specification for creating catalog database resources, including required fields and field names.
  • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a catalog database resource. If you need to create multiple resources, you can send multiple records, but each will be processed as a separate request.

Resource types should match the Collibra catalog database API specification. Common resource types include databases, schemas, tables, and columns. The request body must be properly formatted JSON that matches the Collibra API specification for creating catalog database resources. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating catalog database resources, including required fields, field names, and request formats, see the Collibra API documentation.

Create Resources for Catalog Integration

This endpoint allows you to create your own integrations with Collibra Data Governance Center. Use this endpoint when you need to create custom resources, assets, or data governance objects in your Collibra account from your data sources.

  • Enter the resource type you want to create in the Resource Type field. This should be the type of resource you want to create in Collibra (e.g., assets, domains, communities). The resource type determines which Collibra resource will be created.

  • Select the API version number from the Version Number dropdown menu. Available options are:

    • 2.0: Collibra API v2.0 (default, recommended)
    • 1.0: Collibra API v1.0 (legacy)

    You can also add custom version numbers if needed. The default value is 2.0 if not specified.

  • The endpoint uses POST requests to https://{environment_url}/rest/{version_number}/{resource_type} where {environment_url} is your Collibra environment URL, {version_number} is the selected API version, and {resource_type} is the resource type you provide. The endpoint URL is automatically constructed based on your credential's environment URL configuration and the provided parameters.
  • The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the resource data to create. The request body should follow the Collibra API specification for creating resources, including required fields and field names.
  • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a resource. If you need to create multiple resources, you can send multiple records, but each will be processed as a separate request.

Resource types should match the Collibra Core REST API specification. Common resource types include assets, domains, communities, attributes, and relations. The request body must be properly formatted JSON that matches the Collibra API specification for creating resources. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating resources for catalog integration, including required fields, field names, and request formats, see the Collibra API documentation.

Manual configuration

Collibra destinations can also be manually configured to send data to any valid Collibra API endpoint not covered by the pre-built templates. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, and request body.

Collibra API endpoints typically follow the pattern https://{environment_url}/rest/{version}/{endpoint_path}, where {environment_url} is your Collibra environment URL. The Collibra API primarily uses POST requests for data-writing operations, and the Content-Type: application/json header is set automatically for JSON request bodies. Batch mode is disabled by default, so each record is sent as a separate request. Basic Authentication is handled automatically based on your credential configuration.

Save & activate

Once all endpoint settings have been configured, click the Save button to save and create the destination. To send the data to the configured Collibra endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Collibra endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.