How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
CloudQuery

CloudQuery syncs API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

CloudQuery syncs API is one of 26 APIs that CloudQuery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Syncs. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 56 operations across 37 paths, and defines 80 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.cloudquery.io.

56 operations 37 paths 80 schemas 6 DELETE31 GET9 PATCH10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.cloudquery.io
Authentication
HTTP Bearer, HTTP Basic, HTTP Cookie
Contact
CloudQuery Support Team
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 3

CloudQuery syncs API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). It uses HTTP cookie authentication (cookieAuth). By default, every request must be authenticated.

Paths & Operations 56

Across 37 paths, the API surfaces 56 operations — 6 DELETE, 31 GET, 9 PATCH, 10 POST. Each is listed below with its method, path, parameters, and response codes.

syncs 56
POST
/sync-destination-test-connections
Create a test destination connection.
PlatformCreateSyncDestinationTestConnection body → 201400401404422429500
GET
/sync-destination-test-connections/{sync_destination_test_connection_id}
Get a sync destination test connection.
PlatformGetSyncDestinationTestConnection 1 param → 200401403404500
PATCH
/sync-destination-test-connections/{sync_destination_test_connection_id}
Update a sync destination test connection.
PlatformUpdateSyncTestConnectionForSyncDestination 1 param body → 200400403404422500
GET
/sync-destination-test-connections/{sync_destination_test_connection_id}/logs/query
Get logs for a sync destination test connection.
PlatformGetSyncDestinationTestConnectionLogsQuery 6 params → 200204400401404422500
GET
/sync-destination-test-connections/{sync_destination_test_connection_id}/logs/live
Get live logs for a sync destination test connection.
PlatformGetSyncDestinationTestConnectionLogsLive 2 params → 200204400401404422500
POST
/sync-destination-test-connections/{sync_destination_test_connection_id}/promote
Promote a sync destination test connection to a sync destination.
PlatformPromoteSyncDestinationTestConnection 1 param body → 200201400401404422500
GET
/sync-destinations
List all sync destination definitions.
PlatformListSyncDestinations 5 params → 200400401404500
GET
/sync-destinations/{sync_destination_name}
Get a single sync destination definition.
PlatformGetSyncDestination 1 param → 200401404500
PATCH
/sync-destinations/{sync_destination_name}
Update a Sync Destination definition.
PlatformUpdateSyncDestination 1 param body → 200400401404422500
DELETE
/sync-destinations/{sync_destination_name}
Delete a Sync Destination definition. Any syncs relying on this destination must be deleted first.
PlatformDeleteSyncDestination 1 param → 204401404422500
GET
/sync-destinations/{sync_destination_name}/syncs
List all Syncs for a given sync destination.
PlatformListSyncDestinationSyncs 7 params → 200400401404500
GET
/sync-destinations/{sync_destination_name}/test-connections/{sync_test_connection_id}
Get test connection details for sync destination.
PlatformGetTestConnectionForSyncDestination 2 params → 200400401404500
POST
/sync-source-test-connections
Create a test source connection.
PlatformCreateSyncSourceTestConnection body → 201400401404422429500
GET
/sync-source-test-connections/{sync_source_test_connection_id}
Get a sync source test connection.
PlatformGetSyncSourceTestConnection 1 param → 200401403404500
PATCH
/sync-source-test-connections/{sync_source_test_connection_id}
Update a sync source test connection.
PlatformUpdateSyncTestConnectionForSyncSource 1 param body → 200400403404422500
GET
/sync-source-test-connections/{sync_source_test_connection_id}/logs/query
Get logs for a sync source test connection.
PlatformGetSyncSourceTestConnectionLogsQuery 6 params → 200204400401404422500
GET
/sync-source-test-connections/{sync_source_test_connection_id}/logs/live
Get live logs for a sync source test connection.
PlatformGetSyncSourceTestConnectionLogsLive 2 params → 200204400401404422500
POST
/sync-source-test-connections/{sync_source_test_connection_id}/promote
Promote a sync source test connection to a sync source.
PlatformPromoteSyncSourceTestConnection 1 param body → 200201400401404422500
POST
/v2/sync-integration-test-connections
Create an integration test connection.
PlatformCreateV2SyncIntegrationTestConnection body → 201400401404422429500
GET
/v2/sync-integrations
List sync integrations
PlatformListV2SyncIntegrations 5 params → 200400401404500
POST
/v2/sync-integrations
Create a new integration associated with a completed test connection
PlatformCreateV2SyncIntegration body → 201400401404422500
GET
/v2/sync-integrations/{sync_name}
Get a sync integration by name
PlatformGetV2SyncIntegration 1 param → 200400401404500
PATCH
/v2/sync-integrations/{sync_name}
Update attributes of an integration
PlatformUpdateV2SyncIntegration 1 param body → 200400401404422500
DELETE
/v2/sync-integrations/{sync_name}
Delete an integration
PlatformDeleteV2SyncIntegration 2 params → 204400401403404405500
GET
/sync-sources
List all sync source definitions.
PlatformListSyncSources 5 params → 200400401404500
GET
/sync-sources/{sync_source_name}
Get a single sync source definition.
PlatformGetSyncSource 1 param → 200401404500
PATCH
/sync-sources/{sync_source_name}
Update a Sync Source definition.
PlatformUpdateSyncSource 1 param body → 200400401404422500
DELETE
/sync-sources/{sync_source_name}
Delete a Sync Source definition. Any syncs relying on this source must be deleted first.
PlatformDeleteSyncSource 1 param → 204401404422500
GET
/sync-sources/{sync_source_name}/syncs
List all Syncs for a given sync source.
PlatformListSyncSourceSyncs 7 params → 200400401404500
GET
/sync-sources/{sync_source_name}/test-connections/{sync_test_connection_id}
Get test connection details for sync source.
PlatformGetTestConnectionForSyncSource 2 params → 200400401404500
GET
/sync-transformers
List all sync transformer definitions.
PlatformListSyncTransformers 5 params → 200400401404500
GET
/sync-transformers/{sync_transformer_name}
Get a single sync transformer definition.
PlatformGetSyncTransformer 1 param → 200401404500
PATCH
/sync-transformers/{sync_transformer_name}
Update a Sync Transformer definition.
PlatformUpdateSyncTransformer 1 param body → 200400401404422500
DELETE
/sync-transformers/{sync_transformer_name}
Delete a Sync Transformer definition. Any syncs relying on this transformer must be deleted first.
PlatformDeleteSyncTransformer 1 param → 204401404422500
GET
/sync-transformers/{sync_transformer_name}/syncs
List all Syncs for a given sync transformer.
PlatformListSyncTransformerSyncs 3 params → 200401404500
GET
/sync-transformers/{sync_transformer_name}/sync-destinations
List all Sync Destinations for a given sync transformer.
PlatformListSyncTransformerSyncDestinations 3 params → 200401404500
GET
/sync-upgrades
List all version upgrades for syncs
PlatformListSyncUpgrades 7 params → 200400401404500
GET
/syncs
List all Syncs.
PlatformListSyncs 6 params → 200400401404500
POST
/syncs
Create new Sync definition. Sync runs can be scheduled automatically, or triggered manually after sync is created.
PlatformCreateSync body → 201400401422500
GET
/syncs/{sync_name}
Get a Sync
PlatformGetSync 1 param → 200400401404500
PATCH
/syncs/{sync_name}
Update a Sync
PlatformUpdateSync 1 param body → 200400403404422500
DELETE
/syncs/{sync_name}
Delete Sync. This will delete Sync configuration and all associated sync runs, but will not delete the associated source and destination(s). These will need to be deleted separately.
PlatformDeleteSync 1 param → 204400401404422500
GET
/syncs/{sync_name}/runs
List all Sync Runs.
PlatformListSyncRuns 4 params → 200401404500
POST
/syncs/{sync_name}/runs
Create new SyncRun. This will trigger a manual job run.
PlatformCreateSyncRun 1 param → 201400401422500
GET
/syncs/{sync_name}/runs/{sync_run_id}
Get a Sync Run.
PlatformGetSyncRun 2 params → 200401404500
PATCH
/syncs/{sync_name}/runs/{sync_run_id}
Update a SyncRun
PlatformUpdateSyncRun 2 params body → 200400403404422500
GET
/syncs/{sync_name}/runs/{sync_run_id}/logs/query
Get logs for a sync run.
PlatformGetSyncRunLogsQuery 7 params → 200204400401404422500
GET
/syncs/{sync_name}/runs/{sync_run_id}/logs/live
Get live logs for a sync run.
PlatformGetSyncRunLogsLive 4 params → 200204400401404422500
GET
/syncs/{sync_name}/runs/{sync_run_id}/stats
Get statistics on a Sync Run
PlatformGetSyncRunStats 2 params → 200400401404500
GET
/syncs/{sync_name}/runs/{sync_run_id}/tables
Get table details on a Sync Run
PlatformGetSyncRunTables 6 params → 200400401404500
POST
/v2/sync-destination-test-connections
Create a test destination connection.
PlatformCreateV2SyncDestinationTestConnection body → 201400401404422429500
POST
/v2/sync-destinations
Create sync destination based on test connection.
PlatformCreateV2SyncDestination body → 200201400401404422500
GET
/v2/sync-destinations
List all sync destination definitions.
PlatformGetV2SyncDestinations 5 params → 200400401404500
GET
/v2/sync-destinations/{sync_destination_name}
Get a single sync destination definition.
PlatformGetV2SyncDestination 1 param → 200401404500
PATCH
/v2/sync-destinations/{sync_destination_name}
Update a Sync Destination definition.
PlatformPatchV2SyncDestination 1 param body → 200400401404422500
DELETE
/v2/sync-destinations/{sync_destination_name}
Delete a Sync Destination definition. Any syncs relying on this destination must be deleted first.
PlatformDeleteV2SyncDestination 1 param → 204401404422500

