CloudQuery OpenAPI Spec (1.0.0)

Download OpenAPI specification:Download

CloudQuery Support Team: support@cloudquery.io URL: https://cloudquery.io License: MIT Terms of Service

Welcome to the CloudQuery API documentation! This API can be used to interact with the CloudQuery platform. The API allows you to manage your teams, usage, spend limits, plugins, addons, cloud syncs, and much more.

The API is secured using bearer tokens. To get started, you can generate an API key from the CloudQuery dashboard. For a step-by-step guide, see: https://docs.cloudquery.io/docs/deployment/generate-api-key.

The base URL for the API is https://api.cloudquery.io.

users

GetCurrentUser

Get the current authenticated user from the OAuth token

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "email": "user@example.com",
  • "name": "user",
  • "updated_at": "2017-07-14T16:53:42Z"
}

UpdateCurrentUser

Update attributes for the current authenticated user from the OAuth token

Authorizations:
bearerAuth
Request Body schema: application/json
name
string [ 1 .. 255 ] characters

The user's name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "email": "user@example.com",
  • "name": "user",
  • "updated_at": "2017-07-14T16:53:42Z"
}

ListCurrentUserInvitations

List of the current user's unaccepted invitations

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

GetCurrentUserMemberships

Get memberships that the user has accepted.

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

teams

ListTeams

List all teams

Authorizations:
bearerAuth
query Parameters
per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

CreateTeam

Create a team owned by the current user.

Authorizations:
bearerAuth
Request Body schema: application/json
name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$

The unique name for the team.

display_name
required
string [ 1 .. 255 ] characters

The team's display name

Responses

Request samples

Content type
application/json
{
  • "name": "cloudquery",
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "name": "cloudquery",
  • "plan": "free",
  • "plan_end_time": "2017-07-14T16:53:42Z",
  • "is_trial_active": false,
  • "trial_end_time": "2017-07-14T16:53:42Z",
  • "display_name": "CloudQuery"
}

GetTeamByName

Get a team by name

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "name": "cloudquery",
  • "plan": "free",
  • "plan_end_time": "2017-07-14T16:53:42Z",
  • "is_trial_active": false,
  • "trial_end_time": "2017-07-14T16:53:42Z",
  • "display_name": "CloudQuery"
}

UpdateTeam

Update team attributes

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Request Body schema: application/json
display_name
string

The team's display name

Responses

Request samples

Content type
application/json
{
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "name": "cloudquery",
  • "plan": "free",
  • "plan_end_time": "2017-07-14T16:53:42Z",
  • "is_trial_active": false,
  • "trial_end_time": "2017-07-14T16:53:42Z",
  • "display_name": "CloudQuery"
}

CreateTeamImages

Get URLs to upload images for a given team

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Request Body schema: application/json
required
required
Array of objects (Create Team Image Request) non-empty

Responses

Request samples

Content type
application/json
{
  • "images": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

GetTeamMemberships

Get memberships to the team.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

query Parameters
page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

RemoveTeamMembership

Remove a user from the team

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Request Body schema: application/json
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "errors": [
    ],
  • "field_errors": {
    }
}

DeleteTeamMembership Deprecated

Remove a user from the team

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

email
required
string
Example: user@example.com

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "errors": [
    ],
  • "field_errors": {
    }
}

GetSpendingLimit

Get monthly spending limit for team.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "usd": 1000
}

CreateSpendingLimit

Create a spending limit for a team

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Request Body schema: application/json
usd
required
integer [ 0 .. 1000000000 ]

The maximum USD amount the team is allowed to use within a calendar month.

Responses

Request samples

Content type
application/json
{
  • "usd": 1000
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "usd": 1000
}

UpdateSpendingLimit

Update a spending limit for a team

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Request Body schema: application/json
usd
required
integer [ 0 .. 1000000000 ]

The maximum USD amount the team is allowed to use within a calendar month.

Responses

Request samples

Content type
application/json
{
  • "usd": 1000
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "usd": 1000
}

DeleteSpendingLimit

Delete a spending limit for a team

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0
}

ListInvoicesByTeam

List all past invoices for the team.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

query Parameters
page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

ListTeamPluginUsage

List plugin usage for the current calendar month.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

query Parameters
page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

IncreaseTeamPluginUsage

Increase the usage of a plugin. This can incur billing costs and should be used only by plugin SDKs.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Request Body schema: application/json
plugin_team
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$

