Approve a certificate for the connection

Approves a certificate, so Fivetran trusts this certificate for a source database connection. 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

Request schema

Path parameters

connectionId

stringrequired

The unique identifier for the connection within the Fivetran system.

example:

connectionId

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Request

hash

stringrequired

Hash of the certificate.

example:

jhg5UI7fgrI6yy...

encoded_cert

stringrequired

The certificate encoded in base64.

example:

MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV...

Http + 1.1

POST

https://api.fivetran.com/v1/connections/connectionId/certificates

POST /v1/connections/connectionId/certificates HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 119

{
  "hash": "jhg5UI7fgrI6yy...",
  "encoded_cert": "MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV..."
}

Responses

200

Successful response

400

Missing `hash` or `encoded_cert` fields in request payload

404

Connection not found

Successful response schema

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

Operation performed.

data

objectrequired

stringrequired

The unique identifier of the certificate (Base64URL encoded hash of the certificate).

example:

Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g

name

stringrequired

The certificate name.

example:

Certificate Name

hash

stringrequired

Hash of the certificate.

example:

jhg5UI7fgrI6yy...

type

stringrequired

Type of the certificate.

example:

TLS

sha1

stringrequired

SHA1 of certificate.

example:

c8de1d13vtu435ilj435lj345796d8jh7hk8hgk

sha256

stringrequired

SHA256 of certificate.

example:

5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f

validated_date

stringrequired

Date when certificate has been validated and approved.

format:

date-time

example:

2023-08-20T10:15:20.677566Z

validated_by

stringrequired

The unique identified for the user who has approved the certificate.

example:

user_id

public_key

stringrequired

The certificate decoded public key.

example:

Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537

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