connector_types

Creates, updates, deletes, gets or lists a connector_types resource.

Overview

Name	connector_types
Type	Resource
Id	fivetran.metadata.connector_types

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The connector type identifier within the Fivetran system (example: google_ads)
name	string	The connector service name within the Fivetran system (example: Google Ads)
auth	string	Metadata for authorization fields (optional) (opaque JSON object)
config	string	Metadata for configuration fields (opaque JSON object)
connector_class	string	(standard, lite)
description	string	The description characterizing the purpose of the connector (example: Google Ads is an online advertising platform)
external_secrets_keys_config	string	(opaque JSON object)
icon_url	string	The icon resource URL (example: https:​//fivetran.com/integrations/google_ads/resources/google-ads.png)
icons	array	The set of additional icon resource URLs in different formats (.svg, .png). Updating this list is not a breaking change. The set of icon URLs or the icons themselves may be changed
link_to_docs	string	The link to the connector documentation (example: https:​//fivetran.com/docs/connectors/applications/google-ads)
link_to_erd	string	The link to the connector ERD (entity–relationship diagram) (example: https:​//docs.google.com/presentation/d/1f16zOPxwT1AXoOcNkvwT82ApKqU1yhtJ04f-73M91nw/embed)
service_status	string	The current availability status of the connector (general_availability, beta, private_preview, sunset, development) (example: general_availability)
service_status_updated_at	string (date-time)	The date (yyyy-MM-dd) the connector status was updated to the current availability status
supported_features	array
type	string	The connector service type (API, Dbt, Marketing, HumanResources, Finance, Productivity, Engineering, Support, Sales, Security, SuperConnectorTest, Free, File, Database, Events, Function, BITool, Warehouse, Log, Hvr) (example: Marketing)

list

Name	Datatype	Description
id	string	The connector type identifier within the Fivetran system (example: google_ads)
name	string	The connector service name within the Fivetran system (example: Google Ads)
connector_class	string	(standard, lite)
description	string	The description characterizing the purpose of the connector (example: Google Ads is an online advertising platform)
icon_url	string	The icon resource URL (example: https:​//fivetran.com/integrations/google_ads/resources/google-ads.png)
icons	array	The set of additional icon resource URLs in different formats (.svg, .png). Updating this list is not a breaking change. The set of icon URLs or the icons themselves may be changed
link_to_docs	string	The link to the connector documentation (example: https:​//fivetran.com/docs/connectors/applications/google-ads)
link_to_erd	string	The link to the connector ERD (entity–relationship diagram) (example: https:​//docs.google.com/presentation/d/1f16zOPxwT1AXoOcNkvwT82ApKqU1yhtJ04f-73M91nw/embed)
service_status	string	The current availability status of the connector (general_availability, beta, private_preview, sunset, development) (example: general_availability)
service_status_updated_at	string (date-time)	The date (yyyy-MM-dd) the connector status was updated to the current availability status
supported_features	array
type	string	The connector service type (API, Dbt, Marketing, HumanResources, Finance, Productivity, Engineering, Support, Sales, Security, SuperConnectorTest, Free, File, Database, Events, Function, BITool, Warehouse, Log, Hvr) (example: Marketing)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service		Returns metadata of configuration parameters and authorization parameters for a specified connector type.
list	select		cursor, limit	Returns all available source types within your Fivetran account. This endpoint makes it easier to display Fivetran connectors within your application because it provides metadata including the proper source name ('Facebook Ads' instead of 'facebook_ads'), the source icon, information about the Hybrid deployment support, and links to Fivetran resources. As we update source names and icons, that metadata will automatically update within this endpoint

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
service	string	[The connector type](https:​//fivetran.com/docs/rest-api/getting-started#commonterms) identifier within the Fivetran system
cursor	string	Paging cursor, [read more about pagination](https:​//fivetran.com/docs/rest-api/pagination)
limit	integer (int32)	Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

SELECT examples

get

Returns metadata of configuration parameters and authorization parameters for a specified connector type.

SELECT
id,
name,
auth,
config,
connector_class,
description,
external_secrets_keys_config,
icon_url,
icons,
link_to_docs,
link_to_erd,
service_status,
service_status_updated_at,
supported_features,
type
FROM fivetran.metadata.connector_types
WHERE service = '{{ service }}' -- required
;

list

Returns all available source types within your Fivetran account. This endpoint makes it easier to display Fivetran connectors within your application because it provides metadata including the proper source name ('Facebook Ads' instead of 'facebook_ads'), the source icon, information about the Hybrid deployment support, and links to Fivetran resources. As we update source names and icons, that metadata will automatically update within this endpoint

SELECT
id,
name,
connector_class,
description,
icon_url,
icons,
link_to_docs,
link_to_erd,
service_status,
service_status_updated_at,
supported_features,
type
FROM fivetran.metadata.connector_types
WHERE "limit" = '{{ limit }}'
;