The unique name for the plugin.

Array of objects
rows
required
integer >= 0

The total number of additional rows used by the plugin.

request_id
required
string <uuid>

A unique ID associated with the usage increase.

Responses

Request samples

Content type
application/json
{
  • "plugin_team": "cloudquery",
  • "plugin_kind": "source",
  • "plugin_name": "aws-source",
  • "tables": [
    ],
  • "rows": 1000000,
  • "request_id": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0
}

GetTeamPluginUsage

Get plugin usage for the current calendar month.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_team
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

Responses

Response samples

Content type
application/json
{
  • "plugin_team": "cloudquery",
  • "plugin_kind": "source",
  • "plugin_name": "aws-source",
  • "rows": 1000000,
  • "usd": "43.95",
  • "remaining_usd": "56.05",
  • "remaining_rows": 1
}

GetTeamUsageSummary

Get a summary of usage for the specified time range.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

query Parameters
metrics
Array of strings
Default: "paid_rows"
Items Enum: "paid_rows" "cloud_vcpu_seconds" "cloud_vram_byte_seconds" "network_egress_bytes"

A list of metrics to include in the response. Each metric must be one of the predefined valid values. If not provided, only paid-rows will be included.

start
string <date-time>

A valid ISO-8601-formatted date and time, indicating the inclusive start of the query time range. Defaults to 30 days ago.

end
string <date-time>

A valid ISO-8601-formatted date and time, indicating the exclusive end of the query time range. Defaults to the current time.

aggregation_period
string
Default: "day"
Enum: "day" "month"

An aggregation period to sum data over. In other words, data will be returned at this granularity. Currently only supports day and month.

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ],
  • "values": [
    ],
  • "metadata": {
    }
}

GetGroupedTeamUsageSummary

Get a grouped summary of usage for the specified time range.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

group_by
required
string
Enum: "price_category" "plugin" "sync_id"

Group by usage summary. plugin and price_category groupings are only available for paid-rows.

query Parameters
metrics
Array of strings
Default: "paid_rows"
Items Enum: "paid_rows" "cloud_vcpu_seconds" "cloud_vram_byte_seconds" "network_egress_bytes"

A list of metrics to include in the response. Each metric must be one of the predefined valid values. If not provided, only paid-rows will be included.

start
string <date-time>

A valid ISO-8601-formatted date and time, indicating the inclusive start of the query time range. Defaults to 30 days ago.

end
string <date-time>

A valid ISO-8601-formatted date and time, indicating the exclusive end of the query time range. Defaults to the current time.

aggregation_period
string
Default: "day"
Enum: "day" "month"

An aggregation period to sum data over. In other words, data will be returned at this granularity. Currently only supports day and month.

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ],
  • "values": [
    ],
  • "metadata": {
    }
}

GetTeamSpend

Get team spend for defined period.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

query Parameters
start
string <date-time>

A valid ISO 8601 date string representing the inclusive start of the period.

end
string <date-time>

A valid ISO 8601 date string representing the exclusive end of the period.

Responses

Response samples

Content type
application/json
{
  • "values": [
    ],
  • "metadata": {
    }
}

ListTeamInvitations

List of open invitations to the team

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

query Parameters
page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

EmailTeamInvitation

Invite a user to join a team with their email address

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Request Body schema: application/json
email
required
string <email>
role
required
string
Enum: "admin" "member"

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "role": "admin"
}

Response samples

Content type
application/json
{
  • "team_name": "cloudquery",
  • "email": "user@example.com",
  • "role": "admin",
  • "created_at": "2017-07-14T16:53:42Z"
}

DeleteTeamInvitation

Delete an invitation to the team, preventing the user becoming a team member

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Request Body schema: application/json
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "errors": [
    ],
  • "field_errors": {
    }
}

AcceptTeamInvitation

Accept an invitation to the team, creating a user membership

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Request Body schema: application/json
token
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "token": "b5507016-7da2-4777-a161-1e8042a6a377"
}

Response samples

Content type
application/json
{
  • "role": "admin",
  • "team": {
    }
}

CancelTeamInvitation Deprecated

Cancel an invitation to the team, preventing the user becoming a team member

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

email
required
string
Example: user@example.com

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "errors": [
    ],
  • "field_errors": {
    }
}

ListSubscriptionOrdersByTeam

List all subscription orders for the team.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

query Parameters
page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

CreateSubscriptionOrderForTeam

