Certificate Managementlink

REST API supports the following certificate management actions:

• Approve a connector certificate
• Approve a connector fingerprint
• List all approved certificates for connector
• List all approved fingerprints for connector
• Retrieve a connector certificate details
• Retrieve a connector fingerprint details
• Revoke a connector certificate
• Revoke a connector fingerprint
• Approve a destination certificate
• Approve a destination fingerprint
• List all approved certificates for destination
• List all approved fingerprints for destination
• Retrieve a destination certificate details
• Retrieve a destination fingerprint details
• Revoke a destination certificate
• Revoke a destination fingerprint

Approve a connector certificatelink

Approves a certificate for a connector, so Fivetran trusts this certificate for a source database. The connector setup tests will fail if a non-approved certificate is provided.

Requestlink

POST https://api.fivetran.com/v1/connectors/{connectorId}/certificates

{
    "hash": "r+u4QL4MGvZe...",
    "encoded_cert": "MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBgNVBAcMB1NlYXR0bGUxIjAgBgNVBAoMGUFtYXpvbiBXZWIgU2VydmljZXMsIEluYy4xEzARBgNVBAsMCkFtYXpvbiBSRFMxGzAZBgNVBAMMEkFtYXpvbiBSRF..."
}
content_copy

Path parameterslink

Payload parameterslink

Responselink

HTTP 201 Created

{
  "code": "Success",
  "message": "The certificate has been approved",
  "data":{
    "hash":"eUtPirI6yy...",
    "public_key":"Sun RSA public key, 2048 bits params: null modulus: 237843284... public exponent: 65537",
    "name": "certificate_name",
    "type": "TLS",
    "validated_date":"2023-09-25T15:05:55.680295Z",
    "validated_by":"user_id",
    "sha1": "c8de1d13ad359b3dea182acb4796d2247753c4a",
    "sha256": "3b113a06ebc63eef94ec3f91122a623b389f4d331ff330026e43af2101329f5d"
  }
}
content_copy

Get connector certificate detailslink

NOTE: If you want to get the certificate details, do not set "trust_certficates": true when you create a database connector with our REST API. We can only provide the certificate details via the failed Validate Certificate setup test.

1. When creating a database connector using our REST API, either set "trust_certficates": false or omit the field in the Create a Connector endpoint request.

   The setup test verifying the certificate will fail with a message that includes the hash and encoded_cert parameters you need:

   {
       "code": "Success",
       "message": "Connector has been created",
       "data": {
           ...,
   
           "setup_tests": [
               ...,
               {
                   "title": "Validate Certificate",
                   "status": "FAILED",
                   "message": "No trust anchors for this connection",
                   "details": [
                       {
                           "hash": "r+u4QL4MGvZeY+DL15zONWVL...",
                           "name": "CN=Amazon RDS Root CA, OU=Amazon RDS, O=\"Amazon Web Services, Inc.\", L=Seattle, ST=Washington, C=US",
                           "public_key": "Sun RSA public key, 2048 bits\n  modulus: 2325899...\n  public exponent: 65537",
                           "encoded_cert": "MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMA...",
                           "sha1": "e8118856e7a7ce3...",
                           "sha256": "afebb840be0c1af65e63e0cbd79c..."
                       }
                   ]
               }
           ],
   
           ...
       }
   }
   
   content_copy

2. After you get the failed test message, note the values of hash and encoded_cert.

3. Send a POST request to the Fivetran API certificates endpoint with the hash and encoded_cert values you obtained.

Approve a connector fingerprintlink

Approves a fingerprint, so Fivetran trusts this fingerprint for a source database, and the connector can connect to the source through an SSH tunnel. The connector setup tests will fail if a non-approved fingerprint is provided.

Requestlink

POST https://api.fivetran.com/v1/connectors/{connector_id}/fingerprints

{
    "hash": "eUtPirI6yy...",
    "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key"
}
content_copy

Path parameterslink

Payload parameterslink

Responselink

HTTP 201 Created

{
  "code":"Success",
  "message":"The fingerprint has been approved.",
  "data":{
    "hash":"eUtPirI6yy...",
    "public_key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key",
    "validated_date":"2023-09-25T15:05:55.680295Z",
    "validated_by":"user_id"
  }
}
content_copy

Get connector fingerprint detailslink

NOTE: If you want to get the fingerprint details, do not set "trust_fingerprints": true when you create a database connector with our REST API. We can only provide the fingerprint details via the failed SSH Tunnel Connection setup test.

