agents

Creates, updates, deletes, gets or lists an agents resource.

Overview

Name	agents
Type	Resource
Id	fivetran.hybrid_deployment.agents

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The unique identifier for the hybrid deployment agent within the Fivetran system. (example: agent_id)
group_id	string	The unique identifier for the group within your Fivetran account. (example: group_id)
display_name	string	Hybrid Deployment Agent display name. (example: display_name)
created_by	string	The actor who created the Hybrid Deployment Agent (example: created_by)
deployment_type	string	Environment type. (DOCKER, PODMAN, KUBERNETES, SNOWPARK) (example: DOCKER)
enabled	boolean	The boolean value specifying whether the Hybrid Deployment Agent is enabled.
last_used_at	string (date-time)	The time this Hybrid Deployment Agent was last used. (example: 2024-12-01T15:43:29.013729Z)
online	boolean	The boolean value specifying whether the Hybrid Deployment Agent is online.
registered_at	string (date-time)	Time when this Hybrid Deployment Agent was created. (example: 2024-12-01T15:43:29.013729Z)
updated_at	string (date-time)	Time when this Hybrid Deployment Agent was updated. (example: 2024-12-01T15:43:29.013729Z)
usage	array
version	string	Version of the Hybrid Deployment Agent (example: version)

list

Name	Datatype	Description
id	string	The unique identifier for the hybrid deployment agent within the Fivetran system. (example: agent_id)
group_id	string	The unique identifier for the group within your Fivetran account. (example: group_id)
display_name	string	Hybrid Deployment Agent display name. (example: display_name)
created_by	string	The actor who created the Hybrid Deployment Agent (example: created_by)
deployment_type	string	Environment type. (DOCKER, PODMAN, KUBERNETES, SNOWPARK) (example: DOCKER)
enabled	boolean	The boolean value specifying whether the Hybrid Deployment Agent is enabled.
last_used_at	string (date-time)	The time this Hybrid Deployment Agent was last used. (example: 2024-12-01T15:43:29.013729Z)
online	boolean	The boolean value specifying whether the Hybrid Deployment Agent is online.
registered_at	string (date-time)	Time when this Hybrid Deployment Agent was created. (example: 2024-12-01T15:43:29.013729Z)
updated_at	string (date-time)	Time when this Hybrid Deployment Agent was updated. (example: 2024-12-01T15:43:29.013729Z)
usage	array
version	string	Version of the Hybrid Deployment Agent (example: version)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	agent_id		Returns Hybrid Deployment Agent Details.
list	select		group_id, cursor, limit	Returns list of all Hybrid Deployment Agents within your Fivetran account, along with usage. Optionally filtered to a single group.
create	insert	accept_terms, display_name, env_type		Creates a new Hybrid Deployment Agent in a group.
delete	delete	agent_id		Delete a Hybrid Deployment Agent.
re_auth	exec	agent_id		Regenerate authentication for a Hybrid Deployment Agent.
reset_credentials	exec	agent_id		Reset credentials for a Hybrid Deployment Agent.

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
agent_id	string	Hybrid Deployment Agent Id
cursor	string
group_id	string	The Fivetran Group Id. (wire: groupId)
limit	integer (int32)

SELECT examples

get

Returns Hybrid Deployment Agent Details.

SELECT
id,
group_id,
display_name,
created_by,
deployment_type,
enabled,
last_used_at,
online,
registered_at,
updated_at,
usage,
version
FROM fivetran.hybrid_deployment.agents
WHERE agent_id = '{{ agent_id }}' -- required
;

list

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

SELECT
id,
group_id,
display_name,
created_by,
deployment_type,
enabled,
last_used_at,
online,
registered_at,
updated_at,
usage,
version
FROM fivetran.hybrid_deployment.agents
WHERE group_id = '{{ group_id }}'
AND "limit" = '{{ limit }}'
;

INSERT examples

create

Creates a new Hybrid Deployment Agent in a group.

INSERT INTO fivetran.hybrid_deployment.agents (
group_id,
display_name,
env_type,
accept_terms,
auth_type
)
SELECT 
'{{ group_id }}',
'{{ display_name }}' /* required */,
'{{ env_type }}' /* required */,
{{ accept_terms }} /* required */,
'{{ auth_type }}'
RETURNING
id,
group_id,
display_name,
created_by,
deployment_type,
enabled,
files,
last_used_at,
online,
registered_at,
token,
updated_at,
version
;

Manifest

# Description fields are for documentation purposes
- name: agents
props:
  - name: group_id
    value: "{{ group_id }}"
    description: |
      The unique identifier for the group within your Fivetran account.
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Hybrid Deployment Agent display name.
  - name: env_type
    value: "{{ env_type }}"
    description: |
      Environment type.
    valid_values: ['DOCKER', 'PODMAN', 'KUBERNETES', 'SNOWPARK']
  - name: accept_terms
    value: {{ accept_terms }}
    description: |
      Boolean, must be true to indicate that the caller accepts the Fivetran On-Prem Software License Addendum.
  - name: auth_type
    value: "{{ auth_type }}"
    description: |
      Agent Auth Mode. Defines how agent should be authorised.
    valid_values: ['AUTO', 'MANUAL']

DELETE examples

delete

Delete a Hybrid Deployment Agent.

DELETE FROM fivetran.hybrid_deployment.agents
WHERE agent_id = '{{ agent_id }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

re_auth

Regenerate authentication for a Hybrid Deployment Agent.

EXEC fivetran.hybrid_deployment.agents.re_auth 
@agent_id='{{ agent_id }}' --required 
@@json=
'{
"auth_type": "{{ auth_type }}"
}'
;

reset_credentials

Reset credentials for a Hybrid Deployment Agent.

EXEC fivetran.hybrid_deployment.agents.reset_credentials 
@agent_id='{{ agent_id }}' --required
;