General Destination Setup Guide

Prerequisites

A CloudQuery Platform account with admin access
Connection credentials for your destination (hostname, port, username, password, or connection string)

CloudQuery Platform includes a default ClickHouse database destination. All platform features — including SQL Console and Asset Inventory — depend on this destination. If you add another destination, keep the default ClickHouse destination as your primary. Additional destinations should serve as auxiliary targets.

Creating the destination

Go to Data Pipelines → Destinations and click Create Destination:

CloudQuery Platform Destinations page with the Create Destination button highlighted

Search for the name of your destination. In the example below, the search is for PostgreSQL. Click the destination card in the search results.

Search for destination

On the next screen, enter a Destination Name to identify the destination later (if unsure, use the name of the destination).

Destination setup form with a text field for entering a name to identify the destination

If applicable, fill out the YAML specification. The link to the integration documentation under the YAML input box will have more information about the format required.

Most destinations require authentication. Use the Secrets section to store sensitive values as environment variables. Reference them in the YAML configuration using placeholders such as ${MY_SECRET_VALUE}. This keeps credentials out of the YAML spec itself.

Secrets section for adding environment variable key-value pairs used for destination authentication

Testing your connection

To save the destination, click the Test Connection and save button. The platform validates your configuration by attempting to connect to the destination.

Test Connection and save

During the test:

A progress bar shows the test is running (tests can take up to 60 seconds)
If the test succeeds, the destination is saved
If the test fails, an error message and logs are displayed below the form

Common test connection failures

Issue	Cause	Fix
Connection refused	Destination is not reachable	Verify the hostname, port, and network connectivity from the platform to the destination
Authentication error	Invalid credentials	Check the username, password, or connection string in the Secrets section
Permission denied	User lacks write permissions	Verify the database user has permissions to create tables and insert data
SSL/TLS error	Certificate or encryption mismatch	Check SSL mode settings in the YAML configuration and verify the destination’s TLS configuration
Invalid YAML	Syntax error in the configuration	Check indentation and field names — refer to the destination’s documentation linked below the editor

You can re-run the test after making changes without leaving the page.

After your first sync

Once a sync completes, verify data is arriving at your destination. If you are using the default ClickHouse destination, open the SQL Console and run a query to confirm tables were created:


SHOW TABLES

You can also browse synced resources in the Asset Inventory.

Next steps

Set up a sync to schedule when your data is fetched and from which integration
Browse synced resources in the Asset Inventory
Run advanced queries in the SQL Console
Find destination-specific configuration options in the CloudQuery Hub