OCF Data Sources API Overview

Description

This API can be used for OCF data source operations such as:

  1. Creating a data source
  2. Deleting a data source
  3. Changing or updating data source details
  4. Running configuration checks
  5. Setting up and running metadata extraction
🚧

Important:

  • This API does not support AWS Glue, Google BigQuery (GBQ), and Hive data sources.
  • This v2 API is strictly for data sources managed by OCF (Open Connector Framework) connectors. To work with legacy native data sources, see v1 [Native Data Sources API].

Open API 3.0 Specification

The Data Sources API is described using the OpenAPI 3.0 Specification (OAS). OAS is a broadly adopted industry standard for describing APIs.

To see the specification, replace {AlationInstanceURL} below with your Alation instance's URL and visit the link:

{AlationInstanceURL}/openapi/ocf_datasources/
📘

Note:

The Swagger UI is not enabled by default on an Alation instance. Please set the flag alation.feature_flags.enable_swagger to True using alation_conf.