1. When creating a connector using our REST API, either set "trust_certficates": false or omit the field in the Create a Connector endpoint request.

   The setup test verifying the fingerprint will fail with a message that includes the hash and public_key parameters you need:

   {
       "code": "Success",
       "message": "Connector has been created",
       "data": {
           ...,
           "setup_tests": [
               {
                   "title": "SSH Tunnel Connection",
                   "status": "FAILED",
                   "message": "The ssh key might have changed",
                   "details": {
                       "hash": "eUtPirI6yy...",
                       "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key",
                       "type": "ssh-rsa",
                       "name": "fivetran user key"
                   }
               }
           ],
   
           ...
       }
   }
   
   content_copy

2. After you get the failed test message, note the values of hash and public_key.

3. Send a POST request to the Approve a Connector Fingerprint endpoint with the hash and public_key you just obtained.

List all approved certificates for connectorlink

Returns a list of all approved certificates for specified connector.

Requestlink

GET https://api.fivetran.com/v1/connectors/{connector_id}/certificates

Path parameterslink

Query parameterslink

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "items": [
          {
            "hash":"jhg5UI7fgrI6yy...",
            "public_key":"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537",
            "name": "certificate_name",
            "type": "TLS",
            "validated_date":"2023-08-20T10:15:20.677566Z",
            "validated_by":"user_id",
            "sha1": "c8de1d13vtu435ilj435lj345796d8jh7hk8hgk",
            "sha256": "5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f"
          },
          {
            "hash":"eUtPirI6iu8nl7m...",
            "public_key":"Sun RSA public key, 2048 bits params: null modulus: 237843284... public exponent: 65537",
            "name": "certificate_name",
            "type": "TLS",
            "validated_date":"2023-09-25T15:05:55.680295Z",
            "validated_by":"user_id",
            "sha1": "c8de1d13ad359b3dea182acb4796d2247753c4a",
            "sha256": "3b113a06ebc63eef94ec3f91122a623b389f4d331ff330026e43af2101329f5d"
          },
          ...
        ],
        "next_cursor": "tg8hs54kjl8b24"
    }
}
content_copy

List all approved fingerprints for connectorlink

Returns a list of all approved fingerprints for specified connector.

Requestlink

GET https://api.fivetran.com/v1/connectors/{connector_id}/fingerprints

Path parameterslink

Query parameterslink

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "items": [
          {
            "hash":"jhgfJfgrI6yy...",
            "public_key":"ssh-rsa CCCCB3NzaC1yc2ECCASFWFWDFRWT5WAS ... fivetran user key",
            "validated_date":"2023-09-20T10:06:50.965545Z",
            "validated_by":"user_id"
          },
          {
            "hash":"eUtPirI6yy...",
            "public_key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key",
            "validated_date":"2023-09-25T15:05:55.680295Z",
            "validated_by":"user_id"
          },
          ...
        ],
        "next_cursor": "kyJza2lwIjoyfQ"
    }
}
content_copy

Retrieve a connector certificate detailslink

Returns certificate details if a valid connector identifier and key hash were provided.

Requestlink

GET https://api.fivetran.com/v1/connectors/{connector_id}/certificates/{hash}

Path parameterslink

Responselink

HTTP 200 OK

{
  "code":"Success",
  "data":{
    "hash":"jhg5UI7fgrI6yy...",
    "public_key":"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537",
    "name": "certificate_name",
    "type": "TLS",
    "validated_date":"2023-08-20T10:15:20.677566Z",
    "validated_by":"user_id",
    "sha1": "c8de1d13vtu435ilj435lj345796d8jh7hk8hgk",
    "sha256": "5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f"
  }
}
content_copy

Retrieve a connector fingerprint detailslink

Returns fingerprint details if a valid connector identifier and key hash were provided.

Requestlink

GET https://api.fivetran.com/v1/connectors/{connector_id}/fingerprints/{hash}

Path parameterslink

Responselink

HTTP 200 OK

{
  "code":"Success",
  "data":{
    "hash":"eUtPirI6yy...",
    "public_key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key",
    "validated_date":"2023-09-25T15:05:55.680295Z",
    "validated_by":"user_id"
  }
}
content_copy

Revoke a connector certificatelink

Revokes a certificate, so Fivetran no longer trusts it while connecting to the source database.

Requestlink

DELETE https://api.fivetran.com/v1/connectors/{connector_id}/certificates/{hash}

Path parameterslink

Responselink

HTTP 200 OK

{
    "code": "Success",
    "message": "Certificate with hash 'hash' has been revoked for connector with id 'connector_id'"
}
content_copy

Revoke a connector fingerprintlink

Revokes a fingerprint, so Fivetran no longer trusts it while connecting to the source database through an SSH tunnel.

Requestlink