Start the checkout process for a subscription order.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Request Body schema: application/json
required
plan
required
string (TeamPlan)
Enum: "free" "paid" "enterprise" "trial"

The plan the team is on (trial is deprecated)

success_url
required
string

URL to redirect to after successful order completion

cancel_url
required
string

URL to redirect to after order cancellation

Responses

Request samples

Content type
application/json

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "team_name": "cloudquery",
  • "plan": "free",
  • "status": "pending",
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "completion_url": "http://example.com"
}

GetSubscriptionOrderByTeam

Get a subscription order for the team.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

subscription_order_id
required
string <uuid> (TeamSubscriptionOrderID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the team subscription order

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "team_name": "cloudquery",
  • "plan": "free",
  • "status": "pending",
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "completion_url": "http://example.com"
}

ListUsersByTeam

List all users in the current team.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

query Parameters
per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

ListTeamAPIKeys

List all team API Keys

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

query Parameters
per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

CreateTeamAPIKey

Create new team API Key.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

Request Body schema: application/json
name
required
string (APIKeyName) [ 1 .. 255 ] characters ^(?:[a-zA-Z0-9][a-zA-Z0-9- ]*)?[a-zA-Z0-9]$

Name of the API key

expires_at
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "cli-api-key",
  • "expires_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "name": "cli-api-key",
  • "created_by": "user@example.com",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "key": "1234567890abcdef1234567890abcdef",
  • "created_at": "2017-07-14T16:53:42Z",
  • "expires_at": "2017-07-14T16:53:42Z",
  • "expired": false,
  • "scope": "read-and-write"
}

DeleteTeamAPIKey

Delete API Key. This will remove any future access by this API Key.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

apikey_id
required
string <uuid> (APIKeyID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the API key

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "errors": [
    ],
  • "field_errors": {
    }
}

plugins

ListPluginNotificationRequests

List all plugin notification requests

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

CreatePluginNotificationRequest

Create a new plugin notification request.

Authorizations:
bearerAuth
Request Body schema: application/json
required
plugin_team
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$

The unique name for the plugin.

Responses

Request samples

Content type
application/json
{
  • "plugin_team": "cloudquery",
  • "plugin_kind": "source",
  • "plugin_name": "aws-source"
}

Response samples

Content type
application/json
{
  • "plugin_team": "cloudquery",
  • "plugin_kind": "source",
  • "plugin_name": "aws-source",
  • "created_at": "2017-07-14T16:53:42Z",
  • "sent_at": "2017-07-14T16:53:42Z",
  • "status": "pending"
}

GetPluginNotificationRequest

Query plugin notification request for a given plugin.

Authorizations:
bearerAuth
path Parameters
plugin_team
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

DeletePluginNotificationRequest

Remove plugin notification request for a given plugin.

Authorizations:
bearerAuth
path Parameters
plugin_team
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0
}

ListPlugins

List all plugins

query Parameters
sort_by
string
Enum: "created_at" "updated_at" "name" "downloads"

The field to sort by

page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

CreatePlugin

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

Authorizations:
bearerAuth
Request Body schema: application/json
required
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$

The unique name for the team.

kind
required
string (PluginKind)
Enum: "source" "destination"

The kind of plugin, ie. source or destination.

name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$

The unique name for the plugin.

category
required
string (PluginCategory)
Enum: "cloud-infrastructure" "databases" "sales-marketing" "engineering-analytics" "marketing-analytics" "shipment-tracking" "product-analytics" "cloud-finops" "project-management" "fleet-management" "security" "data-warehouses" "human-resources" "other"

Supported categories for plugins

price_category
string (PluginPriceCategory)
Enum: "api" "database" "free"

Supported price categories for billing

tier
string (PluginTier)
Deprecated
Enum: "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_name
required
string [ 1 .. 50 ] characters

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

short_description
required
string [ 1 .. 512 ] characters

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

homepage
string
public
required
boolean

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.

repository
string
release_stage
string (PluginReleaseStageCreate)
Enum: "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.

logo
required
string

URL to the plugin's logo. This will be shown in the CloudQuery Hub. This must point to https://images.cloudquery.io/...

usd_per_row
string^\d+(?:\.\d{1,10})?$
Deprecated

Deprecated. Use price_category instead.

free_rows_per_month
integer <int64>
Deprecated

