Your First Sync

Set up your first sync and start querying cloud resources in CloudQuery Platform.

Prerequisites

• A CloudQuery Platform account (create one if you don’t have one)
• An activated platform installation (activate if not done)
• Credentials for at least one cloud provider (AWS, GCP, or Azure)

Step 1: Set up an integration

An integration connects CloudQuery Platform to a cloud provider. Choose your provider and follow the corresponding guide:

• AWS Integration: requires an IAM role with cross-account access
• GCP Integration: requires a service account with appropriate roles
• Azure Integration: requires a service principal with Reader access

If you want to start with a different provider, see the General Integration Setup Guide for instructions that apply to any supported source.

Step 2: Create a sync

A sync connects your integration to a destination and runs on a schedule.

1. Navigate to Data Pipelines → Integrations and click Create Integration.
2. Select Use existing integration and choose the integration you created in Step 1.
3. Select the default ClickHouse destination (included with CloudQuery Platform).
4. Give the sync a name.
5. Set a schedule: Daily is a good starting point. You can also set No schedule and trigger runs manually.
6. Click Save and run to start the sync immediately.

For a more detailed walkthrough of sync options, see Setting up a Sync.

Step 3: Monitor the sync

After starting the sync, the platform opens the Sync Runs page. Here you can see:

• The sync status (running, completed, failed)
• Duration and row counts
• Error details if the sync fails

The first sync may take several minutes depending on the number of resources in your cloud account.

Step 4: View your data

Once the sync completes, your cloud resources are available in two places:

Asset Inventory

Navigate to Asset Inventory in the sidebar. You should see your cloud resources organized by category (Compute, Storage, Networking, etc.). Use the search bar to find specific resources.

For more details, see Asset Inventory.

SQL Console

Navigate to SQL Console in the sidebar. Try a query against your synced data:

SELECT cloud, account, region, resource_type, count(*) as total
FROM cloud_assets
GROUP BY cloud, account, region, resource_type
ORDER BY total DESC
LIMIT 20

This shows a summary of all synced resources by provider, account, region, and type.

For more on writing queries, see SQL Console.

Next steps

• Set up additional integrations for other cloud providers
• Create policies to detect misconfigurations
• Configure alerts to get notified about policy violations
• Explore query examples for security, compliance, and cost optimization
• Insights: Review security, compliance, and cost findings generated from your synced data

Automate with the API

Everything you just did through the UI — setting up integrations, triggering syncs, managing policies — can also be done programmatically via the Platform API. This lets you treat CloudQuery Platform as infrastructure: automate it, drive it from CI/CD pipelines, and version-control your configuration.

See Platform API to get started.