connection_fingerprints
Creates, updates, deletes, gets or lists a connection_fingerprints resource.
Overview
| Name | connection_fingerprints |
| Type | Resource |
| Id | fivetran.certificates.connection_fingerprints |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint). (example: Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g) |
hash | string | Hash of the fingerprint. (example: eUtPirI6yy...) |
public_key | string | The SSH public key. (example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key) |
validated_by | string | The unique identified for the user who has approved the fingerprint. (example: user_id) |
validated_date | string (date-time) | Date when fingerprint has been validated and approved. (example: 2024-01-01T00:00:00Z) |
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint). (example: Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g) |
hash | string | Hash of the fingerprint. (example: eUtPirI6yy...) |
public_key | string | The SSH public key. (example: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key) |
validated_by | string | The unique identified for the user who has approved the fingerprint. (example: user_id) |
validated_date | string (date-time) | Date when fingerprint has been validated and approved. (example: 2024-01-01T00:00:00Z) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | connection_id, hash | Returns SSH fingerprint details approved for specified connection with specified hash | |
list | select | connection_id | cursor, limit | Returns the list of approved SSH fingerprints for specified connection |
create | insert | connection_id, hash, public_key | Approves a fingerprint, enabling Fivetran to trust it for a source database and establish connections via an SSH tunnel. | |
delete | delete | connection_id, hash | Revokes a fingerprint, so Fivetran no longer trusts it while connecting to the source database through an SSH tunnel. |
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 |
|---|---|---|
connection_id | string | The unique identifier of the connection. Retrieve it from the id field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the id field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection). |
hash | string | The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint). |
cursor | string | Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination) |
limit | integer (int32) | Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100. |
SELECT examples
- get
- list
Returns SSH fingerprint details approved for specified connection with specified hash
SELECT
id,
hash,
public_key,
validated_by,
validated_date
FROM fivetran.certificates.connection_fingerprints
WHERE connection_id = '{{ connection_id }}' -- required
AND hash = '{{ hash }}' -- required
;
Returns the list of approved SSH fingerprints for specified connection
SELECT
id,
hash,
public_key,
validated_by,
validated_date
FROM fivetran.certificates.connection_fingerprints
WHERE connection_id = '{{ connection_id }}' -- required
AND "limit" = '{{ limit }}'
;
INSERT examples
- create
- Manifest
Approves a fingerprint, enabling Fivetran to trust it for a source database and establish connections via an SSH tunnel.
INSERT INTO fivetran.certificates.connection_fingerprints (
hash,
public_key,
connection_id
)
SELECT
'{{ hash }}' /* required */,
'{{ public_key }}' /* required */,
'{{ connection_id }}'
;
# Description fields are for documentation purposes
- name: connection_fingerprints
props:
- name: connection_id
value: "{{ connection_id }}"
description: Required parameter for the connection_fingerprints resource.
- name: hash
value: "{{ hash }}"
description: |
Hash of the fingerprint.
- name: public_key
value: "{{ public_key }}"
description: |
The SSH public key.
DELETE examples
- delete
Revokes a fingerprint, so Fivetran no longer trusts it while connecting to the source database through an SSH tunnel.
DELETE FROM fivetran.certificates.connection_fingerprints
WHERE connection_id = '{{ connection_id }}' --required
AND hash = '{{ hash }}' --required
;