API Tools

The following tools and code sample libraries let you use the Fivetran REST API in a more efficient and easy way:

• Fivetran REST API Postman collection
• Fivetran Iceberg REST Catalog Postman collection
• Fivetran provider for Apache Airflow
• Fivetran provider for Terraform
• Fivetran Webhooks project

Postman collections

Postman is a very popular and convenient API client that makes it easy for developers to create, share and test API requests. We provide the following Postman collections:

• Fivetran REST API Postman collection - this collection provides request templates to help you create API calls for all endpoints supported by Fivetran
• Fivetran Iceberg REST Catalog Postman collection - this collection is designed to get metadata from tables stored in your Fivetran Iceberg REST Catalog.

Fivetran REST API Postman collection

You can use Fivetran REST API Postman collection to test API endpoints within your account. The collection contains templates to help you create API calls for all endpoints supported by Fivetran.

To use our REST API Postman collection:

1. Download and install Postman.

2. Download and then import our REST API Postman Collection.

   Log in to your Postman account prior to starting the collection import.

   

   Once the collection is imported, the following API requests will appear on the Collections tab.

   

3. Configure the authorization in Postman.

   i. Hover over the imported Fivetran REST API collection.

   ii. Click the menu icon ( ... ).

   iii. Click Edit in the displayed menu. The Edit Collection page opens.

   iv. Select the Variables tab.

   v. Specify your API key and secret in unencoded format in the corresponding Current Value fields. You can find them in your Fivetran account settings. See our REST API documentation to learn how to get your API key and secret. Postman encodes the API key and secret to base64 when calling an endpoint.

   vi. Click Save to save the changes.

   

   Don't share your key and secret. Remember that the exported collection may contain sensitive information in its parameters.

When you complete the collection import and configuration, you will be able to run the API requests. Most of the requests require path or payload parameters that are enclosed in {}. You need to populate the parameters according to your needs.

Fivetran Iceberg REST Catalog Postman collection

To use our Fivetran Iceberg REST Catalog Postman collection:

1. Download and install Postman.

2. Download and then import our Fivetran Iceberg REST Catalog Postman collection.

   Log in to your Postman account prior to starting the collection import.

   

   Once the collection is imported, the relevant API request templates will appear on the Collections tab.

3. Define the authorization parameters.

When you complete the collection import and configuration, you will be able to run the API requests. Most of the requests require path or payload parameters that are enclosed in {}. You need to populate the parameters according to your needs.

Authorization

1. Open the collection and set variables. In the collection’s Variables tab, fill in:

   • client_id – your OAuth client ID
   • client_secret – your OAuth client secret
   • catalog_id – the catalog you want to query
   • base_url – keep the default https://polaris.fivetran.com/api/catalog/v1
   • auth_url – keep the default https://polaris.fivetran.com/api/catalog/v1/oauth/tokens (These variable names and defaults are already defined in the collection.)

2. Set the grant type and token endpoint.

   i. Go to Fivetran Iceberg REST Catalog > Auth or to List Namespaces > Authorization. ii. Set the parameters:

   • Type: OAuth 2.0
   • Grant Type: Client Credentials
   • Access Token URL: {{auth_url}} (defaults to the Polaris OAuth token endpoint shown above).

3. Provide client credentials:

   • Client ID: {{client_id}}
   • Client Secret: {{client_secret}}
   • Client Authentication: Send as Basic Auth header (Postman will send Authorization: Basic base64(client_id:client_secret) to the token endpoint).
   • Scope: PRINCIPAL_ROLE:ALL (already present in the collection’s OAuth settings).

4. Define the authorization header:

   • Add token to: Header
   • Header Prefix: Bearer (Postman will send Authorization: Bearer <token> with API requests.

5. Click Get New Access Token. Postman requests a token from {{auth_url}} using the Client Credentials flow.

6. Click Use Token.

   • You do not need a refresh token for this flow; when the token expires, repeat Get New Access Token.

   • Keep child requests set to Inherit auth from parent. In this collection, Show Tables In Namespace and Show Table Metadata are designed to inherit from the parent (the authorization is defined on the parent List Namespaces in your setup).

Fivetran provider for Apache Airflow

Apache Airflow is an open-source workflow management platform for data engineering pipelines that lets you programmatically author, schedule, and monitor workflows.

Providers are plugins that you can add to your configuration and use the resources of cloud platforms and services to provision infrastructure.

We have partnered with Astronomer to support an open-source async Fivetran provider for Airflow. If you have a provider-specific issue, raise an issue on the Github repo. If you have a Fivetran-related issue, create a support ticket.

See the Fivetran provider for Apache Airflow for details.

Our previous provider will be deprecated. See our migration guide.

Fivetran provider for Terraform

Terraform is an infrastructure-as-code (IaC) software tool that provides a command-line interface (CLI) workflow to manage cloud services. Terraform codifies cloud APIs into declarative configuration files.

Providers are plugins that you can add to your configuration and use the resources of cloud platforms and services to provision infrastructure.

See the Fivetran provider for Terraform page for details.

Fivetran Webhooks project

Webhooks are automated notifications sent from an application when an event occurs. Our webhooks test project is a simple example that demonstrates how to ingest webhooks from Fivetran.