Can I use Fivetran as a CLI?

Yes. KosmoKrator exposes a Fivetran CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Fivetran through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Fivetran tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Fivetran credentials stored?

Fivetran credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Fivetran MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

Fivetran Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Fivetran KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.fivetran.*. Use lua_read_doc("integrations.fivetran") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Fivetran workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.fivetran.delete_user({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("fivetran"))' --json
kosmo integrations:lua --eval 'print(docs.read("fivetran.delete_user"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local fivetran = app.integrations.fivetran
local result = fivetran.delete_user({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.fivetran, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.fivetran.default.* or app.integrations.fivetran.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Fivetran, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Fivetran Lua Docs

Fivetran tools are exposed under app.integrations.fivetran. This package is generated from Fivetran’s official OpenAPI definition and exposes all 161 operations found in that spec.

Configure api_key, api_secret, and optionally url. The default URL is https://api.fivetran.com.

Pass path, query, and header parameters as top-level snake_case arguments. Pass JSON request bodies under body.

local account = app.integrations.fivetran.fivetran_get_account_info({})
local connections = app.integrations.fivetran.fivetran_list_connections({ limit = 25 })

Coverage Notes

The manifest fivetran-openapi-manifest.json records source URL, operation IDs, methods, paths, tool slugs, and classes. Basic authentication uses the Fivetran API key as username and API secret as password.

Representative Tools

fivetran_delete_user - DELETE /v1/users/{id}
fivetran_get_user_memberships_in_groups - GET /v1/users/{userId}/groups
fivetran_add_user_membership_in_group - POST /v1/users/{userId}/groups
fivetran_group_details - GET /v1/groups/{groupId}
fivetran_delete_group - DELETE /v1/groups/{groupId}
fivetran_modify_group - PATCH /v1/groups/{groupId}
fivetran_get_account_info - GET /v1/account/info
fivetran_get_hybrid_deployment_agent_list - GET /v1/hybrid-deployment-agents
fivetran_create_hybrid_deployment_agent - POST /v1/hybrid-deployment-agents
fivetran_get_team_memberships_in_groups - GET /v1/teams/{teamId}/groups
fivetran_add_team_membership_in_group - POST /v1/teams/{teamId}/groups
fivetran_metadata_connectors - GET /v1/metadata/connector-types
fivetran_re_auth_hybrid_deployment_agent - PATCH /v1/hybrid-deployment-agents/{agentId}/re-auth
fivetran_get_team_membership_in_group - GET /v1/teams/{teamId}/groups/{groupId}
fivetran_delete_team_membership_in_group - DELETE /v1/teams/{teamId}/groups/{groupId}
fivetran_update_team_membership_in_group - PATCH /v1/teams/{teamId}/groups/{groupId}
fivetran_rotate_system_key - POST /v1/system-keys/{keyId}/rotate
fivetran_get_connection_fingerprints_list - GET /v1/connections/{connectionId}/fingerprints
fivetran_approve_connection_fingerprint - POST /v1/connections/{connectionId}/fingerprints
fivetran_transformation_package_metadata_list - GET /v1/transformations/package-metadata

Raw agent markdown

# Fivetran Lua Docs

Fivetran tools are exposed under `app.integrations.fivetran`. This package is generated from Fivetran's official OpenAPI definition and exposes all 161 operations found in that spec.

Configure `api_key`, `api_secret`, and optionally `url`. The default URL is `https://api.fivetran.com`.

Pass path, query, and header parameters as top-level snake_case arguments. Pass JSON request bodies under `body`.

```lua
local account = app.integrations.fivetran.fivetran_get_account_info({})
local connections = app.integrations.fivetran.fivetran_list_connections({ limit = 25 })
```

## Coverage Notes

The manifest `fivetran-openapi-manifest.json` records source URL, operation IDs, methods, paths, tool slugs, and classes. Basic authentication uses the Fivetran API key as username and API secret as password.

## Representative Tools

- `fivetran_delete_user` - DELETE `/v1/users/{id}`
- `fivetran_get_user_memberships_in_groups` - GET `/v1/users/{userId}/groups`
- `fivetran_add_user_membership_in_group` - POST `/v1/users/{userId}/groups`
- `fivetran_group_details` - GET `/v1/groups/{groupId}`
- `fivetran_delete_group` - DELETE `/v1/groups/{groupId}`
- `fivetran_modify_group` - PATCH `/v1/groups/{groupId}`
- `fivetran_get_account_info` - GET `/v1/account/info`
- `fivetran_get_hybrid_deployment_agent_list` - GET `/v1/hybrid-deployment-agents`
- `fivetran_create_hybrid_deployment_agent` - POST `/v1/hybrid-deployment-agents`
- `fivetran_get_team_memberships_in_groups` - GET `/v1/teams/{teamId}/groups`
- `fivetran_add_team_membership_in_group` - POST `/v1/teams/{teamId}/groups`
- `fivetran_metadata_connectors` - GET `/v1/metadata/connector-types`
- `fivetran_re_auth_hybrid_deployment_agent` - PATCH `/v1/hybrid-deployment-agents/{agentId}/re-auth`
- `fivetran_get_team_membership_in_group` - GET `/v1/teams/{teamId}/groups/{groupId}`
- `fivetran_delete_team_membership_in_group` - DELETE `/v1/teams/{teamId}/groups/{groupId}`
- `fivetran_update_team_membership_in_group` - PATCH `/v1/teams/{teamId}/groups/{groupId}`
- `fivetran_rotate_system_key` - POST `/v1/system-keys/{keyId}/rotate`
- `fivetran_get_connection_fingerprints_list` - GET `/v1/connections/{connectionId}/fingerprints`
- `fivetran_approve_connection_fingerprint` - POST `/v1/connections/{connectionId}/fingerprints`
- `fivetran_transformation_package_metadata_list` - GET `/v1/transformations/package-metadata`

Metadata-derived Lua example

local result = app.integrations.fivetran.delete_user({})
print(result)

Functions

delete_user Write

Delete a User Official Fivetran endpoint: DELETE /v1/users/{id} Deletes a user from your Fivetran account. You will be unable to delete an account owner user if there is only one remaining.

Lua path: app.integrations.fivetran.delete_user
Full name: fivetran.fivetran_delete_user

Parameter	Type	Required	Description
No parameters.

list_all_group_memberships Read

List All Group Memberships Official Fivetran endpoint: GET /v1/users/{userId}/groups Returns the membership details for all groups a user belongs to.

Lua path: app.integrations.fivetran.list_all_group_memberships
Full name: fivetran.fivetran_get_user_memberships_in_groups

Parameter	Type	Required	Description
No parameters.

add_group_membership Write

Add Group Membership Official Fivetran endpoint: POST /v1/users/{userId}/groups Adds a user membership in a group.

Lua path: app.integrations.fivetran.add_group_membership
Full name: fivetran.fivetran_add_user_membership_in_group

Parameter	Type	Required	Description
No parameters.

retrieve_group_details Read

Retrieve Group Details Official Fivetran endpoint: GET /v1/groups/{groupId} Returns a group object if a valid identifier was provided.

Lua path: app.integrations.fivetran.retrieve_group_details
Full name: fivetran.fivetran_group_details

Parameter	Type	Required	Description
No parameters.

delete_group Write

Delete a Group Official Fivetran endpoint: DELETE /v1/groups/{groupId} Deletes a group from your Fivetran account.

Lua path: app.integrations.fivetran.delete_group
Full name: fivetran.fivetran_delete_group

Parameter	Type	Required	Description
No parameters.

update_group Write

Update a Group Official Fivetran endpoint: PATCH /v1/groups/{groupId} Updates information for an existing group within your Fivetran account.

Lua path: app.integrations.fivetran.update_group
Full name: fivetran.fivetran_modify_group

Parameter	Type	Required	Description
No parameters.

get_account_info_from_api_key Read

Get Account Info from the API Key Official Fivetran endpoint: GET /v1/account/info Returns information about current account from API key.

Lua path: app.integrations.fivetran.get_account_info_from_api_key
Full name: fivetran.fivetran_get_account_info

Parameter	Type	Required	Description
No parameters.

list_hybrid_deployment_agents Read

List Hybrid Deployment Agents Official Fivetran endpoint: GET /v1/hybrid-deployment-agents Returns list of all Hybrid Deployment Agents within your Fivetran account, along with usage. Optionally filtered to a single g...

Lua path: app.integrations.fivetran.list_hybrid_deployment_agents
Full name: fivetran.fivetran_get_hybrid_deployment_agent_list

Parameter	Type	Required	Description
No parameters.

create_hybrid_deployment_agent Write

Create a Hybrid Deployment Agent Official Fivetran endpoint: POST /v1/hybrid-deployment-agents Creates a new Hybrid Deployment Agent in a group.

Lua path: app.integrations.fivetran.create_hybrid_deployment_agent
Full name: fivetran.fivetran_create_hybrid_deployment_agent

Parameter	Type	Required	Description
No parameters.

list_all_group_memberships Read

List All Group Memberships Official Fivetran endpoint: GET /v1/teams/{teamId}/groups Returns all groups in which a team has membership.

Lua path: app.integrations.fivetran.list_all_group_memberships
Full name: fivetran.fivetran_get_team_memberships_in_groups

Parameter	Type	Required	Description
No parameters.

add_group_membership Write

Add Group Membership Official Fivetran endpoint: POST /v1/teams/{teamId}/groups Adds a team as a member of a group.

Lua path: app.integrations.fivetran.add_group_membership
Full name: fivetran.fivetran_add_team_membership_in_group

Parameter	Type	Required	Description
No parameters.

retrieve_source_metadata Read

Retrieve Source Metadata Official Fivetran endpoint: GET /v1/metadata/connector-types Returns all available source types within your Fivetran account. This endpoint makes it easier to display Fivetran connectors withi...

Lua path: app.integrations.fivetran.retrieve_source_metadata
Full name: fivetran.fivetran_metadata_connectors

Parameter	Type	Required	Description
No parameters.

regenerate_authentication_keys Write

Regenerate Authentication Keys Official Fivetran endpoint: PATCH /v1/hybrid-deployment-agents/{agentId}/re-auth Regenerate authentication for a Hybrid Deployment Agent.

Lua path: app.integrations.fivetran.regenerate_authentication_keys
Full name: fivetran.fivetran_re_auth_hybrid_deployment_agent

Parameter	Type	Required	Description
No parameters.

retrieve_group_membership_details Read

Retrieve Group Membership Details Official Fivetran endpoint: GET /v1/teams/{teamId}/groups/{groupId} Returns details of a team membership in a group.

Lua path: app.integrations.fivetran.retrieve_group_membership_details
Full name: fivetran.fivetran_get_team_membership_in_group

Parameter	Type	Required	Description
No parameters.

delete_group_membership Write

Delete Group Membership Official Fivetran endpoint: DELETE /v1/teams/{teamId}/groups/{groupId} Removes a team's membership in a group.

Lua path: app.integrations.fivetran.delete_group_membership
Full name: fivetran.fivetran_delete_team_membership_in_group

Parameter	Type	Required	Description
No parameters.

update_group_membership Write

Update Group Membership Official Fivetran endpoint: PATCH /v1/teams/{teamId}/groups/{groupId} Updates team membership in a group.

Lua path: app.integrations.fivetran.update_group_membership
Full name: fivetran.fivetran_update_team_membership_in_group

Parameter	Type	Required	Description
No parameters.

rotate_system_key Write

Rotate a System Key Official Fivetran endpoint: POST /v1/system-keys/{keyId}/rotate Updates the secret value and expired_at date for an existing system key within your Fivetran account.

Lua path: app.integrations.fivetran.rotate_system_key
Full name: fivetran.fivetran_rotate_system_key

Parameter	Type	Required	Description
No parameters.

list_fingerprints_approved_connection Read

List Fingerprints Approved for the Connection Official Fivetran endpoint: GET /v1/connections/{connectionId}/fingerprints Returns the list of approved SSH fingerprints for specified connection

Lua path: app.integrations.fivetran.list_fingerprints_approved_connection
Full name: fivetran.fivetran_get_connection_fingerprints_list

Parameter	Type	Required	Description
No parameters.

approve_fingerprint_connection Write

Approve a Fingerprint for the Connection Official Fivetran endpoint: POST /v1/connections/{connectionId}/fingerprints Approves a fingerprint, enabling Fivetran to trust it for a source database and establish connectio...

Lua path: app.integrations.fivetran.approve_fingerprint_connection
Full name: fivetran.fivetran_approve_connection_fingerprint

Parameter	Type	Required	Description
No parameters.

list_all_quickstart_package_metadata Read

List All Quickstart Package Metadata Official Fivetran endpoint: GET /v1/transformations/package-metadata Returns a list of available Quickstart transformation package metadata details.

Lua path: app.integrations.fivetran.list_all_quickstart_package_metadata
Full name: fivetran.fivetran_transformation_package_metadata_list

Parameter	Type	Required	Description
No parameters.

retrieve_source_table_columns_config Read

Retrieve Source Table Columns Config Official Fivetran endpoint: GET /v1/connections/{connectionId}/schemas/{schema}/tables/{table}/columns Returns the real-time column list for one source table by querying the source...

Lua path: app.integrations.fivetran.retrieve_source_table_columns_config
Full name: fivetran.fivetran_connection_column_config

Parameter	Type	Required	Description
No parameters.

list_fingerprints_approved_destination Read

List Fingerprints Approved for the Destination Official Fivetran endpoint: GET /v1/destinations/{destinationId}/fingerprints Returns the list of approved SSH fingerprints for specified destination

Lua path: app.integrations.fivetran.list_fingerprints_approved_destination
Full name: fivetran.fivetran_get_destination_fingerprints_list

Parameter	Type	Required	Description
No parameters.

approve_fingerprint_destination Write

Approve a Fingerprint for the Destination Official Fivetran endpoint: POST /v1/destinations/{destinationId}/fingerprints Approves a fingerprint, enabling Fivetran to trust it for a destination database and establish c...

Lua path: app.integrations.fivetran.approve_fingerprint_destination
Full name: fivetran.fivetran_approve_destination_fingerprint

Parameter	Type	Required	Description
No parameters.

update_connection_table_config Write

Update a Connection Table Config Official Fivetran endpoint: PATCH /v1/connections/{connectionId}/schemas/{schemaName}/tables/{tableName} Updates the table config within your database schema for an existing connection...

Lua path: app.integrations.fivetran.update_connection_table_config
Full name: fivetran.fivetran_modify_connection_table_config

Parameter	Type	Required	Description
No parameters.

retrieve_connection_certificate_details Read

Retrieve Connection Certificate Details Official Fivetran endpoint: GET /v1/connections/{connectionId}/certificates/{hash} Returns details of the certificate approved for the specified connection with specified certif...

Lua path: app.integrations.fivetran.retrieve_connection_certificate_details
Full name: fivetran.fivetran_get_connection_certificate_details

Parameter	Type	Required	Description
No parameters.

revoke_connection_certificate Write

Revoke Connection Certificate Official Fivetran endpoint: DELETE /v1/connections/{connectionId}/certificates/{hash} Revokes a certificate, so Fivetran no longer trusts it while connecting to the source database.

Lua path: app.integrations.fivetran.revoke_connection_certificate
Full name: fivetran.fivetran_revoke_connection_certificate

Parameter	Type	Required	Description
No parameters.

create_group_webhook Write

Create a Group Webhook Official Fivetran endpoint: POST /v1/webhooks/group/{groupId} This endpoint allows you to create a new webhook for a given group

Lua path: app.integrations.fivetran.create_group_webhook
Full name: fivetran.fivetran_create_group_webhook

Parameter	Type	Required	Description
No parameters.

retrieve_connection_membership Read

Retrieve Connection Membership Official Fivetran endpoint: GET /v1/teams/{teamId}/connections/{connectionId} Returns details of a team membership in a connection.

Lua path: app.integrations.fivetran.retrieve_connection_membership
Full name: fivetran.fivetran_get_team_membership_in_connection

Parameter	Type	Required	Description
No parameters.

delete_connection_membership Write

Delete Connection Membership Official Fivetran endpoint: DELETE /v1/teams/{teamId}/connections/{connectionId} Removes team membership in a connection.

Lua path: app.integrations.fivetran.delete_connection_membership
Full name: fivetran.fivetran_delete_team_membership_in_connection

Parameter	Type	Required	Description
No parameters.

update_connection_membership Write

Update Connection Membership Official Fivetran endpoint: PATCH /v1/teams/{teamId}/connections/{connectionId} Updates team membership in a connection

Lua path: app.integrations.fivetran.update_connection_membership
Full name: fivetran.fivetran_update_team_membership_in_connection

Parameter	Type	Required	Description
No parameters.

remove_user_from_group Write

Remove a User from a Group Official Fivetran endpoint: DELETE /v1/groups/{groupId}/users/{userId} Removes an existing user from a group in your Fivetran account.

Lua path: app.integrations.fivetran.remove_user_from_group
Full name: fivetran.fivetran_delete_user_from_group

Parameter	Type	Required	Description
No parameters.

retrieve_connection_details Read

Retrieve Connection Details Official Fivetran endpoint: GET /v1/connections/{connectionId} Returns a connection configuration and status details if a valid identifier was provided.

Lua path: app.integrations.fivetran.retrieve_connection_details
Full name: fivetran.fivetran_connection_details

Parameter	Type	Required	Description
No parameters.

delete_connection Write

Delete a Connection Official Fivetran endpoint: DELETE /v1/connections/{connectionId} Deletes a connection from your Fivetran account.

Lua path: app.integrations.fivetran.delete_connection
Full name: fivetran.fivetran_delete_connection

Parameter	Type	Required	Description
No parameters.

update_connection Write

Update a Connection Official Fivetran endpoint: PATCH /v1/connections/{connectionId} Updates connection parameters for an existing connection within your Fivetran account. This endpoint requires at least one persisten...

Lua path: app.integrations.fivetran.update_connection
Full name: fivetran.fivetran_modify_connection

Parameter	Type	Required	Description
No parameters.

test_transformation_project Write

Test Transformation Project Official Fivetran endpoint: POST /v1/transformation-projects/{projectId}/test Triggers tests for an existing transformation project.

Lua path: app.integrations.fivetran.test_transformation_project
Full name: fivetran.fivetran_test_transformation_project

Parameter	Type	Required	Description
No parameters.

list_all_connections_within_group Read

List All Connections within a Group Official Fivetran endpoint: GET /v1/groups/{groupId}/connections Returns a list of information about all connections within a group in your Fivetran account.

Lua path: app.integrations.fivetran.list_all_connections_within_group
Full name: fivetran.fivetran_list_all_connections_in_group

Parameter	Type	Required	Description
No parameters.

drop_blocked_columns_from_destination Write

Drop Blocked Columns from the Destination. Official Fivetran endpoint: POST /v1/connections/{connectionId}/schemas/drop-columns Mark multiple blocked columns for deletion from your destination tables. The columns will...

Lua path: app.integrations.fivetran.drop_blocked_columns_from_destination
Full name: fivetran.fivetran_delete_multiple_columns_connection_config

Parameter	Type	Required	Description
No parameters.

retrieve_destination_certificate_details Read

Retrieve Destination Certificate Details Official Fivetran endpoint: GET /v1/destinations/{destinationId}/certificates/{hash} Returns details of the certificate approved for the specified destination with specified ce...

Lua path: app.integrations.fivetran.retrieve_destination_certificate_details
Full name: fivetran.fivetran_get_destination_certificate_details

Parameter	Type	Required	Description
No parameters.

revoke_destination_certificate Write

Revoke Destination Certificate Official Fivetran endpoint: DELETE /v1/destinations/{destinationId}/certificates/{hash} Revokes a certificate, so Fivetran no longer trusts it while connecting to the destination database.

Lua path: app.integrations.fivetran.revoke_destination_certificate
Full name: fivetran.fivetran_revoke_destination_certificate

Parameter	Type	Required	Description
No parameters.

retrieve_connection_schema_config Read

Retrieve a Connection Schema Config Official Fivetran endpoint: GET /v1/connections/{connectionId}/schemas Returns the top-level schema configuration for an existing connection within your Fivetran account. The respon...

Lua path: app.integrations.fivetran.retrieve_connection_schema_config
Full name: fivetran.fivetran_connection_schema_config

Parameter	Type	Required	Description
No parameters.

set_up_new_connection_schema_config Write

Set Up a New Connection Schema Config Official Fivetran endpoint: POST /v1/connections/{connectionId}/schemas Configures a Connection Schema for a new connection before the schema is captured from the source. > Note: ...

Lua path: app.integrations.fivetran.set_up_new_connection_schema_config
Full name: fivetran.fivetran_pre_create_connection_schema_config

Parameter	Type	Required	Description
No parameters.

update_connection_schema_config Write

Update a Connection Schema Config Official Fivetran endpoint: PATCH /v1/connections/{connectionId}/schemas Updates the schema config for an existing connection within your Fivetran account. > NOTE: For backward compat...

Lua path: app.integrations.fivetran.update_connection_schema_config
Full name: fivetran.fivetran_modify_connection_schema_config

Parameter	Type	Required	Description
No parameters.

list_certificates_approved_destination Read

List Certificates Approved for the Destination Official Fivetran endpoint: GET /v1/destinations/{destinationId}/certificates Returns the list of approved certificates for the specified destination.

Lua path: app.integrations.fivetran.list_certificates_approved_destination
Full name: fivetran.fivetran_get_destination_certificates_list

Parameter	Type	Required	Description
No parameters.

approve_certificate_destination Write

Approve a Certificate for the Destination Official Fivetran endpoint: POST /v1/destinations/{destinationId}/certificates Approves a certificate, so Fivetran trusts this certificate for a destination database connectio...

Lua path: app.integrations.fivetran.approve_certificate_destination
Full name: fivetran.fivetran_approve_destination_certificate

Parameter	Type	Required	Description
No parameters.

regenerate_secrets_proxy_agent Write

Regenerate Secrets for Proxy Agent Official Fivetran endpoint: POST /v1/proxy/{agentId}/regenerate-secrets Regenerate secrets for proxy agent within your Fivetran account.

Lua path: app.integrations.fivetran.regenerate_secrets_proxy_agent
Full name: fivetran.fivetran_regenerate_secrets_proxy_agent

Parameter	Type	Required	Description
No parameters.

list_all_connector_sdk_packages Read

List All Connector SDK Packages Official Fivetran endpoint: GET /v1/connector-sdk/packages Returns a list of all Connector SDK packages in your Fivetran account.

Lua path: app.integrations.fivetran.list_all_connector_sdk_packages
Full name: fivetran.fivetran_list_connector_sdk_packages

Parameter	Type	Required	Description
No parameters.

create_connector_sdk_package Write

Create Connector SDK Package Official Fivetran endpoint: POST /v1/connector-sdk/packages Uploads a new Connector SDK package to your Fivetran account. The package must be a ZIP file containing your custom connector co...

Lua path: app.integrations.fivetran.create_connector_sdk_package
Full name: fivetran.fivetran_create_connector_sdk_package

Parameter	Type	Required	Description
No parameters.

list_all_connections Read

List All Connections Official Fivetran endpoint: GET /v1/connections Returns a list of all accessible connections within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_connections
Full name: fivetran.fivetran_list_connections

Parameter	Type	Required	Description
No parameters.

create_connection Write

Create a Connection Official Fivetran endpoint: POST /v1/connections Creates a new connection within a specified group in your Fivetran account. Runs setup tests and returns testing results. > IMPORTANT: The `destinat...

Lua path: app.integrations.fivetran.create_connection
Full name: fivetran.fivetran_create_connection

Parameter	Type	Required	Description
No parameters.

list_all_webhooks Read

List all Webhooks Official Fivetran endpoint: GET /v1/webhooks The endpoint allows you to retrieve the list of existing webhooks available for the current account

Lua path: app.integrations.fivetran.list_all_webhooks
Full name: fivetran.fivetran_list_all_webhooks

Parameter	Type	Required	Description
No parameters.

deprecated_approve_certificate Write

(Deprecated) Approve a Certificate Official Fivetran endpoint: POST /v1/certificates Approves a certificate for a connection/destination, so Fivetran trusts this certificate for a source/destination database. The conn...

Lua path: app.integrations.fivetran.deprecated_approve_certificate
Full name: fivetran.fivetran_approve_certificate

Parameter	Type	Required	Description
No parameters.

retrieve_group_public_ssh_key Read

Retrieve Group Public SSH Key Official Fivetran endpoint: GET /v1/groups/{groupId}/public-key Returns public key from SSH key pair associated with the group.

Lua path: app.integrations.fivetran.retrieve_group_public_ssh_key
Full name: fivetran.fivetran_group_ssh_public_key

Parameter	Type	Required	Description
No parameters.

retrieve_quickstart_package_metadata_details Read

Retrieve a Quickstart Package Metadata Details Official Fivetran endpoint: GET /v1/transformations/package-metadata/{package_definition_id} Returns the metadata details of the Quickstart transformation package if a va...

Lua path: app.integrations.fivetran.retrieve_quickstart_package_metadata_details
Full name: fivetran.fivetran_transformation_package_metadata_details

Parameter	Type	Required	Description
No parameters.

list_all_connections_attached_proxy_agent Read

List All Connections Attached to the Proxy Agent Official Fivetran endpoint: GET /v1/proxy/{agentId}/connections Returns all connections attached to the specified proxy agent within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_connections_attached_proxy_agent
Full name: fivetran.fivetran_get_proxy_agent_connections

Parameter	Type	Required	Description
No parameters.

list_all_destinations_within_account Read

List All Destinations within Account Official Fivetran endpoint: GET /v1/groups Returns a list of all groups within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_destinations_within_account
Full name: fivetran.fivetran_list_all_groups

Parameter	Type	Required	Description
No parameters.

create_group Write

Create a Group Official Fivetran endpoint: POST /v1/groups 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` val...

Lua path: app.integrations.fivetran.create_group
Full name: fivetran.fivetran_create_group

Parameter	Type	Required	Description
No parameters.

reset_agent_credentials Write

Reset Agent Credentials Official Fivetran endpoint: POST /v1/hybrid-deployment-agents/{agentId}/reset-credentials Reset credentials for a Hybrid Deployment Agent.

Lua path: app.integrations.fivetran.reset_agent_credentials
Full name: fivetran.fivetran_reset_hybrid_deployment_agent_credentials

Parameter	Type	Required	Description
No parameters.

run_group_log_service_setup_tests Write

Run Group Log Service Setup Tests Official Fivetran endpoint: POST /v1/external-logging/{logId}/test Runs the setup tests for an existing group-level [logging service](/docs/logs/external-logs) within your Fivetran ac...

Lua path: app.integrations.fivetran.run_group_log_service_setup_tests
Full name: fivetran.fivetran_run_setup_tests_log_service

Parameter	Type	Required	Description
No parameters.

drop_blocked_column_from_destination Write

Drop a Blocked Column From the Destination Official Fivetran endpoint: DELETE /v1/connections/{connectionId}/schemas/{schemaName}/tables/{tableName}/columns/{columnName} Marks a blocked column for deletion from your d...

Lua path: app.integrations.fivetran.drop_blocked_column_from_destination
Full name: fivetran.fivetran_delete_column_connection_config

Parameter	Type	Required	Description
No parameters.

update_connection_column_config Write

Update a Connection Column Config Official Fivetran endpoint: PATCH /v1/connections/{connectionId}/schemas/{schemaName}/tables/{tableName}/columns/{columnName} Updates the column config within your table for an existi...

Lua path: app.integrations.fivetran.update_connection_column_config
Full name: fivetran.fivetran_modify_connection_column_config

Parameter	Type	Required	Description
No parameters.

retrieve_connection_fingerprint_details Read

Retrieve Connection Fingerprint Details Official Fivetran endpoint: GET /v1/connections/{connectionId}/fingerprints/{hash} Returns SSH fingerprint details approved for specified connection with specified hash

Lua path: app.integrations.fivetran.retrieve_connection_fingerprint_details
Full name: fivetran.fivetran_get_connection_fingerprint_details

Parameter	Type	Required	Description
No parameters.

revoke_connection_fingerprint Write

Revoke Connection Fingerprint Official Fivetran endpoint: DELETE /v1/connections/{connectionId}/fingerprints/{hash} Revokes a fingerprint, so Fivetran no longer trusts it while connecting to the source database throug...

Lua path: app.integrations.fivetran.revoke_connection_fingerprint
Full name: fivetran.fivetran_revoke_connection_fingerprint

Parameter	Type	Required	Description
No parameters.

retrieve_private_link_details Read

Retrieve Private Link Details Official Fivetran endpoint: GET /v1/private-links/{privateLinkId} Returns a private link object if a valid identifier was provided.

Lua path: app.integrations.fivetran.retrieve_private_link_details
Full name: fivetran.fivetran_get_private_link_details

Parameter	Type	Required	Description
No parameters.

delete_private_link Write

Delete a Private Link Official Fivetran endpoint: DELETE /v1/private-links/{privateLinkId} Deletes a private link from your Fivetran account.

Lua path: app.integrations.fivetran.delete_private_link
Full name: fivetran.fivetran_delete_private_link

Parameter	Type	Required	Description
No parameters.

update_private_link Write

Update a Private Link Official Fivetran endpoint: PATCH /v1/private-links/{privateLinkId} Updates information for an existing private link within your Fivetran account.

Lua path: app.integrations.fivetran.update_private_link
Full name: fivetran.fivetran_modify_private_link

Parameter	Type	Required	Description
No parameters.

list_all_system_keys Read

List All System Keys Official Fivetran endpoint: GET /v1/system-keys Returns a list of system keys within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_system_keys
Full name: fivetran.fivetran_get_system_keys

Parameter	Type	Required	Description
No parameters.

create_system_key Write

Create a System Key Official Fivetran endpoint: POST /v1/system-keys Creates a new system key with your Fivetran account.

Lua path: app.integrations.fivetran.create_system_key
Full name: fivetran.fivetran_create_system_key

Parameter	Type	Required	Description
No parameters.

list_all_roles Read

List all roles Official Fivetran endpoint: GET /v1/roles Returns a list of all predefined and custom roles within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_roles
Full name: fivetran.fivetran_list_all_roles

Parameter	Type	Required	Description
No parameters.

retrieve_source_metadata_public_endpoint Read

Retrieve Source Metadata Public Endpoint Official Fivetran endpoint: GET /public/connector-types Returns all available source types. This endpoint provides metadata including the proper source name (‘Facebook Ads’...

Lua path: app.integrations.fivetran.retrieve_source_metadata_public_endpoint
Full name: fivetran.fivetran_metadata_public_connectors

Parameter	Type	Required	Description
No parameters.

list_certificates_approved_connection Read

List Certificates Approved for the Connection Official Fivetran endpoint: GET /v1/connections/{connectionId}/certificates Returns the list of approved certificates for the specified connection.

Lua path: app.integrations.fivetran.list_certificates_approved_connection
Full name: fivetran.fivetran_get_connection_certificates_list

Parameter	Type	Required	Description
No parameters.

approve_certificate_connection Write

Approve a Certificate for the Connection Official Fivetran endpoint: POST /v1/connections/{connectionId}/certificates Approves a certificate, so Fivetran trusts this certificate for a source database connection. The c...

Lua path: app.integrations.fivetran.approve_certificate_connection
Full name: fivetran.fivetran_approve_connection_certificate

Parameter	Type	Required	Description
No parameters.

list_all_destinations_within_account Read

List All Destinations Within Account Official Fivetran endpoint: GET /v1/destinations Returns a list of all accessible destinations within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_destinations_within_account
Full name: fivetran.fivetran_list_destinations

Parameter	Type	Required	Description
No parameters.

create_destination Write

Create a Destination Official Fivetran endpoint: POST /v1/destinations Creates a new destination within a specified group in your Fivetran account. > IMPORTANT: Groups and destinations are mapped 1:1 to each other. We...

Lua path: app.integrations.fivetran.create_destination
Full name: fivetran.fivetran_create_destination

Parameter	Type	Required	Description
No parameters.

list_all_connection_memberships Read

List All Connection Memberships Official Fivetran endpoint: GET /v1/users/{userId}/connections Returns all connection membership for a user within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_connection_memberships
Full name: fivetran.fivetran_get_user_memberships_in_connections

Parameter	Type	Required	Description
No parameters.

add_connection_membership Write

Add a Connection Membership Official Fivetran endpoint: POST /v1/users/{userId}/connections Adds a connection membership

Lua path: app.integrations.fivetran.add_connection_membership
Full name: fivetran.fivetran_add_user_membership_in_connection

Parameter	Type	Required	Description
No parameters.

retrieve_destination_fingerprint_details Read

Retrieve Destination Fingerprint Details Official Fivetran endpoint: GET /v1/destinations/{destinationId}/fingerprints/{hash} Returns SSH fingerprint details approved for specified destination with specified hash

Lua path: app.integrations.fivetran.retrieve_destination_fingerprint_details
Full name: fivetran.fivetran_get_destination_fingerprint_details

Parameter	Type	Required	Description
No parameters.

revoke_destination_fingerprint Write

Revoke Destination Fingerprint Official Fivetran endpoint: DELETE /v1/destinations/{destinationId}/fingerprints/{hash} Revokes a fingerprint, so Fivetran no longer trusts it while connecting to the destination databas...

Lua path: app.integrations.fivetran.revoke_destination_fingerprint
Full name: fivetran.fivetran_revoke_destination_fingerprint

Parameter	Type	Required	Description
No parameters.

sync_connection_data Write

Sync Connection Data Official Fivetran endpoint: POST /v1/connections/{connectionId}/sync Triggers a data sync for an existing connection within your Fivetran account without waiting for the next scheduled sync. This ...

Lua path: app.integrations.fivetran.sync_connection_data
Full name: fivetran.fivetran_sync_connection

Parameter	Type	Required	Description
No parameters.

update_connection_database_schema_config Write

Update a Connection Database Schema Config Official Fivetran endpoint: PATCH /v1/connections/{connectionId}/schemas/{schemaName} Updates the database schema config for an existing connection within your Fivetran accou...

Lua path: app.integrations.fivetran.update_connection_database_schema_config
Full name: fivetran.fivetran_modify_connection_database_schema_config

Parameter	Type	Required	Description
No parameters.

retrieve_system_key_details Read

Retrieve System Key Details Official Fivetran endpoint: GET /v1/system-keys/{keyId} Retrieves a system key object within your Fivetran account.

Lua path: app.integrations.fivetran.retrieve_system_key_details
Full name: fivetran.fivetran_get_system_key_details

Parameter	Type	Required	Description
No parameters.

delete_system_key Write

Delete a System Key Official Fivetran endpoint: DELETE /v1/system-keys/{keyId} Deletes a system key from your Fivetran account.

Lua path: app.integrations.fivetran.delete_system_key
Full name: fivetran.fivetran_delete_system_key

Parameter	Type	Required	Description
No parameters.

update_system_key Write

Update a System Key Official Fivetran endpoint: PATCH /v1/system-keys/{keyId} Updates an existing system key within your Fivetran account.

Lua path: app.integrations.fivetran.update_system_key
Full name: fivetran.fivetran_update_system_key

Parameter	Type	Required	Description
No parameters.

re_sync_connection_data_historical_sync Write

Re-sync Connection Data (Historical Sync) Official Fivetran endpoint: POST /v1/connections/{connectionId}/resync Triggers a full historical sync of a connection or multiple schema tables within a connection. If the co...

Lua path: app.integrations.fivetran.re_sync_connection_data_historical_sync
Full name: fivetran.fivetran_resync_connection

Parameter	Type	Required	Description
No parameters.

retrieve_group_log_service_details Read

Retrieve Group Log Service Details Official Fivetran endpoint: GET /v1/external-logging/{logId} Returns a group-level [logging service](/docs/logs/external-logs) object if a valid identifier was provided.

Lua path: app.integrations.fivetran.retrieve_group_log_service_details
Full name: fivetran.fivetran_get_log_service_details

Parameter	Type	Required	Description
No parameters.

delete_group_log_service Write

Delete a Group Log Service Official Fivetran endpoint: DELETE /v1/external-logging/{logId} Deletes a group-level [logging service](/docs/logs/external-logs) from your Fivetran account.

Lua path: app.integrations.fivetran.delete_group_log_service
Full name: fivetran.fivetran_delete_log_service

Parameter	Type	Required	Description
No parameters.

update_group_log_service Write

Update a Group Log Service Official Fivetran endpoint: PATCH /v1/external-logging/{logId} Updates information for an existing group-level [logging service](/docs/logs/external-logs) within your Fivetran account.

Lua path: app.integrations.fivetran.update_group_log_service
Full name: fivetran.fivetran_update_log_service

Parameter	Type	Required	Description
No parameters.

list_all_transformation_projects Read

List all Transformation Projects Official Fivetran endpoint: GET /v1/transformation-projects Returns a list of all transformation projects available via API within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_transformation_projects
Full name: fivetran.fivetran_list_all_transformation_projects

Parameter	Type	Required	Description
No parameters.

create_transformation_project Write

Create Transformation Project Official Fivetran endpoint: POST /v1/transformation-projects Creates a new transformation project.

Lua path: app.integrations.fivetran.create_transformation_project
Full name: fivetran.fivetran_create_transformation_project

Parameter	Type	Required	Description
No parameters.

retrieve_user_membership_team Read

Retrieve User Membership in a Team Official Fivetran endpoint: GET /v1/teams/{teamId}/users/{userId} Returns the membership details for a user in a team.

Lua path: app.integrations.fivetran.retrieve_user_membership_team
Full name: fivetran.fivetran_get_user_in_team

Parameter	Type	Required	Description
No parameters.

delete_user_from_team Write

Delete a User from a Team Official Fivetran endpoint: DELETE /v1/teams/{teamId}/users/{userId} Removes a user from a team.

Lua path: app.integrations.fivetran.delete_user_from_team
Full name: fivetran.fivetran_delete_user_from_team

Parameter	Type	Required	Description
No parameters.

update_user_membership Write

Update a User Membership Official Fivetran endpoint: PATCH /v1/teams/{teamId}/users/{userId} Updates a user membership in a team.

Lua path: app.integrations.fivetran.update_user_membership
Full name: fivetran.fivetran_update_user_membership

Parameter	Type	Required	Description
No parameters.

retrieve_team_details Read

Retrieve Team Details Official Fivetran endpoint: GET /v1/teams/{teamId} Returns information for a given team within your Fivetran account

Lua path: app.integrations.fivetran.retrieve_team_details
Full name: fivetran.fivetran_team_details

Parameter	Type	Required	Description
No parameters.

delete_team Write

Delete a Team Official Fivetran endpoint: DELETE /v1/teams/{teamId} Deletes a team from your Fivetran account

Lua path: app.integrations.fivetran.delete_team
Full name: fivetran.fivetran_delete_team

Parameter	Type	Required	Description
No parameters.

update_team Write

Update a Team Official Fivetran endpoint: PATCH /v1/teams/{teamId} Updates information for an existing team within your Fivetran account

Lua path: app.integrations.fivetran.update_team
Full name: fivetran.fivetran_modify_team

Parameter	Type	Required	Description
No parameters.

retrieve_transformation_details Read

Retrieve Transformation Details Official Fivetran endpoint: GET /v1/transformations/{transformationId} Returns a transformation details if a valid identifier is provided.

Lua path: app.integrations.fivetran.retrieve_transformation_details
Full name: fivetran.fivetran_transformation_details

Parameter	Type	Required	Description
No parameters.

delete_transformation Write

Delete a Transformation Official Fivetran endpoint: DELETE /v1/transformations/{transformationId} Deletes a transformation if a valid identifier is provided.

Lua path: app.integrations.fivetran.delete_transformation
Full name: fivetran.fivetran_delete_transformation

Parameter	Type	Required	Description
No parameters.

update_transformation Write

Update a Transformation Official Fivetran endpoint: PATCH /v1/transformations/{transformationId} Updates the transformation if a valid identifier is provided.

Lua path: app.integrations.fivetran.update_transformation
Full name: fivetran.fivetran_update_transformation

Parameter	Type	Required	Description
No parameters.

create_account_webhook Write

Create an Account Webhook Official Fivetran endpoint: POST /v1/webhooks/account This endpoint allows you to create a new webhook for the current account.

Lua path: app.integrations.fivetran.create_account_webhook
Full name: fivetran.fivetran_create_account_webhook

Parameter	Type	Required	Description
No parameters.

retrieve_connector_sdk_package_details Read

Retrieve Connector SDK Package Details Official Fivetran endpoint: GET /v1/connector-sdk/packages/{package_id} Returns details for a specific Connector SDK package.

Lua path: app.integrations.fivetran.retrieve_connector_sdk_package_details
Full name: fivetran.fivetran_get_connector_sdk_package

Parameter	Type	Required	Description
No parameters.

delete_connector_sdk_package Write

Delete Connector SDK Package Official Fivetran endpoint: DELETE /v1/connector-sdk/packages/{package_id} Permanently deletes a Connector SDK package from your Fivetran account. > **Warning:** Packages that are associat...

Lua path: app.integrations.fivetran.delete_connector_sdk_package
Full name: fivetran.fivetran_delete_connector_sdk_package

Parameter	Type	Required	Description
No parameters.

update_connector_sdk_package Write

Update Connector SDK Package Official Fivetran endpoint: PATCH /v1/connector-sdk/packages/{package_id} Updates an existing Connector SDK package by uploading a new version of the connector code. All connections using ...

Lua path: app.integrations.fivetran.update_connector_sdk_package
Full name: fivetran.fivetran_update_connector_sdk_package

Parameter	Type	Required	Description
No parameters.

retrieve_account_log_service Read

Retrieve Account Log Service Official Fivetran endpoint: GET /v1/external-logging/account Returns the account-level [logging service](/docs/logs/external-logs) if it exists.

Lua path: app.integrations.fivetran.retrieve_account_log_service
Full name: fivetran.fivetran_get_account_log_service_details

Parameter	Type	Required	Description
No parameters.

create_account_log_service Write

Create Account Log Service Official Fivetran endpoint: POST /v1/external-logging/account Creates an account-level [logging service](/docs/logs/external-logs).

Lua path: app.integrations.fivetran.create_account_log_service
Full name: fivetran.fivetran_add_account_log_service

Parameter	Type	Required	Description
No parameters.

delete_account_log_service Write

Delete Account Log Service Official Fivetran endpoint: DELETE /v1/external-logging/account Deletes the account-level [logging service](/docs/logs/external-logs).

Lua path: app.integrations.fivetran.delete_account_log_service
Full name: fivetran.fivetran_delete_account_log_service

Parameter	Type	Required	Description
No parameters.

update_account_log_service Write

Update Account Log Service Official Fivetran endpoint: PATCH /v1/external-logging/account Updates information for the account-level [logging service](/docs/logs/external-logs).

Lua path: app.integrations.fivetran.update_account_log_service
Full name: fivetran.fivetran_update_account_log_service

Parameter	Type	Required	Description
No parameters.

upgrade_transformation_package Write

Upgrade Transformation Package Official Fivetran endpoint: POST /v1/transformations/{transformationId}/upgrade Upgrades the Quickstart transformation package to latest version if a valid identifier is provided.

Lua path: app.integrations.fivetran.upgrade_transformation_package
Full name: fivetran.fivetran_upgrade_transformation_package

Parameter	Type	Required	Description
No parameters.

retrieve_proxy_agent_details Read

Retrieve Proxy Agent Details Official Fivetran endpoint: GET /v1/proxy/{agentId} Retrieves the details of the specified proxy agent.

Lua path: app.integrations.fivetran.retrieve_proxy_agent_details
Full name: fivetran.fivetran_get_proxy_agent_details

Parameter	Type	Required	Description
No parameters.

delete_proxy_agent Write

Delete a Proxy Agent Official Fivetran endpoint: DELETE /v1/proxy/{agentId} Deletes the specified proxy agent from your Fivetran account.

Lua path: app.integrations.fivetran.delete_proxy_agent
Full name: fivetran.fivetran_delete_proxy_agent

Parameter	Type	Required	Description
No parameters.

create_connect_card Write

Create a Connect Card Official Fivetran endpoint: POST /v1/connections/{connectionId}/connect-card Generates the Connect Card URI for the connection

Lua path: app.integrations.fivetran.create_connect_card
Full name: fivetran.fivetran_connect_card

Parameter	Type	Required	Description
No parameters.

list_all_users_within_group Read

List All Users within a Group Official Fivetran endpoint: GET /v1/groups/{groupId}/users Returns a list of information about all users within a group in your Fivetran account.

Lua path: app.integrations.fivetran.list_all_users_within_group
Full name: fivetran.fivetran_list_all_users_in_group

Parameter	Type	Required	Description
No parameters.

add_user_group Write

Add a User to a Group Official Fivetran endpoint: POST /v1/groups/{groupId}/users Adds an existing user to a group in your Fivetran account.

Lua path: app.integrations.fivetran.add_user_group
Full name: fivetran.fivetran_add_user_to_group

Parameter	Type	Required	Description
No parameters.

retrieve_user_details Read

Retrieve a User Details Official Fivetran endpoint: GET /v1/users/{userId} Returns a user object if a valid identifier was provided.

Lua path: app.integrations.fivetran.retrieve_user_details
Full name: fivetran.fivetran_user_details

Parameter	Type	Required	Description
No parameters.

update_user Write

Update a User Official Fivetran endpoint: PATCH /v1/users/{userId} Updates information for an existing user within your Fivetran account.

Lua path: app.integrations.fivetran.update_user
Full name: fivetran.fivetran_modify_user

Parameter	Type	Required	Description
No parameters.

list_all_teams Read

List All Teams Official Fivetran endpoint: GET /v1/teams Returns a list of all teams within your Fivetran account

Lua path: app.integrations.fivetran.list_all_teams
Full name: fivetran.fivetran_list_all_teams

Parameter	Type	Required	Description
No parameters.

create_team Write

Create a Team Official Fivetran endpoint: POST /v1/teams Creates a new team in your Fivetran account

Lua path: app.integrations.fivetran.create_team
Full name: fivetran.fivetran_create_team

Parameter	Type	Required	Description
No parameters.

list_all_log_services_within_account Read

List All Log Services within Account Official Fivetran endpoint: GET /v1/external-logging Returns a list of all accessible [logging services](/docs/logs/external-logs) within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_log_services_within_account
Full name: fivetran.fivetran_list_log_services

Parameter	Type	Required	Description
No parameters.

create_group_log_service Write

Create a Group Log Service Official Fivetran endpoint: POST /v1/external-logging Creates a new group-level [logging service](/docs/logs/external-logs) within a specified group in your Fivetran account.

Lua path: app.integrations.fivetran.create_group_log_service
Full name: fivetran.fivetran_add_log_service

Parameter	Type	Required	Description
No parameters.

retrieve_connection_state Read

Retrieve Connection State Official Fivetran endpoint: GET /v1/connections/{connectionId}/state Returns the connection state. This endpoint is only supported for Function and Connection SDK connectors.

Lua path: app.integrations.fivetran.retrieve_connection_state
Full name: fivetran.fivetran_connection_state

Parameter	Type	Required	Description
No parameters.

update_connection_state Write

Update a Connection State Official Fivetran endpoint: PATCH /v1/connections/{connectionId}/state Updates the connection state. To update the state, you should pause your connection first. To update the connection stat...

Lua path: app.integrations.fivetran.update_connection_state
Full name: fivetran.fivetran_modify_connection_state

Parameter	Type	Required	Description
No parameters.

list_all_users Read

List All Users Official Fivetran endpoint: GET /v1/users Returns a list of all users within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_users
Full name: fivetran.fivetran_list_all_users

Parameter	Type	Required	Description
No parameters.

invite_user Write

Invite a User Official Fivetran endpoint: POST /v1/users Invites a new user to your Fivetran account. The invited user will have access to the account only after accepting the invitation. Invited user details are stil...

Lua path: app.integrations.fivetran.invite_user
Full name: fivetran.fivetran_create_user

Parameter	Type	Required	Description
No parameters.

delete_account_role Write

Delete Account Role Official Fivetran endpoint: DELETE /v1/users/{userId}/role Removes a user's role from an account, but the user remains a member of the account.

Lua path: app.integrations.fivetran.delete_account_role
Full name: fivetran.fivetran_delete_user_membership_in_account

Parameter	Type	Required	Description
No parameters.

download_connector_sdk_package Read

Download Connector SDK Package Official Fivetran endpoint: GET /v1/connector-sdk/packages/{package_id}/download Downloads the connector code package file (code.zip) for a specific Connector SDK package. This endpoint ...

Lua path: app.integrations.fivetran.download_connector_sdk_package
Full name: fivetran.fivetran_download_connector_sdk_package

Parameter	Type	Required	Description
No parameters.

test_webhook Write

Test a Webhook Official Fivetran endpoint: POST /v1/webhooks/{webhookId}/test The endpoint allows you to test an existing webhook. It sends a webhook with a given identifier for a dummy connection with identifier _con...

Lua path: app.integrations.fivetran.test_webhook
Full name: fivetran.fivetran_test_webhook

Parameter	Type	Required	Description
No parameters.

run_transformation Write

Run Transformation Official Fivetran endpoint: POST /v1/transformations/{transformationId}/run Runs the transformation if a valid identifier is provided.

Lua path: app.integrations.fivetran.run_transformation
Full name: fivetran.fivetran_run_transformation

Parameter	Type	Required	Description
No parameters.

list_all_connection_memberships Read

List All Connection Memberships Official Fivetran endpoint: GET /v1/teams/{teamId}/connections Returns all connections a team has membership in.

Lua path: app.integrations.fivetran.list_all_connection_memberships
Full name: fivetran.fivetran_get_team_memberships_in_connections

Parameter	Type	Required	Description
No parameters.

add_connection_membership Write

Add Connection Membership Official Fivetran endpoint: POST /v1/teams/{teamId}/connections Adds a team as a member of a connection.

Lua path: app.integrations.fivetran.add_connection_membership
Full name: fivetran.fivetran_add_team_membership_in_connection

Parameter	Type	Required	Description
No parameters.

re_sync_connection_table_data Write

Re-sync Connection Table Data Official Fivetran endpoint: POST /v1/connections/{connectionId}/schemas/tables/resync Triggers a historical sync of all data for multiple schema tables within a connection. This action do...

Lua path: app.integrations.fivetran.re_sync_connection_table_data
Full name: fivetran.fivetran_resync_tables

Parameter	Type	Required	Description
No parameters.

reload_connection_schema_config Write

Reload a Connection Schema Config Official Fivetran endpoint: POST /v1/connections/{connectionId}/schemas/reload Reloads the connection schema config for an existing connection within your Fivetran account. > NOTE: Th...

Lua path: app.integrations.fivetran.reload_connection_schema_config
Full name: fivetran.fivetran_reload_connection_schema_config

Parameter	Type	Required	Description
No parameters.

list_all_transformations Read

List all Transformations Official Fivetran endpoint: GET /v1/transformations Returns a list of all transformations within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_transformations
Full name: fivetran.fivetran_transformations_list

Parameter	Type	Required	Description
No parameters.

create_transformation Write

Create a Transformation Official Fivetran endpoint: POST /v1/transformations Creates a new transformation.

Lua path: app.integrations.fivetran.create_transformation
Full name: fivetran.fivetran_create_transformation

Parameter	Type	Required	Description
No parameters.

register_hub Write

Lua path: app.integrations.fivetran.register_hub
Full name: fivetran.fivetran_hvr_register_hub

Parameter	Type	Required	Description
No parameters.

cancel_running_transformation Write

Cancel Running Transformation Official Fivetran endpoint: POST /v1/transformations/{transformationId}/cancel Cancels the execution of the transformation if a valid identifier is provided.

Lua path: app.integrations.fivetran.cancel_running_transformation
Full name: fivetran.fivetran_cancel_transformation

Parameter	Type	Required	Description
No parameters.

retrieve_transformation_project_details Read

Retrieve Transformation Project Details Official Fivetran endpoint: GET /v1/transformation-projects/{projectId} Returns transformation project details if a valid identifier was provided.

Lua path: app.integrations.fivetran.retrieve_transformation_project_details
Full name: fivetran.fivetran_transformation_project_details

Parameter	Type	Required	Description
No parameters.

delete_transformation_project Write

Delete Transformation Project Official Fivetran endpoint: DELETE /v1/transformation-projects/{projectId} Deletes transformation project if a valid identifier was provided.

Lua path: app.integrations.fivetran.delete_transformation_project
Full name: fivetran.fivetran_delete_transformation_project

Parameter	Type	Required	Description
No parameters.

update_transformation_project Write

Update Transformation Project Official Fivetran endpoint: PATCH /v1/transformation-projects/{projectId} Updates transformation project if a valid identifier was provided.

Lua path: app.integrations.fivetran.update_transformation_project
Full name: fivetran.fivetran_modify_transformation_project

Parameter	Type	Required	Description
No parameters.

retrieve_group_service_account Read

Retrieve Group Service Account Official Fivetran endpoint: GET /v1/groups/{groupId}/service-account Returns Fivetran service account associated with the group.

Lua path: app.integrations.fivetran.retrieve_group_service_account
Full name: fivetran.fivetran_group_service_account

Parameter	Type	Required	Description
No parameters.

retrieve_webhook_details Read

Retrieve Webhook Details Official Fivetran endpoint: GET /v1/webhooks/{webhookId} This endpoint allows you to retrieve details of the existing webhook for a given identifier

Lua path: app.integrations.fivetran.retrieve_webhook_details
Full name: fivetran.fivetran_webhook_details

Parameter	Type	Required	Description
No parameters.

delete_webhook Write

Delete a Webhook Official Fivetran endpoint: DELETE /v1/webhooks/{webhookId} This endpoint allows you to delete an existing webhook with a given identifier

Lua path: app.integrations.fivetran.delete_webhook
Full name: fivetran.fivetran_delete_webhook

Parameter	Type	Required	Description
No parameters.

update_webhook Write

Update a Webhook Official Fivetran endpoint: PATCH /v1/webhooks/{webhookId} The endpoint allows you to update the existing webhook with a given identifier

Lua path: app.integrations.fivetran.update_webhook
Full name: fivetran.fivetran_modify_webhook

Parameter	Type	Required	Description
No parameters.

retrieve_group_membership_details Read

Retrieve Group Membership Details Official Fivetran endpoint: GET /v1/users/{userId}/groups/{groupId} Returns details of a user membership in group.

Lua path: app.integrations.fivetran.retrieve_group_membership_details
Full name: fivetran.fivetran_get_user_membership_in_group

Parameter	Type	Required	Description
No parameters.

delete_group_membership Write

Delete Group Membership Official Fivetran endpoint: DELETE /v1/users/{userId}/groups/{groupId} Removes user from a group.

Lua path: app.integrations.fivetran.delete_group_membership
Full name: fivetran.fivetran_delete_user_membership_in_group

Parameter	Type	Required	Description
No parameters.

update_group_membership Write

Update Group Membership Official Fivetran endpoint: PATCH /v1/users/{userId}/groups/{groupId} Updates user group membership.

Lua path: app.integrations.fivetran.update_group_membership
Full name: fivetran.fivetran_update_user_membership_in_group

Parameter	Type	Required	Description
No parameters.

run_connection_setup_tests Write

Run Connection Setup Tests Official Fivetran endpoint: POST /v1/connections/{connectionId}/test Runs the setup tests for an existing connection within your Fivetran account. Use this parameter to test the connection w...

Lua path: app.integrations.fivetran.run_connection_setup_tests
Full name: fivetran.fivetran_run_setup_tests

Parameter	Type	Required	Description
No parameters.

returns_hybrid_deployment_agent_details Read

Returns Hybrid Deployment Agent Details Official Fivetran endpoint: GET /v1/hybrid-deployment-agents/{agentId} Returns Hybrid Deployment Agent Details.

Lua path: app.integrations.fivetran.returns_hybrid_deployment_agent_details
Full name: fivetran.fivetran_get_hybrid_deployment_agent

Parameter	Type	Required	Description
No parameters.

delete_hybrid_deployment_agent Write

Delete a Hybrid Deployment Agent Official Fivetran endpoint: DELETE /v1/hybrid-deployment-agents/{agentId} Delete a Hybrid Deployment Agent.

Lua path: app.integrations.fivetran.delete_hybrid_deployment_agent
Full name: fivetran.fivetran_delete_hybrid_deployment_agent

Parameter	Type	Required	Description
No parameters.

list_all_proxy_agents Read

List all Proxy Agents Official Fivetran endpoint: GET /v1/proxy Returns a list of all proxy agents within your Fivetran account.

Lua path: app.integrations.fivetran.list_all_proxy_agents
Full name: fivetran.fivetran_get_proxy_agent

Parameter	Type	Required	Description
No parameters.

create_proxy_agent Write

Create a Proxy Agent Official Fivetran endpoint: POST /v1/proxy Creates a new proxy agent within your Fivetran account.

Lua path: app.integrations.fivetran.create_proxy_agent
Full name: fivetran.fivetran_create_proxy_agent

Parameter	Type	Required	Description
No parameters.

run_destination_setup_tests Write

Run Destination Setup Tests Official Fivetran endpoint: POST /v1/destinations/{destinationId}/test Runs the setup tests for an existing destination within your Fivetran account.

Lua path: app.integrations.fivetran.run_destination_setup_tests
Full name: fivetran.fivetran_run_destination_setup_tests

Parameter	Type	Required	Description
No parameters.

list_all_private_links Read

List All Private Links Official Fivetran endpoint: GET /v1/private-links Returns a list of all private links.

Lua path: app.integrations.fivetran.list_all_private_links
Full name: fivetran.fivetran_get_private_links

Parameter	Type	Required	Description
No parameters.

create_private_link Write

Create a Private Link Official Fivetran endpoint: POST /v1/private-links Creates a new private link in your Fivetran account. > NOTE: See the [Set Up a Connection With Private Links tutorial](/docs/rest-api/tutorials/...

Lua path: app.integrations.fivetran.create_private_link
Full name: fivetran.fivetran_create_private_link

Parameter	Type	Required	Description
No parameters.

list_all_user_memberships Read

List All User Memberships Official Fivetran endpoint: GET /v1/teams/{teamId}/users Returns a list of users and their roles within a team in your Fivetran account

Lua path: app.integrations.fivetran.list_all_user_memberships
Full name: fivetran.fivetran_list_users_in_team

Parameter	Type	Required	Description
No parameters.

add_user_team Write

Add a User to the Team Official Fivetran endpoint: POST /v1/teams/{teamId}/users Assigns a role for a user in a team.

Lua path: app.integrations.fivetran.add_user_team
Full name: fivetran.fivetran_add_user_to_team

Parameter	Type	Required	Description
No parameters.

retrieve_connection_membership Read

Retrieve Connection Membership Official Fivetran endpoint: GET /v1/users/{userId}/connections/{connectionId} Returns the details of a user's membership in a connection.

Lua path: app.integrations.fivetran.retrieve_connection_membership
Full name: fivetran.fivetran_get_user_membership_in_connections

Parameter	Type	Required	Description
No parameters.

delete_connection_membership Write

Delete Connection Membership Official Fivetran endpoint: DELETE /v1/users/{userId}/connections/{connectionId} Removes user membership in a connection.

Lua path: app.integrations.fivetran.delete_connection_membership
Full name: fivetran.fivetran_delete_user_membership_in_connection

Parameter	Type	Required	Description
No parameters.

update_connection_membership Write

Update Connection Membership Official Fivetran endpoint: PATCH /v1/users/{userId}/connections/{connectionId} Updates user membership in a connection.

Lua path: app.integrations.fivetran.update_connection_membership
Full name: fivetran.fivetran_update_user_membership_in_connection

Parameter	Type	Required	Description
No parameters.

retrieve_destination_details Read

Retrieve Destination Details Official Fivetran endpoint: GET /v1/destinations/{destinationId} Returns a destination object if a valid identifier was provided.

Lua path: app.integrations.fivetran.retrieve_destination_details
Full name: fivetran.fivetran_destination_details

Parameter	Type	Required	Description
No parameters.

delete_destination Write

Delete a Destination Official Fivetran endpoint: DELETE /v1/destinations/{destinationId} Deletes a destination from your Fivetran account.

Lua path: app.integrations.fivetran.delete_destination
Full name: fivetran.fivetran_delete_destination

Parameter	Type	Required	Description
No parameters.

update_destination Write

Update a Destination Official Fivetran endpoint: PATCH /v1/destinations/{destinationId} Updates information for an existing destination within your Fivetran account.

Lua path: app.integrations.fivetran.update_destination
Full name: fivetran.fivetran_modify_destination

Parameter	Type	Required	Description
No parameters.

retrieve_connector_configuration_metadata Read

Retrieve Connector Configuration Metadata Official Fivetran endpoint: GET /v1/metadata/connector-types/{service} Returns metadata of configuration parameters and authorization parameters for a specified connector type.

Lua path: app.integrations.fivetran.retrieve_connector_configuration_metadata
Full name: fivetran.fivetran_metadata_connector_config

Parameter	Type	Required	Description
No parameters.

delete_team_from_account Write

Delete Team from Account Official Fivetran endpoint: DELETE /v1/teams/{teamId}/role Removes a team from your Fivetran account

Lua path: app.integrations.fivetran.delete_team_from_account
Full name: fivetran.fivetran_delete_team_membership_in_account

Parameter	Type	Required	Description
No parameters.