> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt > Use this file to discover all available pages before exploring further. # REST API Hybrid Runner > Connect REST APIs to Collate using the Hybrid Runner. Deploy the ingestion agent in your environment for secure, private network metadata extraction. 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}
)}
}
; }; This section provides guides and references to use the OpenAPI/REST connector. Configure and schedule REST metadata workflows from the Collate UI: * [Requirements](#requirements) * [Metadata Ingestion](#metadata-ingestion) * [Troubleshooting](/ai-2-0/connectors/api/rest/troubleshooting) ## Requirements Configure the schema source and file format before creating the REST service. ### 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, select **OpenAPI Schema URL**. 3. In **OpenAPI Schema URL**, enter an HTTP or HTTPS URL that is reachable from the configured ingestion runner and points directly to the schema file. 4. **Optional:** In **Token**, enter a bearer token if the URL requires authentication. #### Supported Formats The connector supports these schema formats: * JSON (`.json`) * YAML (`.yaml` or `.yml`) ### Configure an S3-Hosted Schema 1. In the REST service connection form, select **OpenAPI Schema S3 URL** when the OpenAPI schema is stored in Amazon S3, including when the object is private. 2. In **OpenAPI Schema S3 URL**, enter the HTTPS object URL in the following format: ```text theme={null} https://.s3..amazonaws.com/ ``` 3. In **AWS Region**, enter the bucket's Amazon Web Services (AWS) Region. 4. In the AWS credential configuration, choose the credential method used by the ingestion runner: * Enable AWS Identity and Access Management (IAM) authentication with **IAM Auth** to use the runner's default AWS credential provider chain, including a workload or instance role. * Configure an access key and secret. Include the session token when using temporary credentials. * Select a named AWS profile that is available in the runner environment. 5. **Optional:** In `assumeRoleArn`, enter the target role Amazon Resource Name (ARN) after selecting a source credential method. The target role's trust policy must allow the source principal. For cross-account role assumption, the source principal's identity policy must also allow `sts:AssumeRole`. For same-account role assumption, an identity policy is required unless the trust policy grants the source principal permission directly. Use the exact S3 object key in the URL. The connector recognizes `.json`, `.yaml`, and `.yml` extensions and detects the format of extensionless objects. Avoid percent-encoded characters in the object key because the connector passes the URL path to S3 without decoding it. The S3 source doesn't accept an `s3://` URI. The REST connector retrieves the object with the configured AWS credentials. For more information about the URL structure, see [Virtual Hosting of General Purpose Buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html). ### Configure S3 Access for the Hybrid Runner For a private schema object in the same AWS account as the effective ingestion principal, grant `s3:GetObject` through either the principal's identity policy or the bucket policy. For a cross-account schema object, configure both sides: 1. Grant the effective ingestion principal `s3:GetObject` on the exact schema object through an IAM identity policy. 2. Add a bucket policy granting the same principal `s3:GetObject` on the exact schema object: ```json theme={null} { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowHybridRunnerOpenAPISchemaRead", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam:::role/" }, "Action": "s3:GetObject", "Resource": "arn:aws:s3:::/" } ] } ``` If credentials resolve to an IAM user, use the user ARN as the principal and grant `s3:GetObject` through an identity policy. The `assumeRoleArn` setting selects AWS credentials but doesn't grant S3 access — the target role must have `s3:GetObject`. For cross-account S3 access, the bucket policy must also name the target role as the principal. If the schema object uses SSE-KMS encryption, grant `kms:Decrypt` on the key to the effective principal. Cross-account access requires a customer-managed key — `aws/s3` cannot be shared across accounts. ## Metadata Ingestion To ingest metadata from REST, you need to create a service connection. The service connects REST with Collate. Once you create a service, Collate automatically starts ingesting metadata. ### Step 1: Add New Service 1. In the left navigation, click **Connections**. 2. On the **Connections** page, 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**. Collate 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 where ingestion runs, provide your source credentials, and verify the connection. #### Select Ingestion Runner Select an **Ingestion Runner**: the runner where the ingestion pipeline will execute. Add Name and Select Ingestion Runner #### 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**: HTTP or HTTPS URL pointing directly to your OpenAPI schema file (for example `https://petstore3.swagger.io/api/v3/openapi.json`). * **OpenAPI Schema S3 URL**: HTTPS S3 object URL when the schema is stored in S3. Configure AWS Region and credentials alongside it. * **Token** (optional): Bearer token if the schema URL requires authentication. **Tip**: When using a **Hybrid Ingestion Runner**, any sensitive credential fields—such as passwords, API keys, or private keys—must reference secrets using the following format: ``` password: secret:/my/database/password ``` This applies **only to fields marked as secrets** in the connection form (these typically mask input and show a visibility toggle icon). For more information about managing secrets in hybrid setups, see the [Hybrid Ingestion Runner Secret Management Guide](/ai-2-0/getting-started/lets-get-started/ingest-your-data/hybrid-ingestion-runner#manage-secrets) #### 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 Collate 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. Collate 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. Collate 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. **Tip**: 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) Collate 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. **Tip**: If [AutoPilot](/ai-2-0/admin-guide/applications/autopilot) is enabled, usage tracking, data lineage, and other downstream workflows start automatically after the first metadata ingestion completes. ### Step 6: Create & Deploy Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. Collate 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 **Connections** in the left navigation 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 Collate catalog in sync. It powers discovery, lineage, and governance across your data assets. When you click **Create & Deploy**, Collate 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. In the left navigation, click **Connections** and select your service. 2. Click the **Agents** tab. 3. Click **Add Agent** and select **Metadata** from the dropdown. 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**. 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 Collate 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 Collate. When off, Collate 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. ## Troubleshooting Learn more about how to troubleshoot common REST connector issues and resolve configuration or ingestion errors.