Deprecated. Use price_category instead.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "team_name": "cloudquery",
  • "name": "aws-source",
  • "kind": "source",
  • "category": "cloud-infrastructure",
  • "price_category": "api",
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "homepage": "https://cloudquery.io",
  • "display_name": "AWS Source Plugin",
  • "official": true,
  • "release_stage": "coming-soon",
  • "short_description": "Sync data from AWS to any destination",
  • "tier": "free",
  • "public": true,
  • "usd_per_row": "0.0001",
  • "free_rows_per_month": 1000,
  • "minimum_cloud_version": "v1.2.3"
}

GetPlugin

Get details about a given plugin.

path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

Responses

Response samples

Content type
application/json
{
  • "team_name": "cloudquery",
  • "name": "aws-source",
  • "kind": "source",
  • "category": "cloud-infrastructure",
  • "price_category": "api",
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "homepage": "https://cloudquery.io",
  • "display_name": "AWS Source Plugin",
  • "official": true,
  • "release_stage": "coming-soon",
  • "short_description": "Sync data from AWS to any destination",
  • "tier": "free",
  • "public": true,
  • "usd_per_row": "0.0001",
  • "free_rows_per_month": 1000,
  • "minimum_cloud_version": "v1.2.3",
  • "latest_version": "string"
}

UpdatePlugin

Update a plugin

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

Request Body schema: application/json
category
string (PluginCategory)
Enum: "cloud-infrastructure" "databases" "sales-marketing" "engineering-analytics" "marketing-analytics" "shipment-tracking" "product-analytics" "cloud-finops" "project-management" "fleet-management" "security" "data-warehouses" "human-resources" "other"

Supported categories for plugins

price_category
string (PluginPriceCategory)
Enum: "api" "database" "free"

Supported price categories for billing

tier
string (PluginTier)
Deprecated
Enum: "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_name
string [ 1 .. 50 ] characters

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

short_description
string [ 1 .. 512 ] characters

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

homepage
string
repository
string
logo
string

URL to the plugin's logo. This will be shown in the CloudQuery Hub. This must point to https://images.cloudquery.io/...

public
boolean

If plugin is not public, it won't be visible to other teams in the CloudQuery Hub.

release_stage
string (PluginReleaseStageUpdate)
Enum: "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.

usd_per_row
string^\d+(?:\.\d{1,10})?$
Deprecated

Deprecated. Update price_category instead.

free_rows_per_month
integer <int64>
Deprecated

Deprecated. Update price_category instead.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "team_name": "cloudquery",
  • "name": "aws-source",
  • "kind": "source",
  • "category": "cloud-infrastructure",
  • "price_category": "api",
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "homepage": "https://cloudquery.io",
  • "display_name": "AWS Source Plugin",
  • "official": true,
  • "release_stage": "coming-soon",
  • "short_description": "Sync data from AWS to any destination",
  • "tier": "free",
  • "public": true,
  • "usd_per_row": "0.0001",
  • "free_rows_per_month": 1000,
  • "minimum_cloud_version": "v1.2.3"
}

DeletePluginByTeamAndPluginName

Delete plugin by team and plugin name

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "errors": [
    ],
  • "field_errors": {
    }
}

ListPluginUpcomingPriceChanges Deprecated

DEPRECATED. Plugin prices are now managed by category. This endpoint will be removed in the near future and currently returns only empty data.

path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

CreatePluginUpcomingPriceChange Deprecated

DEPRECATED. Plugin prices are now managed by category. This endpoint will be removed in the near future and currently returns only empty data.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

Request Body schema: application/json
usd_per_row
required
string^\d+(?:\.\d{1,10})?$

The price per row in USD. This is used to calculate the price of a sync.

free_rows_per_month
required
integer <int64>

The number of rows that can be synced for free each month.

effective_from
required
string <date-time>

The date and time the price came (or will come) into effect.

Responses

Request samples

Content type
application/json
{
  • "usd_per_row": "0.0001",
  • "free_rows_per_month": 1000,
  • "effective_from": "2024-01-02T00:00:00Z"
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "usd_per_row": "0.0001",
  • "free_rows_per_month": 1000,
  • "effective_from": "2024-01-02T00:00:00Z"
}

DeletePluginUpcomingPriceChanges Deprecated

DEPRECATED. Plugin prices are now managed by category. This endpoint will be removed in the near future and currently returns only empty data.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0
}

ListPluginVersions

List all versions for a given plugin

path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

query Parameters
sort_by
string
Value: "created_at"

The field to sort by

page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

