How Do I Back up a Connection’s Schema?

Question

How do I backup my connection's schema before I edit it?

Environment

REST API - Applicable to all non-Magic Folder connectors.

Answer

Use our REST API to back up the connection's schema.

The Fivetran REST API is only available for Standard, Free, Enterprise, and Business Critical accounts.

Get API key and API secret

Log in to your Fivetran dashboard.
In the bottom left menu, click your username and then select API Key.
Click Generate API key.
Copy the API Key and API Secret.

You must be an Account Administrator on a Trial, Free, Standard, Enterprise, or Business Critical plan to access this information. If you are not an Account Administrator, ask someone who is an active Account Administrator to update your role by visiting Account Settings > Users & Permissions.

Encode API key and secret to Base64 format

Execute the following command in your terminal window. Replace the <API key> and <API secret> values with your API key and secret: echo -n '<API key>:<API secret>' | openssl base64.
Note the output. You must use the output as the Basic <output string> in Step 3.

Execute API request

Execute the following request in the application of your choice, such as curl or Postman: GET api.fivetran.com/v1/connections/{connection_id}/schemas. Use the Basic <output string> you found in Step 2.
Save the response in JSON format.

Reference documents

connections For more information about API connection configurations, read the following documents: