Returns information about current account from API key.

⚠️ RESULTS ARE PAGINATED. Returns a list of all accessible connections within your Fivetran account.

⚠️ WRITE OPERATION - Confirm with user before calling. Creates a new connection within a specified group in your Fivetran account. Runs setup tests and returns testing results. > IMPORTANT: The destination_schema_names field will soon become a required field. Make sure to include it in your API requests when creating new connections to prevent future disruptions. > IMPORTANT: If you want to get the fingerprint details, do not set trust_fingerprints to true when you create a connection with our REST API. We can only provide the fingerprint details through the failed SSH Tunnel Connection setup test. For a full walkthrough, see Get Connection Fingerprint Details.

Returns a connection configuration and status details if a valid identifier was provided.

⚠️ WRITE OPERATION - Confirm with user before calling. Updates connection parameters for an existing connection within your Fivetran account. This endpoint requires at least one persistent configuration parameter to be specified (e.g., sync_frequency, paused, config, auth, daily_sync_time, schema_status). > IMPORTANT: Parameters like trust_certificates, trust_fingerprints, and run_setup_tests are test-control parameters that affect only the behavior of setup tests during the update and do not persist in the connection configuration; they cannot be used on their own. If you want to run setup tests without making configuration changes, use the POST /v1/connections/{connectionId}/test endpoint instead.

⚠️ DESTRUCTIVE - Confirm with user before calling. Deletes a connection from your Fivetran account.

⚠️ WRITE OPERATION - Confirm with user before calling. Generates the Connect Card URI for the connection

⚠️ WRITE OPERATION - Confirm with user before calling. Triggers a full historical sync of a connection or multiple schema tables within a connection. If the connection is paused, the table sync will be scheduled to be performed when the connection is re-enabled. If there is a data sync already in progress, we will try to complete it. If it fails, the request will be declined and the HTTP 409 Conflict error will be returned.