include_drafts
boolean

Whether to include draft versions

include_prereleases
boolean

Whether to include prerelease versions

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

GetPluginVersion

Get details about a given plugin version.

path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "published_at": "2017-07-14T16:53:42Z",
  • "name": "string",
  • "message": "- Added support for AWS S3 - Added support for AWS EC2",
  • "draft": true,
  • "retracted": true,
  • "protocols": [
    ],
  • "supported_targets": [
    ],
  • "checksums": [
    ],
  • "package_type": "native",
  • "spec_json_schema": "string",
  • "connector_required": true,
  • "connector_types": [
    ],
  • "example_config": "string"
}

CreatePluginVersion

Create a new plugin version, or update a draft version

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

Request Body schema: application/json
message
required
string [ 1 .. 30000 ] characters

A message describing what's new or changed in this version. This message will be displayed to users in the plugin's changelog. Supports limited markdown syntax.

protocols
required
Array of integers (PluginProtocols)
Items Value: 3

The CloudQuery protocols supported by this plugin version (only protocol 3 is supported by new plugins).

supported_targets
required
Array of strings

The targets supported by this plugin version, formatted as _

checksums
required
Array of strings

List of SHA-256 checksums for this plugin version, one for each supported target.

package_type
required
string (PluginPackageType)
Enum: "native" "docker"

The package type of the plugin assets

spec_json_schema
string (PluginSpecJSONSchema)

The specification of the plugin. This is a JSON schema that describes the configuration of the plugin.

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "protocols": [
    ],
  • "supported_targets": [
    ],
  • "checksums": [
    ],
  • "package_type": "native",
  • "spec_json_schema": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "published_at": "2017-07-14T16:53:42Z",
  • "name": "string",
  • "message": "- Added support for AWS S3 - Added support for AWS EC2",
  • "draft": true,
  • "retracted": true,
  • "protocols": [
    ],
  • "supported_targets": [
    ],
  • "checksums": [
    ],
  • "package_type": "native",
  • "spec_json_schema": "string",
  • "connector_required": true,
  • "connector_types": [
    ]
}

UpdatePluginVersion

Update a given plugin version

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

Request Body schema: application/json
message
string

Description of what's new or changed in this version (supports markdown)

draft
boolean

If a plugin version is in draft, it will not show to members outside the team or be counted as the latest version. Once draft is set to false, only certain fields can be updated.

retracted
boolean

If a plugin version is retracted, assets will still be available for download, but the version will be marked as retracted to discourage use.

protocols
Array of integers (PluginProtocols)
Items Value: 3

The CloudQuery protocols supported by this plugin version (only protocol 3 is supported by new plugins).

supported_targets
Array of strings
checksums
Array of strings

The SHA-256 checksums of the plugin binaries, one per supported target.

package_type
string

The package type of the plugin binaries

spec_json_schema
string (PluginSpecJSONSchema)

The specification of the plugin. This is a JSON schema that describes the configuration of the plugin.

Responses

Request samples

Content type
application/json
{
  • "message": "- Added support for *AWS S3* - Added support for *AWS EC2*",
  • "draft": true,
  • "retracted": true,
  • "protocols": [
    ],
  • "supported_targets": [
    ],
  • "checksums": [
    ],
  • "package_type": "string",
  • "spec_json_schema": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "published_at": "2017-07-14T16:53:42Z",
  • "name": "string",
  • "message": "- Added support for AWS S3 - Added support for AWS EC2",
  • "draft": true,
  • "retracted": true,
  • "protocols": [
    ],
  • "supported_targets": [
    ],
  • "checksums": [
    ],
  • "package_type": "native",
  • "spec_json_schema": "string",
  • "connector_required": true,
  • "connector_types": [
    ]
}

ListPluginVersionDocs

List all documentation pages for a given plugin version

path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

query Parameters
page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

CreatePluginVersionDocs

Create or update one or more plugin version docs pages

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

Request Body schema: application/json
required
Array of objects (CloudQuery Plugin Documentation Page)

Responses

Request samples

Content type
application/json
{
  • "pages": [
    ]
}

Response samples

Content type
application/json
{
  • "names": [
    ]
}

ReplacePluginVersionDocs

Replace (override) multiple plugin version docs pages

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

Request Body schema: application/json
required
Array of objects (CloudQuery Plugin Documentation Page)

Responses

Request samples

Content type
application/json
{
  • "pages": [
    ]
}

