> ## Documentation Index > Fetch the complete documentation index at: https://openmetadata-format-2-0-connector-overview-pages.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # REST API Connector | OpenMetadata Integration Documentation > Learn how to integrate REST APIs with OpenMetadata connectors. Complete documentation, setup guides, and examples for seamless data source connections. export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => { const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0; const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []]; return
{icon &&
{name}
}

{name}

{stage}
{showSubHeading &&
Feature List
{totalAvailableFeatures.map(feature =>
✓ {feature}
)} {unavailableFeatures.map(feature =>
✕ {feature}
)}
}
; }; In this section, we provide guides and references to use the OpenAPI/REST connector. Configure and schedule REST metadata workflows from the OpenMetadata UI: * [Requirements](#requirements) * [Metadata Ingestion](#metadata-ingestion) * [Troubleshooting](/v2.0.x-SNAPSHOT/connectors/api/rest/troubleshooting) ## Requirements Before configuring the REST connector, make sure the following requirements are in place. ### Configure the OpenAPI Schema URL 1. Generate an [OpenAPI specification](https://swagger.io/specification/#openapi-document) for the service. 2. In the REST service connection form, enter the **OpenAPI Schema URL**. 3. Provide an HTTP or HTTPS URL that is reachable from the ingestion environment and points directly to the schema file. 4. Optional: Enter a **Token** if the URL requires authentication. #### Supported Formats The connector supports these schema formats: * JSON (`.json`) * YAML (`.yaml` or `.yml`) ## Metadata Ingestion To ingest metadata from REST, you need to create a service connection. The service connects REST with OpenMetadata. Once you create a service, OpenMetadata automatically starts ingesting metadata. ### Step 1: Add New Service 1. Navigate to **Settings** > **Services**. Navigate to Settings and Services 2. Click **Add New Service**. Add New Service ### Step 2: Select a Service and Connector From the service type dropdown, select **API Services**, then click the **REST** connector tile. Select Service ### Step 3: Add Service Name and Description * Enter a unique, descriptive **Service Name**. OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other REST services you are ingesting metadata from. * Optional: Enter a **Description** for the service. Add New Service Name **Note**: The service name cannot be changed after it is set. ### Step 4: Configure Connection Options Specify your source credentials and verify the connection. #### Enter Connection Details Enter the connection details for REST. The right-hand panel in the UI displays inline help for each field. Configure Service Connection * **OpenAPI Schema URL**: An OpenAPI schema URL typically refers to the URL where the OpenAPI Specification (OAS) document of a web service is hosted. The document defines the service's API, including available endpoints, request/response formats, authentication methods, and so on It is usually in JSON format, for example `https://petstore3.swagger.io/api/v3/openapi.json`. * **Token**: An authentication token to connect to an OpenAPI schema URL. It is only required if the API schema is protected or secured. #### Test Connection Once the credentials have been added, click on **Test Connection** and **Save** the changes. Test Connection ### Step 5: Configure Ingestion Options In the **What to Ingest** step, use filter patterns to control which assets OpenMetadata ingests from your API service. Filter patterns use regular expressions applied to collection names. #### How Filter Patterns Work * **Include**: Add one or more comma-separated regular expressions. OpenMetadata ingests only assets whose names match at least one expression. Leave blank to include all assets. * **Exclude**: Add one or more comma-separated regular expressions. OpenMetadata skips any asset whose name matches an expression. Leave blank to exclude nothing. Rules match asset names using one of five expressions: * **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`. * **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`. * **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`. * **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`. * **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`. When both Include and Exclude are set, Exclude takes priority. Leave the filter pattern empty to ingest all API collections and their endpoints available in the source. **Filter Options** The API Collection section includes the following filter options: * **API Collection**: Controls which API collections (groups of endpoints defined in an OpenAPI specification) OpenMetadata ingests from the source. Each section provides the following controls: * **Scan Mode**: You can choose between the following scan modes: * **Scan all**: Ingests every asset of that type the connector can access. This is the default. * **Only specific**: Enables include rules so only assets matching at least one rule are ingested. * **Exclude system toggle**: Use this toggle to automatically filter out system-reserved names defined by the connector, for example, **Exclude system databases** for the Databases section. * **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules. * **Preview**: Shows a real-time summary of what will be in scope based on your current rules. * **Include rules** *(available only in **Only specific** mode)*: Click **+ Add** to define a rule. Added rules appear as chips; an asset is included if it matches any rule. ### Step 6: Create & Deploy Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. OpenMetadata saves the service configuration and immediately begins pulling metadata from the source. To monitor ingestion progress or view the service you just added, go to **Settings** > **Services** and select your service. ## Configure Metadata Agent and Schedule Ingestion The **Metadata Agent** extracts API collections, endpoints, and other structural metadata from your source and keeps your OpenMetadata catalog in sync. It powers discovery, lineage, and governance across your data assets. When you click **Create & Deploy**, OpenMetadata automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page. To configure the additional Metadata Agent and schedule ingestion, follow these steps: 1. Navigate to **Settings** > **Services** and select the service type. Navigate to Settings and Services 2. Click the service you have added. 3. Select the **Agents** tab and click **Add Agent** > **Metadata**. Add Metadata Agent For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page. 4. On the **Configure Ingestion** page, do the following and click **Next**. * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline. Name this Ingestion * **Filter Patterns**: Apply include or exclude rules to scope which API collections and endpoints this agent ingests. These follow the same filter options described in **Step 5: Configure Ingestion Options**. Filter Patterns * **Scope & Behaviour**: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs: | Toggle | Default | Description | | ---------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Mark Deleted API Collections | On | Soft-delete API collections in OpenMetadata when they are removed from the source. Associated entities like lineage are also deleted. | | Override Metadata | Off | When on, source values overwrite existing descriptions, tags, owners, and display names in OpenMetadata. When off, OpenMetadata only updates fields that have no existing value. | | Enable Debug Log | Off | Sets the ingestion log level to DEBUG. Useful for troubleshooting. | Scope & Behaviour 5. On the **Schedule Interval** page, set when the agent runs: * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression. * **On-Demand**: No automatic schedule; trigger the agent manually when needed. Schedule Interval 6. Click **Add** to deploy the agent. ## Related Learn more about how to configure the Usage Workflow to ingest Query information from the UI. Learn more about how to configure the Lineage from the UI. Learn more about how to configure the Data Profiler from the UI. Learn more about how to configure the Data Quality tests from the UI. Learn more about how to ingest dbt models' definitions and their lineage.