Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0492100246.4 KB
plugins

Create a plugin owned by the specified team. User must be part of that team.

post/plugins

Request body

team_namestring required

The unique name for the team.

kind'source' | 'destination' | 'transformer' required

The kind of plugin, ie. source or destination.

namestring required

The unique name for the plugin.

category'cloud-infrastructure' | 'databases' | 'sales-marketing' | 'engineering-analytics' | 'marketing-analytics' | 'shipment-tracking' | 'product-analytics' | 'cloud-finops' | 'project-management' | 'fleet-management' | 'security' | 'data-warehouses' | 'human-resources' | 'finance' | 'customer-support' | 'other' required

Supported categories for plugins

price_category'api' | 'database' | 'free'

Supported price categories for billing

tier'free' | 'paid' | 'open-core'

This field is deprecated, refer to price_category instead. This field is only kept for backward compatibility and may be removed in a future release. Supported tiers for plugins.

  • free: Free tier, with no paid tables.
  • paid: Paid tier. These plugins may have paid tables, but can also have free tables. They require login to access.
  • open-core: This option is deprecated, values will either be free or paid.
display_namestring required

The plugin's display name, as shown in the CloudQuery Hub.

short_descriptionstring required

Short description of the plugin. This will be shown in the CloudQuery Hub.

homepagestring
publicboolean required

Whether the plugin is listed in the CloudQuery Hub. If false, the plugin will not be shown in the CloudQuery Hub and will only be visible to members of the team.

repositorystring
release_stage'coming-soon' | 'preview' | 'ga'

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, but users can subscribe to be notified when they are ready. Both Preview and GA plugins follow semantic versioning. The main differences between the two stages are: Preview plugins are still experimental and may have frequent breaking changes. Preview plugins might get deprecated due to lack of usage. Long Term Support with community Discord and bug fixes is only guaranteed for GA plugins. Premium plugins are often discounted or free during the Preview stage.

logostring

URL to the plugin's logo. This will be shown in the CloudQuery Hub.

usd_per_rowstring

Deprecated. Use price_category instead.

free_rows_per_monthinteger

Deprecated. Use price_category instead.

Example request

{
  "team_name": "cloudquery",
  "kind": "source",
  "name": "aws-source",
  "display_name": "AWS Source Plugin",
  "short_description": "Sync data from AWS to any destination",
  "homepage": "https://cloudquery.io",
  "public": true,
  "repository": "https://github.com/cloudquery/cloudquery",
  "logo": "https://storage.googleapis.com/cq-cloud-images/9ac4cb31-e971-4879-8619-87dc22b0f98e",
  "usd_per_row": "0.00001",
  "free_rows_per_month": 10000
}

Response

Created

team_namestring required

The unique name for the team.

namestring required

The unique name for the plugin.

kind'source' | 'destination' | 'transformer' required

The kind of plugin, ie. source or destination.

category'cloud-infrastructure' | 'databases' | 'sales-marketing' | 'engineering-analytics' | 'marketing-analytics' | 'shipment-tracking' | 'product-analytics' | 'cloud-finops' | 'project-management' | 'fleet-management' | 'security' | 'data-warehouses' | 'human-resources' | 'finance' | 'customer-support' | 'other' required

Supported categories for plugins

price_category'api' | 'database' | 'free'

Supported price categories for billing

created_atstring date-time required
updated_atstring date-time required
homepagestring
logostring required
display_namestring required

The plugin's display name

officialboolean required

True if the plugin is maintained by CloudQuery, false otherwise

release_stage'coming-soon' | 'preview' | 'ga' | 'deprecated' required

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, but users can subscribe to be notified when they are ready. Both Preview and GA plugins follow semantic versioning. The main differences between the two stages are: Preview plugins are still experimental and may have frequent breaking changes. Preview plugins might get deprecated due to lack of usage. Long Term Support with community Discord and bug fixes is only guaranteed for GA plugins. Premium plugins are often discounted or free during the Preview stage.

repositorystring
short_descriptionstring required
tier'free' | 'paid' | 'open-core' required

This field is deprecated, refer to price_category instead. This field is only kept for backward compatibility and may be removed in a future release. Supported tiers for plugins.

  • free: Free tier, with no paid tables.
  • paid: Paid tier. These plugins may have paid tables, but can also have free tables. They require login to access.
  • open-core: This option is deprecated, values will either be free or paid.
publicboolean

Whether the plugin is listed in the CloudQuery Hub. If false, the plugin will not be shown in the CloudQuery Hub and will only be visible to members of the plugin's team.

usd_per_rowstring required

Deprecated. Refer to price_category instead.

free_rows_per_monthinteger required

Deprecated. Refer to price_category instead.

Example response

{
  "team_name": "cloudquery",
  "name": "aws-source",
  "kind": "source",
  "created_at": "2017-07-14T16:53:42Z",
  "updated_at": "2017-07-14T16:53:42Z",
  "homepage": "https://cloudquery.io",
  "logo": "https://storage.googleapis.com/cq-cloud-images/9ac4cb31-e971-4879-8619-87dc22b0f98e",
  "display_name": "AWS Source Plugin",
  "repository": "https://github.com/cloudquery/cloudquery",
  "short_description": "Sync data from AWS to any destination",
  "usd_per_row": "0.0001",
  "free_rows_per_month": 1000
}