Response samples

Content type
application/json
{
  • "names": [
    ]
}

DeletePluginVersionDocs

Delete one or more plugin version docs pages.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

Request Body schema: application/json
names
required
Array of strings (PluginDocsPageName) [^[\w,\s-]+$]

Responses

Request samples

Content type
application/json
{
  • "names": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "errors": [
    ],
  • "field_errors": {
    }
}

ListPluginVersionTables

List tables for a given plugin version. This only applies to source plugins.

path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

query Parameters
page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

CreatePluginVersionTables

Create or update one or more plugin version tables. This only applies to source plugins, and can only be done if the plugin version is in draft.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

Request Body schema: application/json
required
Array of objects (CloudQuery Plugin Table)

Responses

Request samples

Content type
application/json
{
  • "tables": [
    ]
}

Response samples

Content type
application/json
{
  • "names": [
    ]
}

DeletePluginVersionTables

Delete one or more plugin version tables.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

Request Body schema: application/json
names
required
Array of strings (PluginTableName) [^[a-z](_?[a-z0-9]+)+$]

Responses

Request samples

Content type
application/json
{
  • "names": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": 0,
  • "errors": [
    ],
  • "field_errors": {
    }
}

GetPluginVersionTable

Get schema for a given table and plugin version. This only applies to source plugins.

path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

table_name
required
string

Responses

Response samples

Content type
application/json
{
  • "columns": [
    ],
  • "description": "string",
  • "is_incremental": true,
  • "name": "string",
  • "parent": "string",
  • "relations": [
    ],
  • "title": "string",
  • "is_paid": true
}

DownloadPluginAsset

Download an asset for a given plugin version and target

path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

target_name
required
string
header Parameters
Accept
string

Responses

Response samples

Content type
application/json
{}

UploadPluginAsset

Get a URL to upload an asset for a given plugin version and target

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

target_name
required
string

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

ListPluginsByTeam

List all plugins for the team.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

query Parameters
page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

include_private
boolean

Whether to include private plugins

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

DownloadPluginAssetByTeam

Download an asset for a given plugin version as the current team.

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_team
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PluginKind)
Enum: "source" "destination"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PluginName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-source

The unique name for the plugin.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

target_name
required
string
header Parameters
Accept
string

Responses

Response samples

Content type
application/json
{}

images

UploadImage

Get a URL to upload image that will be publicly accessible

Authorizations:
bearerAuth

Responses

Response samples

healthcheck

HealthCheck

Health check endpoint, returns 200

Responses

addons

ListAddons

List all addons

query Parameters
sort_by
string
Enum: "created_at" "updated_at" "name" "downloads"

The field to sort by

page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

Responses

Response samples

Content type
application/json
{
  • "items": [],
  • "metadata": {
    }
}

CreateAddon

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

Authorizations:
bearerAuth
Request Body schema: application/json
required
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$

The unique name for the team.

name
required
string (AddonName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$

The unique name for the addon.

category
required
string (AddonCategory)
Enum: "cloud-infrastructure" "databases" "sales-marketing" "engineering-analytics" "other"

Supported categories for addons

addon_type
required
string (AddonType)
Enum: "transformation" "visualization"

Supported types for addons

addon_format
required
string (AddonFormat)
Value: "zip"

Supported formats for addons

tier
required
string (AddonTier)
Enum: "free" "paid"

Supported tiers for addons

price_usd
string^\d+(?:\.\d{1,10})?$

The price for 6 months

short_description
required
string [ 1 .. 512 ] characters
display_name
required
string [ 1 .. 50 ] characters

The addon's display name

homepage
string
repository
string
logo
required
string
public
required
boolean

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.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "team_name": "cloudquery",
  • "name": "aws-policy",
  • "official": true,
  • "category": "cloud-infrastructure",
  • "addon_type": "transformation",
  • "addon_format": "zip",
  • "tier": "free",
  • "price_usd": "50",
  • "short_description": "AWS Asset inventory dashboard for grafana",
  • "display_name": "AWS Asset inventory",
  • "homepage": "https://cloudquery.io",
  • "public": true,
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z"
}

GetAddon

Get details about a given addon.

path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

addon_type
required
string (AddonType)
Enum: "transformation" "visualization"

Supported types for addons