⚠️ IMPORTANT - If a table's parent schema is not enabled, the table will not be replicated. Check before telling the table the column is enabled. Returns the top-level schema configuration for an existing connection within your Fivetran account. The response includes global flags, every schema, each table, and only the columns that were explicitly overridden. Use this endpoint to read the current data-selection tree for a connection, to back up the schema before making edits, or to copy the configuration to another connection. > NOTE: To restore a backed-up schema or copy the configuration to another connection, use the Update a Connection Schema Config endpoint. For more information, see the Connection Schema config tutorial. > NOTE: Unedited columns (those following table defaults) are omitted from the response. For a real-time, exhaustive column list for a specific table, call the Retrieve Source Table Columns Config endpoint. For the NetSuite SuiteAnalytics, and Salesforce and Salesforce Sandbox connectors, the 'schemas' map field contains a single entry with the 'netsuite' or 'salesforce' key, respectively. For the 'schema.name_in_destination` name field, these connectors always return the destination schema name you set in the connection setup form. For more information on using this API endpoint with the the Oracle Fusion Cloud Applications connectors, see the Schema information documentation. > IMPORTANT: This endpoint does not apply to Magic Folder connectors.

⚠️ WRITE OPERATION - Confirm with user before calling. Updates the schema config for an existing connection within your Fivetran account. > NOTE: For backward compatibility, the response may contain the 'enable_new_by_default' boolean field. It defines whether new schemas and tables discovered in the source are synced. The value is 'true' if you specify 'ALLOW_ALL' as a value of 'schema_change_handling'. In the future API versions, we may remove this field. > > The response contains all known schemas and tables. Also, it contains columns whose state has ever been set by the user. For more information, see also the Connection Schema config tutorial.

⚠️ WRITE OPERATION - Confirm with user before calling. Mark multiple blocked columns for deletion from your destination tables. The columns will be dropped during the next sync.

⚠️ WRITE OPERATION - Confirm with user before calling. Reloads the connection schema config for an existing connection within your Fivetran account. > NOTE: This method reloads the full schema from the connection's data source. It may take a long time to complete the request. The method execution speed depends on the schema size and the number of databases, tables, and columns. > > The response contains all known schemas and tables. Also, it contains columns whose state has ever been set by the user. For more information, see also the Connection Schema config tutorial.

⚠️ WRITE OPERATION - Confirm with user before calling. Triggers a historical sync of all data for multiple schema tables within a connection. This action does not override the standard sync frequency you defined in the Fivetran dashboard.

⚠️ WRITE OPERATION - Confirm with user before calling. Updates the database schema config for an existing connection within your Fivetran account (for a single schema within a connection with multiple schemas). > NOTE: The response contains all known schemas and tables. Also, it contains columns whose state has ever been set by the user. For more information, see also the Connection Schema config tutorial. In this API call, the NetSuite SuiteAnalytics, Salesforce and Salesforce Sandbox connectors always return the schema name as 'netsuite' and 'salesforce', respectively. For more information about this API call for the Oracle Fusion Cloud Applications connectors, see our Schema information documentation.

⚠️ WRITE OPERATION - Confirm with user before calling. Updates the table config within your database schema for an existing connection within your Fivetran account. For the NetSuite SuiteAnalytics and Salesforce and Salesforce Sandbox connectors, the 'schemas' map field will always have a single entry with the 'netsuite' or 'salesforce' key, respectively.

⚠️ WRITE OPERATION - Confirm with user before calling. Updates the column config within your table for an existing connection within your Fivetran account. For the NetSuite SuiteAnalytics and Salesforce and Salesforce Sandbox connectors, the 'schemas' map field will always have a single entry with the 'netsuite' or 'salesforce' key, respectively. > NOTE: The response contains all known schemas and tables. Also, it contains columns whose state has ever been set by the user. For more information, see also the Connection Schema config tutorial.

⚠️ DESTRUCTIVE - Confirm with user before calling. Marks a blocked column for deletion from your destination table. The column will be dropped during the next sync. For the NetSuite SuiteAnalytics and Salesforce and Salesforce Sandbox connectors, the 'schemas' map field will always have a single entry with the 'netsuite' or 'salesforce' key, respectively.

⚠️ IMPORTANT - If a column's parent table or schema is not enabled, the column's data will not be replicated. Check before telling the user the column is enabled. Returns the real-time column list for one source table by querying the source. The response includes the current enabled and hashed flags, and the patchable fields. > NOTE: This endpoint works only for an existing connection that is in a 'Connected' state.

Returns the connection state. This endpoint is only supported for Function and Connection SDK connectors. To update the connection state, use Update Connection State.

⚠️ WRITE OPERATION - Confirm with user before calling. Updates the connection state. To update the state, you should pause your connection first. To update the connection state, do the following: 1. Pause connection using Update a Connection endpoint (set 'paused' to 'true'). 2. Update the state by using the Update Connection State endpoint. 3. Unpause the connection by setting the 'paused' parameter to 'false' in the Update a Connection endpoint request. This endpoint is only supported for Function and Connection SDK connectors.

⚠️ WRITE OPERATION - Confirm with user before calling. Triggers a data sync for an existing connection within your Fivetran account without waiting for the next scheduled sync. This action does not override the standard sync frequency you defined in the Fivetran dashboard. When schedule_type is set to manual, this endpoint is the only way syncs occur — including syncs in a rescheduled state. For a full walkthrough, see Trigger Manual Syncs.

⚠️ WRITE OPERATION - Confirm with user before calling. Runs the setup tests for an existing connection within your Fivetran account. Use this parameter to test the connection without making any configuration changes. You can optionally include trust_certificates or trust_fingerprints parameters to automatically approve certificates or fingerprints during the test run.

⚠️ RESULTS ARE PAGINATED. Returns a list of all accessible destinations within your Fivetran account.

⚠️ WRITE OPERATION - Confirm with user before calling. Creates a new destination within a specified group in your Fivetran account. > IMPORTANT: Groups and destinations are mapped 1:1 to each other. We do this mapping using the group's id value that we automatically generate when you create a group, and the destination's group_id value that you specify when you create a destination. This means that you must create a group in your Fivetran account before you can create a destination in it. > IMPORTANT: If you want to get the certificate details, do not set trust_certificates to true when you create a destination with our REST API. We can only provide the certificate details through the failed Validate Certificate setup test. For a full walkthrough, see Get Destination Certificate Details.

Returns a destination object if a valid identifier was provided. To find a destination's unique identifier, call the List All Groups endpoint and search the response items for your target destination by its name field. The group's id value is also the destination's id, since groups and destinations are mapped 1:1.

⚠️ WRITE OPERATION - Confirm with user before calling. Updates information for an existing destination within your Fivetran account.

⚠️ DESTRUCTIVE - Confirm with user before calling. Deletes a destination from your Fivetran account.

⚠️ WRITE OPERATION - Confirm with user before calling. Runs the setup tests for an existing destination within your Fivetran account.

⚠️ RESULTS ARE PAGINATED. Returns a list of all accessible logging services within your Fivetran account.

⚠️ WRITE OPERATION - Confirm with user before calling. Creates a new group-level logging service within a specified group in your Fivetran account.

Returns a group-level logging service object if a valid identifier was provided.

⚠️ WRITE OPERATION - Confirm with user before calling. Updates information for an existing group-level logging service within your Fivetran account.

⚠️ DESTRUCTIVE - Confirm with user before calling. Deletes a group-level logging service from your Fivetran account.

⚠️ WRITE OPERATION - Confirm with user before calling. Runs the setup tests for an existing group-level logging service within your Fivetran account.

⚠️ RESULTS ARE PAGINATED. Returns a list of all groups within your Fivetran account.

⚠️ WRITE OPERATION - Confirm with user before calling. Creates a new group in your Fivetran account. > IMPORTANT: Groups and destinations are mapped 1:1 to each other. We do this mapping using the group's id value that we automatically generate when you create a group, and the destination's group_id value that you specify when you create a destination. This means that you must create a group in your Fivetran account before you can create a destination in it.

Returns a group object if a valid identifier was provided.

⚠️ WRITE OPERATION - Confirm with user before calling. Updates information for an existing group within your Fivetran account.

⚠️ DESTRUCTIVE - Confirm with user before calling. Deletes a group from your Fivetran account.

⚠️ RESULTS ARE PAGINATED. Returns a list of information about all connections within a group in your Fivetran account.

Returns public key from SSH key pair associated with the group.

Returns Fivetran service account associated with the group.

⚠️ RESULTS ARE PAGINATED. Returns a list of information about all users within a group in your Fivetran account.

⚠️ WRITE OPERATION - Confirm with user before calling. Adds an existing user to a group in your Fivetran account.

⚠️ DESTRUCTIVE - Confirm with user before calling. Removes an existing user from a group in your Fivetran account.

⚠️ RESULTS ARE PAGINATED. Returns list of all Hybrid Deployment Agents within your Fivetran account, along with usage. Optionally filtered to a single group.

⚠️ WRITE OPERATION - Confirm with user before calling. Creates a new Hybrid Deployment Agent in a group.

Returns Hybrid Deployment Agent Details.

⚠️ DESTRUCTIVE - Confirm with user before calling. Delete a Hybrid Deployment Agent.

⚠️ WRITE OPERATION - Confirm with user before calling. Regenerate authentication for a Hybrid Deployment Agent.

⚠️ WRITE OPERATION - Confirm with user before calling. Reset credentials for a Hybrid Deployment Agent.

⚠️ RESULTS ARE PAGINATED. 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

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

⚠️ RESULTS ARE PAGINATED. Returns a list of all transformation projects available via API within your Fivetran account.

⚠️ WRITE OPERATION - Confirm with user before calling. Creates a new transformation project.

Returns transformation project details if a valid identifier was provided.

⚠️ WRITE OPERATION - Confirm with user before calling. Updates transformation project if a valid identifier was provided.

⚠️ DESTRUCTIVE - Confirm with user before calling. Deletes transformation project if a valid identifier was provided.

⚠️ WRITE OPERATION - Confirm with user before calling. Triggers tests for an existing transformation project.

⚠️ RESULTS ARE PAGINATED. Returns a list of all transformations within your Fivetran account.

⚠️ WRITE OPERATION - Confirm with user before calling. Creates a new transformation.

⚠️ RESULTS ARE PAGINATED. Returns a list of available Quickstart transformation package metadata details.

Returns the metadata details of the Quickstart transformation package if a valid identifier is provided.

Returns a transformation details if a valid identifier is provided.

⚠️ WRITE OPERATION - Confirm with user before calling. Updates the transformation if a valid identifier is provided.

⚠️ DESTRUCTIVE - Confirm with user before calling. Deletes a transformation if a valid identifier is provided.

⚠️ WRITE OPERATION - Confirm with user before calling. Cancels the execution of the transformation if a valid identifier is provided.

⚠️ WRITE OPERATION - Confirm with user before calling. Runs the transformation if a valid identifier is provided.

⚠️ WRITE OPERATION - Confirm with user before calling. Upgrades the Quickstart transformation package to latest version if a valid identifier is provided.

⚠️ RESULTS ARE PAGINATED. The endpoint allows you to retrieve the list of existing webhooks available for the current account

⚠️ WRITE OPERATION - Confirm with user before calling. This endpoint allows you to create a new webhook for the current account.

⚠️ WRITE OPERATION - Confirm with user before calling. This endpoint allows you to create a new webhook for a given group

This endpoint allows you to retrieve details of the existing webhook for a given identifier

⚠️ WRITE OPERATION - Confirm with user before calling. The endpoint allows you to update the existing webhook with a given identifier

⚠️ DESTRUCTIVE - Confirm with user before calling. This endpoint allows you to delete an existing webhook with a given identifier

⚠️ WRITE OPERATION - Confirm with user before calling. The endpoint allows you to test an existing webhook. It sends a webhook with a given identifier for a dummy connection with identifier _connection_1

Returns all available source types. This endpoint provides metadata including the proper source name (‘Facebook Ads’ instead of facebook_ads), the source icon, feature tables, information about the Hybrid deployment support, information about the Authorization via API support, and links to Fivetran resources. As we update source names and icons, that metadata will automatically update within this endpoint.