CloudQuery

CloudQuery Syncs API

The syncs API from CloudQuery — 37 operation(s) for syncs.

GitHub OpenAPI

Operations 60

POST /sync-destination-test-connections Platform create sync destination test connection #
GET /sync-destination-test-connections/{sync_destination_test_connection_id} Platform get sync destination test connection #
PATCH /sync-destination-test-connections/{sync_destination_test_connection_id} Platform update sync test connection for sync destination #
GET /sync-destination-test-connections/{sync_destination_test_connection_id}/logs/query Platform get sync destination test connection logs query #
GET /sync-destination-test-connections/{sync_destination_test_connection_id}/logs/live Platform get sync destination test connection logs live #
POST /sync-destination-test-connections/{sync_destination_test_connection_id}/promote Platform promote sync destination test connection #
GET /sync-destinations Platform list sync destinations #
GET /sync-destinations/{sync_destination_name} Platform get sync destination #
PATCH /sync-destinations/{sync_destination_name} Platform update sync destination #
DELETE /sync-destinations/{sync_destination_name} Platform delete sync destination #
GET /sync-destinations/{sync_destination_name}/syncs Platform list sync destination syncs #
GET /sync-destinations/{sync_destination_name}/test-connections/{sync_test_connection_id} Platform get test connection for sync destination #
POST /sync-source-test-connections Platform create sync source test connection #
GET /sync-source-test-connections/{sync_source_test_connection_id} Platform get sync source test connection #
PATCH /sync-source-test-connections/{sync_source_test_connection_id} Platform update sync test connection for sync source #
GET /sync-source-test-connections/{sync_source_test_connection_id}/logs/query Platform get sync source test connection logs query #
GET /sync-source-test-connections/{sync_source_test_connection_id}/logs/live Platform get sync source test connection logs live #
POST /sync-source-test-connections/{sync_source_test_connection_id}/promote Platform promote sync source test connection #
POST /v2/sync-integration-test-connections Platform create V2Sync integration test connection #
GET /v2/sync-integrations Platform list V2Sync integrations #
POST /v2/sync-integrations Platform create V2Sync integration #
GET /v2/sync-integrations/{sync_name} Platform get V2Sync integration #
PATCH /v2/sync-integrations/{sync_name} Platform update V2Sync integration #
DELETE /v2/sync-integrations/{sync_name} Platform delete V2Sync integration #
GET /v2/sync-integrations/{sync_name}/revisions Platform list V2Sync integration config revisions #
GET /v2/sync-integrations/{sync_name}/revisions/{revision} Platform get V2Sync integration config revision #
GET /sync-sources Platform list sync sources #
GET /sync-sources/{sync_source_name} Platform get sync source #
PATCH /sync-sources/{sync_source_name} Platform update sync source #
DELETE /sync-sources/{sync_source_name} Platform delete sync source #
GET /sync-sources/{sync_source_name}/syncs Platform list sync source syncs #
GET /sync-sources/{sync_source_name}/test-connections/{sync_test_connection_id} Platform get test connection for sync source #
GET /sync-transformers Platform list sync transformers #
GET /sync-transformers/{sync_transformer_name} Platform get sync transformer #
PATCH /sync-transformers/{sync_transformer_name} Platform update sync transformer #
DELETE /sync-transformers/{sync_transformer_name} Platform delete sync transformer #
GET /sync-transformers/{sync_transformer_name}/syncs Platform list sync transformer syncs #
GET /sync-transformers/{sync_transformer_name}/sync-destinations Platform list sync transformer sync destinations #
GET /sync-upgrades Platform list sync upgrades #
GET /syncs Platform list syncs #
POST /syncs Platform create sync #
GET /syncs/{sync_name} Platform get sync #
PATCH /syncs/{sync_name} Platform update sync #
DELETE /syncs/{sync_name} Platform delete sync #
GET /syncs/{sync_name}/runs Platform list sync runs #
POST /syncs/{sync_name}/runs Platform create sync run #
GET /syncs/{sync_name}/runs/{sync_run_id} Platform get sync run #
PATCH /syncs/{sync_name}/runs/{sync_run_id} Platform update sync run #
POST /syncs/{sync_name}/runs/{sync_run_id}/reingest Platform reingest sync run #
GET /syncs/{sync_name}/runs/{sync_run_id}/logs/query Platform get sync run logs query #
GET /syncs/{sync_name}/runs/{sync_run_id}/logs/live Platform get sync run logs live #
GET /syncs/{sync_name}/runs/{sync_run_id}/performance Platform get sync run performance #
GET /syncs/{sync_name}/runs/{sync_run_id}/stats Platform get sync run stats #
GET /syncs/{sync_name}/runs/{sync_run_id}/tables Platform get sync run tables #
POST /v2/sync-destination-test-connections Platform create V2Sync destination test connection #
POST /v2/sync-destinations Platform create V2Sync destination #
GET /v2/sync-destinations Platform get V2Sync destinations #
GET /v2/sync-destinations/{sync_destination_name} Platform get V2Sync destination #
PATCH /v2/sync-destinations/{sync_destination_name} Platform patch V2Sync destination #
DELETE /v2/sync-destinations/{sync_destination_name} Platform delete V2Sync destination #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/cloudquery/openapi/cloudquery-syncs-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cloudquery:cloudquery-syncs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudquery-syncs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@cloudquery.io
    name: CloudQuery Support Team
    url: https://cloudquery.io
  description: 'Welcome to the CloudQuery Platform API documentation! This API can be used to interact with the CloudQuery platform. As a user, the API allows you to search the CloudQuery asset inventory, run SQL queries against the data warehouse, save and load searches, and much more. As an administrator, it allows you to manage your teams, syncs, and other objects.

    ### Authentication

    The API is secured using bearer tokens. To get started, you can generate an API key for your Platform deployment from your platform dashboard. For a step-by-step guide, see: https://www.cloudquery.io/docs/cli/managing-cloudquery/deployments/generate-api-key.

    The base URL for the API depends on where your CloudQuery Platform is hosted. If running locally, this is usually http://localhost:3000/api. In a production deployment it should be an HTTPS URL. For purposes of illustration, we will assume the platform instance is available at https://cloudquery.mycompany.com. In this case, the base API endpoint will be https://cloudquery.mycompany.com/api.

    ### Example Request

    To test your connection to the API, we can use the `/plugins` endpoint. For example:

    `curl -v -H "Authorization: Bearer $CLOUDQUERY_API_KEY" \ https://cloudquery.mycompany.com/api/plugins`'
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://www.cloudquery.io/terms
  title: CloudQuery Platform OpenAPI Spec Syncs API
  version: 1.0.0
security:
- bearerAuth: []
- cookieAuth: []
tags:


# --- truncated at 32 KB (149 KB total) ---
# Full source: https://artifacts.apis.io/cloudquery/openapi/cloudquery-syncs-api-openapi.yml