Proxy Agent

Represents a deployable agent that routes data securely between your sources and Fivetran. A proxy agent runs in your own infrastructure and can be attached to multiple source connections and destinations. Each agent is tied to a specific data processing region and maintains its own authentication credentials.

Resource attributes

The following attributes describe a proxy agent and the credentials issued when one is created or its secrets are regenerated.

Proxy agent attributes

Field name	Type	Description
`id`	string, read-only	Unique identifier of the proxy agent.
`display_name`	string	Name of the proxy agent.
`region`	string	Data processing region where the proxy agent operates.
`version`	string, read-only	Version of the proxy agent software.
`status`	string, read-only	Connection status of the proxy agent. Possible values: `CONNECTED` – The agent is connected and reachable. `NOT_CONNECTED` – The agent is registered but not connected. `NOT_FOUND` – The agent cannot be found.
`connector_count`	integer, read-only	Number of source connections using the proxy agent.
`destination_count`	integer, read-only	Number of destinations using the proxy agent.
`account_id`	string, read-only	Unique identifier of the account that owns the proxy agent.
`registered_at`	string, read-only	Date and time the proxy agent was registered, in ISO 8601 format.
`created_by`	string, read-only	Unique identifier of the user who created the proxy agent.

Credentials attributes

These attributes are returned when a proxy agent is created or its secrets are regenerated.

Field name	Type	Description
`agent_id`	string, read-only	Unique identifier of the newly created proxy agent.
`auth_token`	string, read-only	Authentication token used by the agent to connect to Fivetran.
`client_cert`	string, read-only	Client certificate for the proxy agent.
`client_private_key`	string, read-only	Client private key for the proxy agent.

Supported operations

Category	Endpoint	Description
List	`GET /v1/proxy`	Returns a paginated list of all proxy agents in the account.
Create	`POST /v1/proxy`	Creates a new proxy agent and returns its credentials.
Retrieve	`GET /v1/proxy/{agentId}`	Returns the details of a proxy agent, including its attached connections and destinations.
Delete	`DELETE /v1/proxy/{agentId}`	Deletes a proxy agent.
List connections	`GET /v1/proxy/{agentId}/connections`	Returns a paginated list of all connections attached to the proxy agent.
Regenerate secrets	`POST /v1/proxy/{agentId}/regenerate-secrets`	Regenerates the authentication credentials for a proxy agent.