Schemas 80

The contract defines 80 schemas that model the data the API accepts and returns. The most detailed are PlatformPlugin (18 properties), PlatformSyncRun (12 properties), PlatformSyncDestinationCreate (12 properties), PlatformSync (11 properties). Each schema is shown below with its type and property counts.

PlatformSync
object
Managed Sync definition
11 properties 10 required
PlatformSyncSourceUpdate
object
Sync Source Update Definition
5 properties
PlatformPluginName
string
The unique name for the plugin.
PlatformSyncSourceTestConnectionID
string
ID of the Sync Source Test Connection
PlatformPromoteSyncDestinationTestConnection
object
Sync Destination Definition
6 properties 1 required
PlatformSyncDestinationTestConnectionID
string
ID of the Sync Destination Test Connection
PlatformSyncDestinationV2
PlatformSyncCreate
object
Managed Sync definition
8 properties 3 required
PlatformSyncRunTableStat
object
8 properties 3 required
PlatformSyncUpdate
object
Managed Sync definition
8 properties
PlatformSyncSortBy
string
PlatformDisplayName
string
A human-readable display name
PlatformSyncIntegrationV2
object
An integration definition
10 properties 1 required
PlatformFieldError
PlatformSyncIntegrationSourceV2
object
Integration Source Definition
10 properties 5 required
PlatformSyncIntegrationTestConnectionV2
object
8 properties 3 required
PlatformSyncRunStats
object
6 properties 5 required
PlatformSyncIntegrationExpandedV2
Managed Sync List Entry
PlatformSyncIntegrationUpdateV2
object
Update an existing integration
5 properties
PlatformSyncDestinationCreate
object
Sync Destination Definition
12 properties 3 required
PlatformSyncRunID
string
ID of the SyncRun
PlatformSyncSourceTestConnectionCreate
object
6 properties 2 required
PlatformSyncDestinationTestConnection
object
9 properties 3 required
PlatformListSyncLastRun
object
Managed Sync List Entry Last Run Info
10 properties 8 required
PlatformSyncDestinationUpdateV2
object
Sync Destination Update Definition
7 properties
PlatformSyncDestination
PlatformSyncRunStatusReason
string
The reason for the status
PlatformSyncDestinationTestConnectionV2
object
9 properties 3 required
PlatformTableData
object
3 properties 2 required
PlatformSyncTransformer
PlatformListMetadata
object
4 properties 1 required
PlatformSyncRunWorkerStatus
object
The worker information for a sync run
2 properties 1 required
PlatformQueryExpression
string
Query expression
PlatformVersionName
string
The version in semantic version format.
PlatformSyncEnv
object
Environment variable. Environment variables are assumed to be secret.
1 property 1 required
PlatformPluginKind
string
The kind of plugin, ie. source or destination.
PlatformSyncDestinationMigrateMode
string
Migrate mode for the destination
PlatformSyncDestinationWriteMode
string
Write mode for the destination
PlatformBasicError
object
Basic Error
2 properties 2 required
PlatformOnboardingID
string
ID of the cloud provider onboarding session
PlatformSyncDestinationTestConnectionCreate
object
8 properties 2 required
PlatformSyncSourceCreate
object
Sync Source Definition
10 properties 4 required
PlatformSyncIntegrationTestConnectionCreateV2
object
6 properties 1 required
PlatformSyncSourceTestConnection
object
8 properties 3 required
PlatformTeamName
string
The unique name for the team.
PlatformPluginCategory
string
Supported categories for plugins
PlatformSyncSource
PlatformSyncLastUpdateSource
string
How was the source or destination been created or updated last
PlatformPlugin
object
CloudQuery Plugin
18 properties 14 required
PlatformTableSortDirection
string
PlatformSyncRunDetails
PlatformSyncRunWorkerPhase
string
Phase of the worker in the sync run
PlatformSyncRun
object
Managed Sync Run definition
12 properties 9 required
PlatformSyncEnvCreate
object
Environment variable. Environment variables are assumed to be secret.
2 properties 1 required
PlatformPluginTier
string
This field is deprecated, refer to pricecategory instead. This field is only kept for backward compatibility and may be removed in a future release. Supported…
PlatformSyncDestinationMigrateModeUpdate
string
Migrate mode for the destination, for updating
PlatformCreateSyncDestinationTestConnectionV2
object
8 properties 1 required
PlatformSyncGenericSortBy
string
PlatformSyncIntegrationSourceUpdateV2
object
Integration Definition
4 properties
PlatformSyncUpgrade
object
Sync Version Upgrade Definition
8 properties 8 required
PlatformSyncDestinationName
string
Descriptive, unique name for the destination
PlatformSyncIntegrationCreateV2
object
Create a new sync integration
6 properties 3 required
PlatformSyncTestConnectionID
string
unique ID of the test connection
PlatformSyncDestinationWriteModeUpdate
string
Write mode for the destination, for updating
PlatformCreateSyncDestinationV2
object
Sync Destination Definition
8 properties 1 required
PlatformSyncPluginPath
string
Plugin path in CloudQuery registry
PlatformPluginReleaseStage
string
Official plugins can go through three release stages: Coming Soon, Preview, and GA. The Coming Soon stage is for plugins that are not yet ready for Preview, bu…
PlatformSyncTransformerCreate
object
Sync Transformer Definition
7 properties 4 required
PlatformPromoteSyncSourceTestConnection
object
Sync Source Definition
6 properties 2 required
PlatformPluginPriceCategory
string
Supported price categories for billing
PlatformSyncIntegrationSourceCreateV2
object
Integration Source Definition
4 properties 2 required
PlatformSyncDestinationUpdate
object
Sync Destination Update Definition
6 properties
PlatformSyncSortDirection
string
PlatformSyncTestConnection
object
9 properties 3 required
PlatformSyncRunStatus
string
The status of the sync run
PlatformSyncRunTableSortBy
string
PlatformListSync
Managed Sync List Entry
PlatformSyncTestConnectionStatus
string
The status of the sync run
PlatformFilterExpression
string
A table column filter.
PlatformSyncTransformerUpdate
object
Sync Transformer Update Definition
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudquery-syncs-api-openapi.yml Raw ↑

Other APIs CloudQuery publishes across the network.

CloudQuery Platform API
AE Profile APIs.io
CloudQuery admin API
AE Profile APIs.io
CloudQuery alerts API
AE Profile APIs.io
CloudQuery api-keys API
AE Profile APIs.io
CloudQuery apps API
AE Profile APIs.io
CloudQuery audit-logs API
AE Profile APIs.io
CloudQuery chat API
AE Profile APIs.io
CloudQuery custom-columns API
AE Profile APIs.io
CloudQuery filters API
AE Profile APIs.io
CloudQuery healthcheck API
AE Profile APIs.io
CloudQuery insights API
AE Profile APIs.io
CloudQuery notifications API
AE Profile APIs.io
#Syncs
← Back to C APIs
API Details
ID
cloudquery:cloudquery-syncs-api
Base URL
https://api.cloudquery.io
Docs
https://platform-multi-tenant-api-docs.cloudquery.io/
Provider
CloudQuery
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cloudquery-syncs-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cloudquery-syncs-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of CloudQuery syncs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.