DELETE https://api.fivetran.com/v1/connectors/{connector_id}/fingerprints/{hash}

Path parameterslink

Responselink

HTTP 200 OK

{
    "code": "Success",
    "message": "Fingerprint with hash 'hash' has been revoked for connector with id 'connector_id'"
}
content_copy

Approve a destination certificatelink

Approves a certificate for a destination, so Fivetran trusts this certificate for a destination database. The destination setup tests will fail if a non-approved certificate is provided.

NOTE: This is only required for destinations based on the following databases:

• MySQL
• PostgreSQL
• SQLServer

Requestlink

POST https://api.fivetran.com/v1/destinations/{destinationId}/certificates

{
    "hash": "r+u4QL4MGvZe...",
    "encoded_cert": "MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBgNVBAcMB1NlYXR0bGUxIjAgBgNVBAoMGUFtYXpvbiBXZWIgU2VydmljZXMsIEluYy4xEzARBgNVBAsMCkFtYXpvbiBSRFMxGzAZBgNVBAMMEkFtYXpvbiBSRF..."
}
content_copy

Path parameterslink

Payload parameterslink

Responselink

HTTP 201 Created

{
    "code": "Success",
    "message": "The certificate has been approved",
    "data": {
      "hash":"jhg5UI7fgrI6yy...",
      "public_key":"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537",
      "name": "CN=Amazon RDS Root CA ...",
      "type": "TLS",
      "validated_date":"2023-08-20T10:15:20.677566Z",
      "validated_by":"user_id",
      "sha1": "c8de1d13vtu435ilj435lj345796d8jh7hk8hgk",
      "sha256": "5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f"
    }
}
content_copy

Get destination certificate detailslink

NOTE: If you want to get the certificate details, do not set "trust_certficates": true when you create a destination with our REST API. We can only provide the certificate details via the failed Validate Certificate setup test.

1. When creating a destination using our REST API, either set "trust_certficates": false or omit the field in the Create a Destination endpoint request.

   The setup test verifying the certificate will fail with a message that includes the hash and encoded_cert parameters you need:

   {
       "code": "Success",
       "message": "Destination has been created",
       "data": {
           ...,
   
           "setup_tests": [
               ...,
               {
                   "title": "Validate Certificate",
                   "status": "FAILED",
                   "message": "No trust anchors for this connection",
                   "details": [
                       {
                           "hash": "r+u4QL4MGvZeY+DL15zONWVL...",
                           "name": "CN=Amazon RDS Root CA, OU=Amazon RDS, O=\"Amazon Web Services, Inc.\", L=Seattle, ST=Washington, C=US",
                           "public_key": "Sun RSA public key, 2048 bits\n  modulus: 2325899...\n  public exponent: 65537",
                           "encoded_cert": "MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMA...",
                           "sha1": "e8118856e7a7ce3...",
                           "sha256": "afebb840be0c1af65e63e0cbd79c..."
                       }
                   ]
               }
           ],
   
           ...
       }
   }
   
   content_copy

2. After you get the failed test message, note the values of hash and encoded_cert.

3. Send a POST request to the Approve a Destination Certificate endpoint with the hash and encoded_cert you just obtained.

Approve a destination fingerprintlink

Approves a fingerprint, so Fivetran trusts this fingerprint for a destination database, and connectors can connect to the destination through an SSH tunnel. The destination setup tests will fail if a non-approved fingerprint is provided.

Requestlink

POST https://api.fivetran.com/v1/destinations/{detinationId}/fingerprints

{
    "hash": "eUtPirI6yy...",
    "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key"
}
content_copy

Path parameterslink

Payload parameterslink

Responselink

HTTP 201 Created

{
  "code":"Success",
  "message":"The fingerprint has been approved.",
  "data":{
    "hash":"eUtPirI6yy...",
    "public_key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key",
    "validated_date":"2023-09-25T15:05:55.680295Z",
    "validated_by":"user_id"
  }
}
content_copy

Get destination fingerprint detailslink

NOTE: If you want to get the fingerpint details, do not set "trust_fingerprints": true when you create a destination with our REST API. We can only provide the fingerprint details via the failed SSH Tunnel Connection setup test.

1. When creating a destination using our REST API, either set "trust_certficates": false or omit the field in the Create a Destination endpoint request.

   The setup test verifying the fingerprint will fail with a message that includes the hash and public_key parameters you need:

   {
       "code": "Success",
       "message": "Destination has been created",
       "data": {
           ...,
           "setup_tests": [
               {
                   "title": "SSH Tunnel Connection",
                   "status": "FAILED",
                   "message": "The ssh key might have changed",
                   "details": {
                       "hash": "eUtPirI6yy...",
                       "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key",
                       "type": "ssh-rsa",
                       "name": "fivetran user key"
                   }
               }
           ],
   
           ...
       }
   }
   
   content_copy

