Download OpenAPI specification:Download
API to interact with CloudQuery Cloud
Get the current authenticated user from the OAuth token
{- "created_at": "2017-07-14T16:53:42Z",
- "id": "12345678-1234-1234-1234-1234567890ab",
- "email": "user@cloudquery.io",
- "name": "user",
- "updated_at": "2017-07-14T16:53:42Z"
}
Update attributes for the current authenticated user from the OAuth token
name | string [ 1 .. 255 ] characters The user's name |
{- "name": "string"
}
{- "created_at": "2017-07-14T16:53:42Z",
- "id": "12345678-1234-1234-1234-1234567890ab",
- "email": "user@cloudquery.io",
- "name": "user",
- "updated_at": "2017-07-14T16:53:42Z"
}
List of the current user's unaccepted invitations
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). |
{- "items": [
- {
- "team_name": "cloudquery",
- "email": "user@cloudquery.io",
- "role": "admin",
- "created_at": "2017-07-14T16:53:42Z",
- "token": "b5507016-7da2-4777-a161-1e8042a6a377"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Get memberships that the user has accepted.
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). |
{- "items": [
- {
- "role": "admin",
- "team": {
- "created_at": "2017-07-14T16:53:42Z",
- "name": "cloudquery",
- "display_name": "CloudQuery",
- "plan": "free",
- "is_trial_active": false
}
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
List all teams
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 |
{- "items": [
- {
- "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"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create a team owned by the current user.
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 |
{- "name": "cloudquery",
- "display_name": "string"
}
{- "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"
}
Get a team by name
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
{- "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"
}
Update team attributes
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
display_name | string The team's display name |
{- "display_name": "string"
}
{- "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"
}
Get URLs to upload images for a given team
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
required | Array of objects (Create Team Image Request) non-empty |
{- "images": [
- {
- "name": "string",
- "checksum": "string"
}
]
}
{- "items": [
- {
- "name": "string",
- "checksum": "string",
- "url": "string",
- "upload_url": "string"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Get memberships to the team.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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). |
{- "items": [
- {
- "role": "admin",
- "user": {
- "created_at": "2017-07-14T16:53:42Z",
- "email": "user@clouduery.io",
- "id": "12345678-1234-1234-1234-1234567890ab",
- "name": "user",
- "updated_at": "2017-07-14T16:53:42Z"
}
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Remove a user from the team
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
email required | string <email> (Email) Example: user@cloudquery.io |
{- "message": "string",
- "status": 0,
- "errors": [
- "string"
], - "field_errors": {
- "property1": "string",
- "property2": "string"
}
}
List all monthly limits for the team.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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). |
{- "items": [
- {
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "plugin_team": "cloudquery",
- "plugin_kind": "source",
- "plugin_name": "aws-source",
- "usd": 1000
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create a monthly limit for a plugin
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]+)+$ 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. |
usd required | integer [ 0 .. 1000000000 ] The maximum USD amount the plugin is allowed to use within a calendar month. |
{- "plugin_team": "cloudquery",
- "plugin_kind": "source",
- "plugin_name": "aws-source",
- "usd": 1000
}
{- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "plugin_team": "cloudquery",
- "plugin_kind": "source",
- "plugin_name": "aws-source",
- "usd": 1000
}
Get monthly spending limit for team.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
{- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "usd": 1000
}
Create a spending limit for a team
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
usd required | integer [ 0 .. 1000000000 ] The maximum USD amount the team is allowed to use within a calendar month. |
{- "usd": 1000
}
{- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "usd": 1000
}
Update a spending limit for a team
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
usd required | integer [ 0 .. 1000000000 ] The maximum USD amount the team is allowed to use within a calendar month. |
{- "usd": 1000
}
{- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "usd": 1000
}
Delete a spending limit for a team
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
{- "message": "string",
- "status": 0
}
Get a monthly limit for a plugin
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. |
{- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "plugin_team": "cloudquery",
- "plugin_kind": "source",
- "plugin_name": "aws-source",
- "usd": 1000
}
Update a monthly limit for a plugin
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. |
usd required | integer [ 0 .. 1000000000 ] The maximum USD amount the plugin is allowed to use within a calendar month. |
{- "usd": 1000
}
{- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "plugin_team": "cloudquery",
- "plugin_kind": "source",
- "plugin_name": "aws-source",
- "usd": 1000
}
Delete a monthly limit for a plugin
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. |
{- "message": "string",
- "status": 0
}
List all past invoices for the team.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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). |
{- "items": [
- {
- "created_at": "2017-07-14T16:53:42Z",
- "amount_due": 1000,
- "currency": "usd",
- "paid": true
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
List plugin usage for the current calendar month.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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). |
{- "items": [
- {
- "plugin_team": "cloudquery",
- "plugin_kind": "source",
- "plugin_name": "aws-source",
- "rows": 1000000,
- "usd": "43.95",
- "remaining_usd": "56.05",
- "remaining_rows": 1
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Increase the usage of a plugin. This can incur billing costs and should be used only by plugin SDKs.
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]+)+$ 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. |
{- "plugin_team": "cloudquery",
- "plugin_kind": "source",
- "plugin_name": "aws-source",
- "tables": [
- {
- "name": "my_table",
- "rows": 100
}
], - "rows": 1000000,
- "request_id": "123e4567-e89b-12d3-a456-426614174000"
}
{- "message": "string",
- "status": 0
}
Get plugin usage for the current calendar month.
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. |
{- "plugin_team": "cloudquery",
- "plugin_kind": "source",
- "plugin_name": "aws-source",
- "rows": 1000000,
- "usd": "43.95",
- "remaining_usd": "56.05",
- "remaining_rows": 1
}
Get a summary of usage for the specified time range, grouped by plugin.
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" |
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. |
{- "groups": [
- {
- "name": "plugin",
- "value": "cloudquery/source/aws"
}, - {
- "name": "plugin",
- "value": "cloudquery/source/gcp"
}
], - "values": [
- {
- "timestamp": "2021-01-01T00:00:00Z",
- "paid_rows": [
- 100,
- 200
]
}, - {
- "timestamp": "2021-01-02T00:00:00Z",
- "paid_rows": [
- 150,
- 300
]
}
], - "metadata": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "aggregation_period": "day"
}
}
List of open invitations to the team
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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). |
{- "items": [
- {
- "team_name": "cloudquery",
- "email": "user@cloudquery.io",
- "role": "admin",
- "created_at": "2017-07-14T16:53:42Z"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Invite a user to join a team with their email address
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
email required | string <email> |
role required | string Enum: "admin" "member" |
{- "email": "user@example.com",
- "role": "admin"
}
{- "team_name": "cloudquery",
- "email": "user@cloudquery.io",
- "role": "admin",
- "created_at": "2017-07-14T16:53:42Z"
}
Accept an invitation to the team, creating a user membership
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
token required | string <uuid> |
{- "token": "b5507016-7da2-4777-a161-1e8042a6a377"
}
{- "role": "admin",
- "team": {
- "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"
}
}
Cancel an invitation to the team, preventing the user becoming a team member
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
email required | string <email> (Email) Example: user@cloudquery.io |
{- "message": "string",
- "status": 0,
- "errors": [
- "string"
], - "field_errors": {
- "property1": "string",
- "property2": "string"
}
}
List all subscription orders for the team.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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). |
{- "items": [
- {
- "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",
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Start the checkout process for a subscription order.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
plan required | string (TeamPlan) Enum: "free" "paid" "enterprise" "trial" The plan the team is on |
success_url required | string URL to redirect to after successful order completion |
cancel_url required | string URL to redirect to after order cancellation |
{- "plan": "free",
}
{- "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",
}
Get a subscription order for the team.
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 |
{- "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",
}
List all users in the current team.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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 |
{- "items": [
- {
- "created_at": "2017-07-14T16:53:42Z",
- "id": "12345678-1234-1234-1234-1234567890ab",
- "email": "user@cloudquery.io",
- "name": "user",
- "updated_at": "2017-07-14T16:53:42Z"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
List all team API Keys
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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 |
{- "items": [
- {
- "name": "cli-api-key",
- "created_by": "user@cloudquery.io",
- "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"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create new team API Key.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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> |
{- "name": "cli-api-key",
- "expires_at": "2019-08-24T14:15:22Z"
}
{- "name": "cli-api-key",
- "created_by": "user@cloudquery.io",
- "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"
}
Delete API Key. This will remove any future access by this API Key.
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 |
{- "message": "string",
- "status": 0,
- "errors": [
- "string"
], - "field_errors": {
- "property1": "string",
- "property2": "string"
}
}
List all plugin notification requests
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). |
{- "items": [
- {
- "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"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create a new plugin notification request.
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. |
{- "plugin_team": "cloudquery",
- "plugin_kind": "source",
- "plugin_name": "aws-source"
}
{- "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"
}
Query plugin notification request for a given plugin.
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. |
{- "items": [
- {
- "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"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Remove plugin notification request for a given plugin.
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. |
{- "message": "string",
- "status": 0
}
List all plugins
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). |
{- "items": [
- {
- "name": "aws",
- "kind": "source",
- "team_name": "cloudquery",
- "display_name": "AWS Source Plugin",
- "category": "cloud-infrastructure",
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "official": true,
- "short_description": "Sync data from AWS to any destination",
- "tier": "paid",
- "usd_per_row": "0.00123",
- "free_rows_per_month": 10000,
- "release_stage": "preview"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create a plugin owned by the specified team. User must be part of that team.
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 |
tier required | string (PluginTier) Enum: "free" "paid" "open-core" Supported tiers for plugins |
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})?$ The price per row in USD. This is used to calculate the price of a sync. |
free_rows_per_month | integer <int64> The number of rows that can be synced for free each month. |
{- "team_name": "cloudquery",
- "kind": "source",
- "name": "aws-source",
- "category": "cloud-infrastructure",
- "tier": "free",
- "display_name": "AWS Source Plugin",
- "short_description": "Sync data from AWS to any destination",
- "public": true,
- "release_stage": "coming-soon",
- "usd_per_row": "0.00001",
- "free_rows_per_month": 10000
}
{- "team_name": "cloudquery",
- "name": "aws-source",
- "kind": "source",
- "category": "cloud-infrastructure",
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "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"
}
Get details about a given plugin.
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. |
{- "team_name": "cloudquery",
- "name": "aws-source",
- "kind": "source",
- "category": "cloud-infrastructure",
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "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"
}
Update a plugin
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. |
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 |
tier | string (PluginTier) Enum: "free" "paid" "open-core" Supported tiers for plugins |
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})?$ The price per row in USD. This is used to calculate the price of a sync. |
free_rows_per_month | integer <int64> The number of rows that can be synced for free each month. |
{- "category": "cloud-infrastructure",
- "tier": "free",
- "display_name": "AWS Source Plugin",
- "short_description": "Sync data from AWS to any destination",
- "public": true,
- "release_stage": "coming-soon",
- "usd_per_row": "0.0001",
- "free_rows_per_month": 1000
}
{- "team_name": "cloudquery",
- "name": "aws-source",
- "kind": "source",
- "category": "cloud-infrastructure",
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "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"
}
Delete plugin by team and plugin name
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. |
{- "message": "string",
- "status": 0,
- "errors": [
- "string"
], - "field_errors": {
- "property1": "string",
- "property2": "string"
}
}
List upcoming price changes for a given plugin. If the plugin has no upcoming price changes, an empty list is returned. At most one upcoming price change is returned.
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. |
{- "items": [
- {
- "id": "12345678-1234-1234-1234-1234567890ab",
- "usd_per_row": "0.0001",
- "free_rows_per_month": 1000,
- "effective_from": "2024-01-02T00:00:00Z"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create an upcoming plugin price change. If the plugin has no upcoming price change, a new one is created. If the plugin already has an upcoming price change, this call will fail. (Delete pending price changes with the appropriate delete call.) The effective date of the price change must be at least 8 days in the future.
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. |
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. |
{- "usd_per_row": "0.0001",
- "free_rows_per_month": 1000,
- "effective_from": "2024-01-02T00:00:00Z"
}
{- "id": "12345678-1234-1234-1234-1234567890ab",
- "usd_per_row": "0.0001",
- "free_rows_per_month": 1000,
- "effective_from": "2024-01-02T00:00:00Z"
}
Delete all pending plugin price changes.
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. |
{- "message": "string",
- "status": 0
}
List all versions for a given plugin
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. |
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 |
{- "items": [
- {
- "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": [
- 3
], - "supported_targets": [
- "linux_arm64",
- "darwin_amd64",
- "windows_amd64"
], - "checksums": [
- "string"
], - "package_type": "native"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Get details about a given plugin version.
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. |
{- "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": [
- 3
], - "supported_targets": [
- "linux_arm64",
- "darwin_amd64",
- "windows_amd64"
], - "checksums": [
- "string"
], - "package_type": "native",
- "spec_json_schema": "string",
- "example_config": "string"
}
Create a new plugin version, or update a draft version
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. |
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. |
{- "message": "string",
- "protocols": [
- 3
], - "supported_targets": [
- "linux_arm64",
- "darwin_amd64",
- "windows_amd64"
], - "checksums": [
- "string"
], - "package_type": "native",
- "spec_json_schema": "string"
}
{- "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": [
- 3
], - "supported_targets": [
- "linux_arm64",
- "darwin_amd64",
- "windows_amd64"
], - "checksums": [
- "string"
], - "package_type": "native",
- "spec_json_schema": "string"
}
Update a given plugin version
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. |
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. |
{- "message": "- Added support for *AWS S3* - Added support for *AWS EC2*",
- "draft": true,
- "retracted": true,
- "protocols": [
- 3
], - "supported_targets": [
- "string"
], - "checksums": [
- "string"
], - "package_type": "string",
- "spec_json_schema": "string"
}
{- "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": [
- 3
], - "supported_targets": [
- "linux_arm64",
- "darwin_amd64",
- "windows_amd64"
], - "checksums": [
- "string"
], - "package_type": "native",
- "spec_json_schema": "string"
}
List all documentation pages for a given plugin version
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. |
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). |
{- "items": [
- {
- "name": "overview",
- "content": "# Getting Started\n\nThis is the getting started page."
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create or update one or more plugin version docs pages
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. |
required | Array of objects (CloudQuery Plugin Documentation Page) |
{- "pages": [
- {
- "name": "overview",
- "content": "# Getting Started\n\nThis is the getting started page."
}
]
}
{- "names": [
- "overview"
]
}
Replace (override) multiple plugin version docs pages
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. |
required | Array of objects (CloudQuery Plugin Documentation Page) |
{- "pages": [
- {
- "name": "overview",
- "content": "# Getting Started\n\nThis is the getting started page."
}
]
}
{- "names": [
- "overview"
]
}
Delete one or more plugin version docs pages.
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. |
names required | Array of strings (PluginDocsPageName) [^[\w,\s-]+$] |
{- "names": [
- "overview"
]
}
{- "message": "string",
- "status": 0,
- "errors": [
- "string"
], - "field_errors": {
- "property1": "string",
- "property2": "string"
}
}
List tables for a given plugin version. This only applies to source plugins.
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. |
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). |
{- "items": [
- {
- "description": "AWS S3 Buckets",
- "is_incremental": true,
- "name": "aws_ec2_instances",
- "parent": "nil",
- "relations": [
- "aws_s3_bucket_cors_rules"
], - "title": "AWS S3 Buckets",
- "is_paid": true
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
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.
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. |
required | Array of objects (CloudQuery Plugin Table) |
{- "tables": [
- {
- "description": "AWS S3 Buckets",
- "is_incremental": true,
- "name": "aws_ec2_instances",
- "parent": "nil",
- "relations": [
- "aws_s3_bucket_cors_rules"
], - "title": "AWS S3 Buckets",
- "is_paid": true,
- "columns": [
- {
- "description": "string",
- "incremental_key": true,
- "name": "string",
- "not_null": true,
- "primary_key": true,
- "type": "string",
- "unique": true
}
]
}
]
}
{- "names": [
- "aws_ec2_instances"
]
}
Delete one or more plugin version tables.
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. |
names required | Array of strings (PluginTableName) [^[a-z](_?[a-z0-9]+)+$] |
{- "names": [
- "aws_ec2_instances"
]
}
{- "message": "string",
- "status": 0,
- "errors": [
- "string"
], - "field_errors": {
- "property1": "string",
- "property2": "string"
}
}
Get schema for a given table and plugin version. This only applies to source plugins.
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 |
{- "columns": [
- {
- "description": "string",
- "incremental_key": true,
- "name": "string",
- "not_null": true,
- "primary_key": true,
- "type": "string",
- "unique": true
}
], - "description": "string",
- "is_incremental": true,
- "name": "string",
- "parent": "string",
- "relations": [
- "string"
], - "title": "string",
- "is_paid": true
}
Download an asset for a given plugin version and target
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 |
Accept | string |
{- "checksum": "string",
}
Get a URL to upload an asset for a given plugin version and target
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 |
{- "url": "string"
}
List all plugins for the team.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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 |
{- "items": [
- {
- "name": "aws-source",
- "kind": "source",
- "team_name": "cloudquery",
- "display_name": "AWS Source Plugin",
- "category": "cloud-infrastructure",
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "official": true,
- "short_description": "Sync data from AWS to any destination",
- "tier": "paid",
- "usd_per_row": "0.00123",
- "free_rows_per_month": 10000,
- "release_stage": "preview"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Download an asset for a given plugin version as the current team.
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 |
Accept | string |
{- "checksum": "string",
}
List all addons
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). |
{- "items": [
- {
- "name": "aws-policies",
- "team_name": "cloudquery",
- "display_name": "AWS Policies",
- "category": "cloud-infrastructure",
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "official": true,
- "short_description": "Sync data from AWS to any destination",
- "tier": "free",
- "price_usd": "50",
- "addon_type": "visualization",
- "addon_format": "zip"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create an addon owned by the specified team. User must be part of that team.
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. |
{- "team_name": "cloudquery",
- "name": "aws-policy",
- "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",
- "public": true
}
{- "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",
- "public": true,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z"
}
Get details about a given addon.
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. |
{- "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",
- "public": true,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "latest_version": "string"
}
Update an Addon
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. |
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> |
{- "category": "cloud-infrastructure",
- "addon_format": "zip",
- "tier": "free",
- "price_usd": "50",
- "short_description": "AWS Asset inventory dashboard for grafana",
- "display_name": "AWS Asset inventory",
- "public": true,
- "created_at": "2017-07-14T16:53:42Z"
}
{- "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",
- "public": true,
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z"
}
List all versions for a given addon
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. |
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 |
{- "items": [
- {
- "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": [
- "string"
], - "addon_deps": [
- "string"
], - "retracted": true,
- "checksum": "string"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Get details about a given addon version.
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. |
{- "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": [
- "string"
], - "addon_deps": [
- "string"
], - "retracted": true,
- "checksum": "string"
}
Create a new addon version, or update a draft version
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. |
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 |
{- "message": "string",
- "doc": "string",
- "plugin_deps": [
- "string"
], - "addon_deps": [
- "string"
], - "checksum": "string"
}
{- "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": [
- "string"
], - "addon_deps": [
- "string"
], - "retracted": true,
- "checksum": "string"
}
Update a given addon version
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. |
message | string Description of what's new or changed in this version (supports markdown) |
doc | string Main README in MD format |
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. |
plugin_deps | Array of strings list of plugins the addon depends on in the format of team_name/kind/name@version |
addon_deps | Array of strings list of other addons this addon depends on in the format of team_name/type/name@version |
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. |
checksum | string The checksum of the addon asset |
{- "message": "- Added support for *AWS S3* - Added support for *AWS EC2*",
- "doc": "string",
- "draft": true,
- "plugin_deps": [
- "string"
], - "addon_deps": [
- "string"
], - "retracted": true,
- "checksum": "string"
}
{- "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": [
- "string"
], - "addon_deps": [
- "string"
], - "retracted": true,
- "checksum": "string"
}
Download an asset for a given version
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. |
Accept | string |
{- "checksum": "string",
}
Get a URL to upload an asset for a given addon version
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. |
{- "url": "string"
}
List all addons for the team.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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 |
{- "items": [
- {
- "name": "aws-policies",
- "team_name": "cloudquery",
- "display_name": "AWS Policies",
- "category": "cloud-infrastructure",
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "official": true,
- "short_description": "AWS policies",
- "tier": "paid",
- "price_usd": "50",
- "addon_type": "visualization",
- "addon_format": "zip"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
List all addon orders for the team.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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). |
{- "items": [
- {
- "id": "12345678-1234-1234-1234-1234567890ab",
- "team_name": "cloudquery",
- "addon_team": "cloudquery",
- "addon_type": "transformation",
- "addon_name": "aws-policy",
- "status": "pending",
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "completed_at": "2017-07-14T16:53:42Z",
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Start the checkout process for an addon order.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
addon_team required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ 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]+)+$ The unique name for the addon. |
success_url required | string URL to redirect to after successful order completion |
cancel_url required | string URL to redirect to after order cancellation |
{- "addon_team": "cloudquery",
- "addon_type": "transformation",
- "addon_name": "aws-policy",
}
{- "id": "12345678-1234-1234-1234-1234567890ab",
- "team_name": "cloudquery",
- "addon_team": "cloudquery",
- "addon_type": "transformation",
- "addon_name": "aws-policy",
- "status": "pending",
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "completed_at": "2017-07-14T16:53:42Z",
}
Get an addon order for the team.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
addon_order_id required | string <uuid> (AddonOrderID) Example: 12345678-1234-1234-1234-1234567890ab ID of the addon order |
{- "id": "12345678-1234-1234-1234-1234567890ab",
- "team_name": "cloudquery",
- "addon_team": "cloudquery",
- "addon_type": "transformation",
- "addon_name": "aws-policy",
- "status": "pending",
- "created_at": "2017-07-14T16:53:42Z",
- "updated_at": "2017-07-14T16:53:42Z",
- "completed_at": "2017-07-14T16:53:42Z",
}
Download an asset for a given addon version as the current team.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
addon_team 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. |
Accept | string |
{- "checksum": "string",
}
Performs authentication and authorization for our image registry.
account | string Username used for |
service | string Service requesting the JTW token |
scope | string Multi-value string containing the repository being access and the operation type (push/pull) |
X-Meta-Plugin-Version | string Example: v1.0.0 Plugin version name |
X-Meta-User-Team-Name | string User's team name |
{- "access_token": "string",
- "token": "string"
}
List all sync source definitions.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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 |
{- "items": [
- {
- "name": "my-source-definition",
- "path": "string",
- "version": "v1.2.3",
- "tables": [
- "string"
], - "skip_tables": [
- "string"
], - "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml",
- "created_at": "2023-07-14T16:53:42Z",
- "updated_at": "2023-07-14T16:53:42Z"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create new Sync Source definition.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
name required | string^[a-zA-Z0-9_-]+$ Descriptive, unique name for the source. The name can only contain ASCII letters, digits, - and _. |
path required | string (SyncPluginPath) ^cloudquery/[^/]+ Plugin path in CloudQuery registry |
version required | string Version of the plugin |
tables required | Array of strings Tables to sync. Wildcards are supported. Note that child tables are excluded by default, and need to be explicitly specified. |
skip_tables | Array of strings Tables matched by |
object <Plugin parameters, specific to each plugin> | |
Array of objects (SyncEnvCreate) Environment variables for the plugin. All environment variables will be stored as secrets. | |
last_update_source | string (SyncLastUpdateSource) Enum: "yaml" "ui" How was the source or destination been created or updated last |
{- "name": "my-source-definition",
- "path": "string",
- "version": "v1.2.3",
- "tables": [
- "string"
], - "skip_tables": [
- "string"
], - "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml"
}
{- "name": "my-source-definition",
- "path": "string",
- "version": "v1.2.3",
- "tables": [
- "string"
], - "skip_tables": [
- "string"
], - "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml",
- "created_at": "2023-07-14T16:53:42Z",
- "updated_at": "2023-07-14T16:53:42Z"
}
Test a Sync Source definition.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
name required | string^[a-zA-Z0-9_-]+$ Descriptive, unique name for the source. The name can only contain ASCII letters, digits, - and _. |
path required | string (SyncPluginPath) ^cloudquery/[^/]+ Plugin path in CloudQuery registry |
version required | string Version of the plugin |
tables required | Array of strings Tables to sync. Wildcards are supported. Note that child tables are excluded by default, and need to be explicitly specified. |
skip_tables | Array of strings Tables matched by |
object <Plugin parameters, specific to each plugin> | |
Array of objects (SyncEnvCreate) Environment variables for the plugin. All environment variables will be stored as secrets. | |
last_update_source | string (SyncLastUpdateSource) Enum: "yaml" "ui" How was the source or destination been created or updated last |
{- "name": "my-source-definition",
- "path": "string",
- "version": "v1.2.3",
- "tables": [
- "string"
], - "skip_tables": [
- "string"
], - "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml"
}
{- "id": "12345678-1234-1234-1234-1234567890ab",
- "status": "completed",
- "created_at": "2017-07-14T16:53:42Z",
- "completed_at": "2017-07-14T16:53:42Z"
}
Get a single sync source definition.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_source_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync source |
{- "name": "my-source-definition",
- "path": "string",
- "version": "v1.2.3",
- "tables": [
- "string"
], - "skip_tables": [
- "string"
], - "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml",
- "created_at": "2023-07-14T16:53:42Z",
- "updated_at": "2023-07-14T16:53:42Z"
}
Update a Sync Source definition.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_source_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync source |
path | string (SyncPluginPath) ^cloudquery/[^/]+ Plugin path in CloudQuery registry |
version | string Version of the plugin |
tables | Array of strings Tables to sync. Wildcards are supported. Note that child tables are excluded by default, and need to be explicitly specified. |
skip_tables | Array of strings Tables matched by |
object <Plugin parameters, specific to each plugin> | |
Array of objects (SyncEnvCreate) Environment variables for the plugin. All environment variables will be stored as secrets. | |
last_update_source | string (SyncLastUpdateSource) Enum: "yaml" "ui" How was the source or destination been created or updated last |
{- "path": "string",
- "version": "v1.2.3",
- "tables": [
- "string"
], - "skip_tables": [
- "string"
], - "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml"
}
{- "name": "my-source-definition",
- "path": "string",
- "version": "v1.2.3",
- "tables": [
- "string"
], - "skip_tables": [
- "string"
], - "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml",
- "created_at": "2023-07-14T16:53:42Z",
- "updated_at": "2023-07-14T16:53:42Z"
}
Delete a Sync Source definition. Any syncs relying on this source must be deleted first.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_source_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync source |
{- "message": "string",
- "status": 0
}
List all sync destination definitions.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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 |
{- "items": [
- {
- "name": "my-destination-definition",
- "path": "string",
- "version": "v1.2.3",
- "write_mode": "append",
- "migrate_mode": "safe",
- "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml",
- "created_at": "2023-07-14T16:53:42Z",
- "updated_at": "2023-07-14T16:53:42Z"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create new Sync Destination definition.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
name required | string^[a-zA-Z0-9_-]+$ Descriptive, unique name for the destination. The name can only contain ASCII letters, digits, - and _. |
path required | string (SyncPluginPath) ^cloudquery/[^/]+ Plugin path in CloudQuery registry |
version required | string Version of the plugin |
write_mode | string (SyncDestinationWriteMode) Enum: "append" "overwrite" "overwrite-delete-stale" Write mode for the destination |
migrate_mode | string (SyncDestinationMigrateMode) Enum: "safe" "forced" Migrate mode for the destination |
object <Plugin parameters, specific to each plugin> | |
Array of objects (SyncEnvCreate) Environment variables for the plugin. All environment variables will be stored as secrets. | |
last_update_source | string (SyncLastUpdateSource) Enum: "yaml" "ui" How was the source or destination been created or updated last |
{- "name": "my-destination-definition",
- "path": "string",
- "version": "v1.2.3",
- "write_mode": "append",
- "migrate_mode": "safe",
- "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml"
}
{- "name": "my-destination-definition",
- "path": "string",
- "version": "v1.2.3",
- "write_mode": "append",
- "migrate_mode": "safe",
- "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml",
- "created_at": "2023-07-14T16:53:42Z",
- "updated_at": "2023-07-14T16:53:42Z"
}
Test a Sync Destination definition.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
name required | string^[a-zA-Z0-9_-]+$ Descriptive, unique name for the destination. The name can only contain ASCII letters, digits, - and _. |
path required | string (SyncPluginPath) ^cloudquery/[^/]+ Plugin path in CloudQuery registry |
version required | string Version of the plugin |
write_mode | string (SyncDestinationWriteMode) Enum: "append" "overwrite" "overwrite-delete-stale" Write mode for the destination |
migrate_mode | string (SyncDestinationMigrateMode) Enum: "safe" "forced" Migrate mode for the destination |
object <Plugin parameters, specific to each plugin> | |
Array of objects (SyncEnvCreate) Environment variables for the plugin. All environment variables will be stored as secrets. | |
last_update_source | string (SyncLastUpdateSource) Enum: "yaml" "ui" How was the source or destination been created or updated last |
{- "name": "my-destination-definition",
- "path": "string",
- "version": "v1.2.3",
- "write_mode": "append",
- "migrate_mode": "safe",
- "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml"
}
{- "id": "12345678-1234-1234-1234-1234567890ab",
- "status": "completed",
- "created_at": "2017-07-14T16:53:42Z",
- "completed_at": "2017-07-14T16:53:42Z"
}
Get a single sync destination definition.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_destination_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync destination |
{- "name": "my-destination-definition",
- "path": "string",
- "version": "v1.2.3",
- "write_mode": "append",
- "migrate_mode": "safe",
- "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml",
- "created_at": "2023-07-14T16:53:42Z",
- "updated_at": "2023-07-14T16:53:42Z"
}
Update a Sync Destination definition.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_destination_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync destination |
path | string (SyncPluginPath) ^cloudquery/[^/]+ Plugin path in CloudQuery registry |
version | string Version of the plugin |
write_mode | string (SyncDestinationWriteMode) Enum: "append" "overwrite" "overwrite-delete-stale" Write mode for the destination |
migrate_mode | string (SyncDestinationMigrateMode) Enum: "safe" "forced" Migrate mode for the destination |
object <Plugin parameters, specific to each plugin> | |
Array of objects (SyncEnvCreate) Environment variables for the plugin. All environment variables will be stored as secrets. | |
last_update_source | string (SyncLastUpdateSource) Enum: "yaml" "ui" How was the source or destination been created or updated last |
{- "path": "string",
- "version": "v1.2.3",
- "write_mode": "append",
- "migrate_mode": "safe",
- "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml"
}
{- "name": "my-destination-definition",
- "path": "string",
- "version": "v1.2.3",
- "write_mode": "append",
- "migrate_mode": "safe",
- "spec": { },
- "env": [
- {
- "name": "string",
- "value": "string"
}
], - "last_update_source": "yaml",
- "created_at": "2023-07-14T16:53:42Z",
- "updated_at": "2023-07-14T16:53:42Z"
}
Delete a Sync Destination definition. Any syncs relying on this destination must be deleted first.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_destination_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync destination |
{- "message": "string",
- "status": 0
}
List all Syncs.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
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 |
{- "items": [
- {
- "name": "string",
- "source": "string",
- "destinations": [
- "string"
], - "disabled": true,
- "schedule": "string",
- "cpu": "1",
- "memory": "2Gi",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": "string"
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create new Sync definition. Sync runs can be scheduled automatically, or triggered manually after sync is created.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
name required | string^[a-zA-Z0-9_-]+$ Descriptive, unique name for the sync. The name can only contain ASCII letters, digits, - and _. |
source required | string^[a-zA-Z0-9_-]+$ Unique name of the source |
destinations required | Array of strings non-empty [^[a-zA-Z0-9_-]+$] |
schedule | string Cron schedule for the sync |
disabled | boolean Default: false Whether the sync is disabled |
cpu | string Default: "1" CPU quota for the sync |
memory | string Default: "2Gi" Memory quota for the sync |
{- "name": "string",
- "source": "string",
- "destinations": [
- "string"
], - "schedule": "string",
- "disabled": false,
- "cpu": "1",
- "memory": "2Gi"
}
{- "name": "string",
- "source": "string",
- "destinations": [
- "string"
], - "disabled": true,
- "schedule": "string",
- "cpu": "1",
- "memory": "2Gi",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": "string"
}
Get a Sync
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync |
{- "name": "string",
- "source": "string",
- "destinations": [
- "string"
], - "disabled": true,
- "schedule": "string",
- "cpu": "1",
- "memory": "2Gi",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": "string"
}
Update a Sync
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync |
source | string^[a-zA-Z0-9_-]+$ Unique name of the source |
destinations | Array of strings non-empty [^[a-zA-Z0-9_-]+$] |
schedule | string Cron schedule for the sync |
disabled | boolean Default: false Whether the sync is disabled |
Array of objects (SyncEnv) Environment variables for the sync | |
cpu | string Default: "1" CPU quota for the sync |
memory | string Default: "2Gi" Memory quota for the sync |
{- "source": "string",
- "destinations": [
- "string"
], - "schedule": "string",
- "disabled": false,
- "env": [
- {
- "name": "string"
}
], - "cpu": "1",
- "memory": "2Gi"
}
{- "name": "string",
- "source": "string",
- "destinations": [
- "string"
], - "disabled": true,
- "schedule": "string",
- "cpu": "1",
- "memory": "2Gi",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_by": "string"
}
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.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync |
{- "message": "string",
- "status": 0,
- "errors": [
- "string"
], - "field_errors": {
- "property1": "string",
- "property2": "string"
}
}
List all Sync Runs.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync |
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 |
{- "items": [
- {
- "sync_name": "string",
- "id": "12345678-1234-1234-1234-1234567890ab",
- "status": "completed",
- "created_at": "2017-07-14T16:53:42Z",
- "completed_at": "2017-07-14T16:53:42Z",
- "total_rows": 0,
- "warnings": 0,
- "errors": 0
}
], - "metadata": {
- "total_count": 0,
- "last_page": 0
}
}
Create new SyncRun. This will trigger a manual job run.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync |
{- "sync_name": "string",
- "id": "12345678-1234-1234-1234-1234567890ab",
- "status": "completed",
- "created_at": "2017-07-14T16:53:42Z",
- "completed_at": "2017-07-14T16:53:42Z",
- "total_rows": 0,
- "warnings": 0,
- "errors": 0
}
Get a Sync Run.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync |
sync_run_id required | string <uuid> (SyncRunID) Example: 12345678-1234-1234-1234-1234567890ab ID of the SyncRun |
{- "sync_name": "string",
- "id": "12345678-1234-1234-1234-1234567890ab",
- "status": "completed",
- "created_at": "2017-07-14T16:53:42Z",
- "completed_at": "2017-07-14T16:53:42Z",
- "total_rows": 0,
- "warnings": 0,
- "errors": 0,
- "cpu_seconds": 0,
- "memory_byte_seconds": 0,
- "network_egress_bytes": 0
}
Update a SyncRun
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync |
sync_run_id required | string <uuid> (SyncRunID) Example: 12345678-1234-1234-1234-1234567890ab ID of the SyncRun |
status | string (SyncRunStatus) Enum: "completed" "failed" "started" "cancelled" "created" The status of the sync run |
{- "status": "completed"
}
{- "sync_name": "string",
- "id": "12345678-1234-1234-1234-1234567890ab",
- "status": "completed",
- "created_at": "2017-07-14T16:53:42Z",
- "completed_at": "2017-07-14T16:53:42Z",
- "total_rows": 0,
- "warnings": 0,
- "errors": 0
}
Get logs for a sync run.
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_name required | string^[a-zA-Z0-9_-]+$ Unique name of the sync |
sync_run_id required | string <uuid> (SyncRunID) Example: 12345678-1234-1234-1234-1234567890ab ID of the SyncRun |
Accept | string |
{
}
Get a Sync Test Connection
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_test_connection_id required | string <uuid> (SyncTestConnectionID) Example: 12345678-1234-1234-1234-1234567890ab unique ID of the test connection |
{- "id": "12345678-1234-1234-1234-1234567890ab",
- "status": "completed",
- "created_at": "2017-07-14T16:53:42Z",
- "completed_at": "2017-07-14T16:53:42Z"
}
Update a Sync Test Connection
team_name required | string (TeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$ Example: cloudquery The unique name for the team. |
sync_test_connection_id required | string <uuid> (SyncTestConnectionID) Example: 12345678-1234-1234-1234-1234567890ab unique ID of the test connection |
status required | string (SyncTestConnectionStatus) Enum: "completed" "failed" "started" "created" The status of the sync run |
{- "status": "completed"
}
{- "id": "12345678-1234-1234-1234-1234567890ab",
- "status": "completed",
- "created_at": "2017-07-14T16:53:42Z",
- "completed_at": "2017-07-14T16:53:42Z"
}