Skip to main content
REST

REST

BETA
Feature List
✓ API Endpoint
✓ Request Schema
✓ Response Schema
In this section, we provide guides and references to use the OpenAPI/REST connector. Configure and schedule REST metadata workflows from the OpenMetadata UI:

​
How to Run the Connector Externally

To run the Ingestion via the UI you’ll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

External Schedulers

Get more information about running the Ingestion Framework Externally

​
Requirements

​
Python Requirements

We have support for Python versions 3.9-3.11

​
Generate OpenAPI Schema URL

Provide a publicly accessible URL that points directly to your service’s OpenAPI specification file.

​
Supported Formats

  • JSON (.json)
  • YAML (.yaml or .yml)

​
Metadata Ingestion

​
1. Define the YAML Config

This is a sample config for OpenAPI:

​
2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run: 
metadata ingest -c <path-to-yaml>
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.