2. After you get the failed test message, note the values of hash and public_key.

3. Send a POST request to the Fivetran API fingerprints endpoint with the hash and public_key you just obtained.

List all approved certificates for destinationlink

Returns a list of all approved certificates for specified destination.

Requestlink

GET https://api.fivetran.com/v1/destination/{destinationId}/certificates

Path parameterslink

Query parameterslink

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "items": [
          {
            "hash":"jhg5UI7fgrI6yy...",
            "public_key":"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537",
            "name": "certificate_name",
            "type": "TLS",
            "validated_date":"2023-08-20T10:15:20.677566Z",
            "validated_by":"user_id",
            "sha1": "c8de1d13vtu435ilj435lj345796d8jh7hk8hgk",
            "sha256": "5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f"
          },
          {
            "hash":"eUtPirI6iu8nl7m...",
            "public_key":"Sun RSA public key, 2048 bits params: null modulus: 237843284... public exponent: 65537",
            "name": "certificate_name",
            "type": "TLS",
            "validated_date":"2023-09-25T15:05:55.680295Z",
            "validated_by":"user_id",
            "sha1": "c8de1d13ad359b3dea182acb4796d2247753c4a",
            "sha256": "3b113a06ebc63eef94ec3f91122a623b389f4d331ff330026e43af2101329f5d"
          },
          ...
        ],
        "next_cursor": "tg8hs54kjl8b24"
    }
}
content_copy

List all approved fingerprints for destinationlink

Returns a list of all approved fingerprints for specified destination.

Requestlink

GET https://api.fivetran.com/v1/destinations/{destination_id}/fingerprints

Path parameterslink

Query parameterslink

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "items": [
          {
            "hash":"jhgfJfgrI6yy...",
            "public_key":"ssh-rsa CCCCB3NzaC1yc2ECCASFWFWDFRWT5WAS ... fivetran user key",
            "validated_date":"2023-09-20T10:06:50.965545Z",
            "validated_by":"user_id"
          },
          {
            "hash":"eUtPirI6yy...",
            "public_key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key",
            "validated_date":"2023-09-25T15:05:55.680295Z",
            "validated_by":"user_id"
          },
          ...
        ],
        "next_cursor": "kyJza2lwIjoyfQ"
    }
}
content_copy

Retrieve a destination certificate detailslink

Returns certificate details if a valid destination identifier and certificate hash were provided.

Requestlink

GET https://api.fivetran.com/v1/destination/{destinationId}/certificates/{hash}

Path parameterslink

Responselink

HTTP 200 OK

{
  "code":"Success",
  "data":{
    "hash":"jhg5UI7fgrI6yy...",
    "public_key":"Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537",
    "name": "certificate_name",
    "type": "TLS",
    "validated_date":"2023-08-20T10:15:20.677566Z",
    "validated_by":"user_id",
    "sha1": "c8de1d13vtu435ilj435lj345796d8jh7hk8hgk",
    "sha256": "5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f"
  }
}
content_copy

Retrieve a destination fingerprint detailslink

Returns fingerprint details if a valid destination identifier and key hash were provided.

Requestlink

GET https://api.fivetran.com/v1/destinations/{destination_id}/fingerprints/{hash}

Path parameterslink

Responselink

HTTP 200 OK

{
  "code":"Success",
  "data":{
    "hash":"eUtPirI6yy...",
    "public_key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key",
    "validated_date":"2023-09-25T15:05:55.680295Z",
    "validated_by":"user_id"
  }
}
content_copy

Revoke a destination certificatelink

Revokes a certificate, so Fivetran no longer trusts it while connecting to the destination database.

Requestlink

DELETE https://api.fivetran.com/v1/destinations/{destination_id}/certificates/{hash}

Path parameterslink

Responselink

HTTP 200 OK

{
    "code": "Success",
    "message": "Certificate with hash 'hash' has been revoked for destination with id 'destination_id'"
}
content_copy

Revoke a destination fingerprintlink

Revokes a fingerprint, so Fivetran no longer trusts it while connecting to the destination database through an SSH tunnel.

Requestlink

DELETE https://api.fivetran.com/v1/destinations/{destination_id}/fingerprints/{hash}

Path parameterslink

Responselink

HTTP 200 OK

{
    "code": "Success",
    "message": "Fingerprint with hash 'hash' has been revoked for destination with id 'destination_id'"
}
content_copy