Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0492100246.4 KB
addons

Create an addon owned by the specified team. User must be part of that team.

post/addons

Request body

team_namestring required

The unique name for the team.

namestring required

The unique name for the addon.

category'cloud-infrastructure' | 'databases' | 'sales-marketing' | 'engineering-analytics' | 'other' required

Supported categories for addons

addon_type'transformation' | 'visualization' required

Supported types for addons

addon_format'zip' required

Supported formats for addons

tier'free' | 'paid' required

Supported tiers for addons

price_usdstring

The price for 6 months

short_descriptionstring required
display_namestring required

The addon's display name

homepagestring
repositorystring
logostring
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 plugin's team.

Example request

{
  "team_name": "cloudquery",
  "name": "aws-policy",
  "price_usd": "50",
  "short_description": "AWS Asset inventory dashboard for grafana",
  "display_name": "AWS Asset inventory",
  "homepage": "https://cloudquery.io",
  "repository": "https://github.com/cloudquery/cloudquery",
  "logo": "https://storage.googleapis.com/cq-cloud-images/9ac4cb31-e971-4879-8619-87dc22b0f98e"
}

Response

Created

team_namestring required

The unique name for the team.

namestring required

The unique name for the addon.

officialboolean required

True if the addon is maintained by CloudQuery, false otherwise

category'cloud-infrastructure' | 'databases' | 'sales-marketing' | 'engineering-analytics' | 'other' required

Supported categories for addons

addon_type'transformation' | 'visualization' required

Supported types for addons

addon_format'zip' required

Supported formats for addons

tier'free' | 'paid' required

Supported tiers for addons

price_usdstring required

The price for 6 months

short_descriptionstring required
display_namestring required

The addon's display name

homepagestring
repositorystring
logostring required
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.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "team_name": "cloudquery",
  "name": "aws-policy",
  "price_usd": "50",
  "short_description": "AWS Asset inventory dashboard for grafana",
  "display_name": "AWS Asset inventory",
  "homepage": "https://cloudquery.io",
  "repository": "https://github.com/cloudquery/cloudquery",
  "logo": "https://storage.googleapis.com/cq-cloud-images/9ac4cb31-e971-4879-8619-87dc22b0f98e",
  "created_at": "2017-07-14T16:53:42Z",
  "updated_at": "2017-07-14T16:53:42Z"
}