pyfivetran.endpoints.certificate

Module Contents

Classes

CertificateEndpoint

API

class pyfivetran.endpoints.certificate.CertificateEndpoint(client: pyfivetran.endpoints.base.Client)[source]

Bases: pyfivetran.endpoints.base.Endpoint

BASE_URL: str = None
approve_certificate(hash: str, encoded_cert: str | bytes, destination_id: Optional[str] = None, connector_id: Optional[str] = None) → pyfivetran.shed.GeneralApiResponse[source]

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

Parameters:

  • hash – Hash of the certificate

  • encoded_cert – The certificate encoded in base64, as a string or bytes

  • destination_id – Unique ID of the destination in Fivetran

  • connector_id – Unique ID of the connector in Fivetran

Returns:

GeneralApiResponse

approve_fingerprint(hash: str, public_key: str | bytes, connector_id: Optional[str] = None, destination_id: Optional[str] = None) → pyfivetran.shed.GeneralApiResponse[source]

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

Parameters:

  • hash – Hash of the fingerprint

  • public_key – The fingerprint encoded in base64, as a string or bytes

  • destination_id – Unique ID of the destination in Fivetran

  • connector_id – Unique ID of the connector in Fivetran

Returns:

GeneralApiResponse

get_certificate_details(hash: str | bytes, connector_id: Optional[str] = None, destination_id: Optional[str] = None) → pyfivetran.shed.GeneralApiResponse[source]

Get certificate details.

Parameters:

  • hash – Hash of the certificate

  • destination_id – Unique ID of the destination in Fivetran

  • connector_id – Unique ID of the connector in Fivetran

Returns:

GeneralApiResponse

get_fingerprint_details(hash: str | bytes, connector_id: Optional[str] = None, destination_id: Optional[str] = None) → pyfivetran.shed.GeneralApiResponse[source]

Get fingerprint details.

Parameters:

  • hash – Hash of the fingerprint

  • destination_id – Unique ID of the destination in Fivetran

  • connector_id – Unique ID of the connector in Fivetran

Returns:

GeneralApiResponse

get_fingerprints(connector_id: Optional[str] = None, destination_id: Optional[str] = None, limit: Optional[int] = None) → List[pyfivetran.shed.PaginatedApiResponse][source]

Get all fingerprints for a connector or destination.

Parameters:

  • connector_id – Unique ID of the connector in Fivetran

  • destination_id – Unique ID of the destination in Fivetran

  • limit – Number of results to return

Returns:

List[PaginatedApiResponse]

get_certificates(connector_id: Optional[str] = None, destination_id: Optional[str] = None, limit: Optional[int] = None) → List[pyfivetran.shed.PaginatedApiResponse][source]

Get all certificates for a connector or destination.

Parameters:

  • connector_id – Unique ID of the connector in Fivetran

  • destination_id – Unique ID of the destination in Fivetran

  • limit – Number of results to return

Returns:

List[PaginatedApiResponse]

revoke_certificate(hash: str | bytes, connector_id: Optional[str] = None, destination_id: Optional[str] = None) → pyfivetran.shed.GeneralApiResponse[source]

Revoke a certificate.

Parameters:

  • hash – Hash of the certificate

  • destination_id – Unique ID of the destination in Fivetran

  • connector_id – Unique ID of the connector in Fivetran

Returns:

GeneralApiResponse

revoke_fingerprint(hash: str | bytes, connector_id: Optional[str] = None, destination_id: Optional[str] = None) → pyfivetran.shed.GeneralApiResponse[source]

Revoke a fingerprint.

Parameters:

  • hash – Hash of the fingerprint

  • destination_id – Unique ID of the destination in Fivetran

  • connector_id – Unique ID of the connector in Fivetran

Returns:

GeneralApiResponse