Hybrid Deployment Agent

Represents a Hybrid Deployment agent that runs in your own infrastructure and processes data locally before sending it to Fivetran. Hybrid Deployment agents allow you to keep data within your network while still using Fivetran for orchestration. Each agent is associated with a group and supports multiple deployment environments.

Resource attributes

The following attributes describe a Hybrid Deployment agent and the deployment files issued when one is created or re-authenticated.

Agent attributes

Field name	Type	Description
`id`	string, read-only	Unique identifier of the agent.
`display_name`	string	Display name of the agent.
`group_id`	string, read-only	Unique identifier of the group the agent belongs to.
`version`	string, read-only	Version of the agent software.
`enabled`	boolean, read-only	Indicates whether the agent is enabled.
`online`	boolean, read-only	Indicates whether the agent is online.
`deployment_type`	string, read-only	Environment in which the agent is deployed. Possible values: `DOCKER` – Deployed as a Docker container. `PODMAN` – Deployed using Podman. `KUBERNETES` – Deployed on Kubernetes. `SNOWPARK` – Deployed in Snowpark Container Services.
`registered_at`	string, read-only	Date and time the agent was created, in ISO 8601 format.
`last_used_at`	string, read-only	Date and time the agent was last used, in ISO 8601 format.
`updated_at`	string, read-only	Date and time the agent was last updated, in ISO 8601 format.
`created_by`	string, read-only	Unique identifier of the user who created the agent.

Deployment files attributes

These attributes are returned when an agent is created or re-authenticated. The files attributes are Base64-encoded.

Field name	Type	Description
`token`	string, read-only	Authentication token for the agent.
`files.config_json`	string, read-only	Base64-encoded content of the agent's `config.json` file.
`files.docker_compose_yaml`	string, read-only	Base64-encoded content of the agent's `docker-compose.yaml` file.
`files.auth_json`	string, read-only	Base64-encoded content of the agent's `auth.json` file.

Supported operations

Category	Endpoint	Description
List	`GET /v1/hybrid-deployment-agents`	Returns a paginated list of all Hybrid Deployment agents in the account. Optionally filtered to a single group.
Create	`POST /v1/hybrid-deployment-agents`	Creates a new Hybrid Deployment agent in a group and returns its deployment files.
Retrieve	`GET /v1/hybrid-deployment-agents/{agentId}`	Returns the details of a Hybrid Deployment agent, including its usage.
Delete	`DELETE /v1/hybrid-deployment-agents/{agentId}`	Deletes a Hybrid Deployment agent.
Regenerate authentication	`PATCH /v1/hybrid-deployment-agents/{agentId}/re-auth`	Regenerates authentication keys for a Hybrid Deployment agent and returns new deployment files.
Reset credentials	`POST /v1/hybrid-deployment-agents/{agentId}/reset-credentials`	Resets the credentials for a Hybrid Deployment agent.