addon_name
required
string (AddonName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-policy

The unique name for the addon.

Responses

Response samples

Content type
application/json
{
  • "team_name": "cloudquery",
  • "name": "aws-policy",
  • "official": true,
  • "category": "cloud-infrastructure",
  • "addon_type": "transformation",
  • "addon_format": "zip",
  • "tier": "free",
  • "price_usd": "50",
  • "short_description": "AWS Asset inventory dashboard for grafana",
  • "display_name": "AWS Asset inventory",
  • "homepage": "https://cloudquery.io",
  • "public": true,
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "latest_version": "string"
}

UpdateAddon

Update an Addon

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

addon_type
required
string (AddonType)
Enum: "transformation" "visualization"

Supported types for addons

addon_name
required
string (AddonName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-policy

The unique name for the addon.

Request Body schema: application/json
category
string (AddonCategory)
Enum: "cloud-infrastructure" "databases" "sales-marketing" "engineering-analytics" "other"

Supported categories for addons

addon_format
string (AddonFormat)
Value: "zip"

Supported formats for addons

tier
string (AddonTier)
Enum: "free" "paid"

Supported tiers for addons

price_usd
string^\d+(?:\.\d{1,10})?$

The price for 6 months in USD

short_description
string [ 1 .. 512 ] characters
display_name
string [ 1 .. 50 ] characters

The addon's display name

homepage
string
repository
string
logo
string
public
boolean

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_at
string <date-time>

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "team_name": "cloudquery",
  • "name": "aws-policy",
  • "official": true,
  • "category": "cloud-infrastructure",
  • "addon_type": "transformation",
  • "addon_format": "zip",
  • "tier": "free",
  • "price_usd": "50",
  • "short_description": "AWS Asset inventory dashboard for grafana",
  • "display_name": "AWS Asset inventory",
  • "homepage": "https://cloudquery.io",
  • "public": true,
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z"
}

ListAddonVersions

List all versions for a given addon

path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

addon_type
required
string (AddonType)
Enum: "transformation" "visualization"

Supported types for addons

addon_name
required
string (AddonName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-policy

The unique name for the addon.

query Parameters
sort_by
string
Value: "created_at"

The field to sort by

page
integer <int64> >= 1
Default: 1

Page number of the results to fetch

per_page
integer <int64> [ 1 .. 1000 ]
Default: 100

The number of results per page (max 1000).

include_drafts
boolean

Whether to include draft versions

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "metadata": {
    }
}

GetAddonVersion

Get details about a given addon version.

path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

addon_type
required
string (AddonType)
Enum: "transformation" "visualization"

Supported types for addons

addon_name
required
string (AddonName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-policy

The unique name for the addon.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "published_at": "2017-07-14T16:53:42Z",
  • "name": "string",
  • "message": "- Added support for *AWS S3* - Added support for *AWS EC2*",
  • "doc": "string",
  • "draft": true,
  • "plugin_deps": [
    ],
  • "addon_deps": [
    ],
  • "retracted": true,
  • "checksum": "string"
}

CreateAddonVersion

Create a new addon version, or update a draft version

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

addon_type
required
string (AddonType)
Enum: "transformation" "visualization"

Supported types for addons

addon_name
required
string (AddonName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: aws-policy

The unique name for the addon.

version_name
required
string (VersionName) ^v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(\.[0-...

The version in semantic version format.

Request Body schema: application/json
message
required
string [ 1 .. 30000 ] characters

A message describing what's new or changed in this version. This message will be displayed to users in the addon's changelog. Supports limited markdown syntax.

doc
required
string

Main README in MD format

plugin_deps
Array of strings

plugin dependencies in the format of ['team_name/kind/plugin_name@version']

addon_deps
Array of strings

addon dependencies in the format of ['team_name/type/addon_name@version']

checksum
required
string

SHA-256 checksum for the addon asset

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "doc": "string",
  • "plugin_deps": [
    ],
  • "addon_deps": [
    ],
  • "checksum": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "published_at": "2017-07-14T16:53:42Z",
  • "name": "string",
  • "message": "- Added support for *AWS S3* - Added support for *AWS EC2*",
  • "doc": "string",
  • "draft": true,
  • "plugin_deps": [
    ],
  • "addon_deps": [
    ],
  • "retracted": true,
  • "checksum": "string"
}

UpdateAddonVersion

Update a given addon version

Authorizations:
bearerAuth
path Parameters
team_name
required
string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

addon_type
required
string (AddonType)
Enum: "transformation" "visualization"

Supported types for addons

addon_name
required
string (AddonName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: