API docs by Redocly

CloudQuery Platform OpenAPI Spec (1.0.0)

Download OpenAPI specification:Download

CloudQuery Support Team: [email protected] URL: https://cloudquery.io License: MIT Terms of Service

Welcome to the CloudQuery Platform API documentation! This API can be used to interact with the CloudQuery platform. As a user, the API allows you to search the CloudQuery asset inventory, run SQL queries against the data warehouse, save and load searches, and much more. As an administrator, it allows you to manage your teams, syncs, and other objects.

Authentication

The API is secured using bearer tokens. To get started, you can generate an API key for your Platform deployment from your platform dashboard. For a step-by-step guide, see: https://docs.cloudquery.io/docs/deployment/generate-api-key. The base URL for the API depends on where your CloudQuery Platform is hosted. If running locally, this is usually http://localhost:3000/api. In a production deployment it should be an HTTPS URL. For purposes of illustration, we will assume the platform instance is available at https://cloudquery.mycompany.com. In this case, the base API endpoint will be https://cloudquery.mycompany.com/api.

Example Request

To test your connection to the API, we can use the /plugins endpoint. For example: curl -v -H "Authorization: Bearer $CLOUDQUERY_API_KEY" \ https://cloudquery.mycompany.com/api/plugins

users

PlatformGetCurrentUser

Get the current authenticated user from the OAuth token

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "email": "[email protected]",
  • "name": "Sarah O'Connor",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "profile_image_url": "string",
  • "event_identifiers": { },
  • "group_identifier": "string",
  • "registered_team_name": "string",
  • "registered_team_internal": true
}

PlatformUpdateCurrentUser

Update attributes for the current authenticated user from the OAuth token

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
name
string (PlatformUserName) [ 1 .. 255 ] characters ^[a-zA-Z\p{L}][a-zA-Z\p{L} \-']*$

The unique name for the user.

tracking_opt_in
boolean

Whether to opt in or out of anonymous user tracking

Responses

Request samples

Content type
application/json
{
  • "name": "Sarah O'Connor",
  • "tracking_opt_in": true
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "email": "[email protected]",
  • "name": "Sarah O'Connor",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "profile_image_url": "string"
}

PlatformLoginUser

Start a session using ID token

Request Body schema: application/json
id_token
required
string

Responses

Request samples

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

Response samples

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

PlatformLogoutUser

Logout a session

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

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

PlatformListCurrentUserInvitations

List of the current user's unaccepted invitations

Authorizations:
bearerAuthcookieAuth
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": {
    }
}

PlatformGetCurrentUserMemberships

Get memberships that the user has accepted.

Authorizations:
bearerAuthcookieAuth
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": {
    }
}

PlatformGetCurrentLocalUser

Get the current authenticated local user

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "email": "[email protected]",
  • "name": "Sarah O'Connor",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "profile_image_url": "string",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "is_admin": true,
  • "roles": [
    ],
  • "enabled": true,
  • "provider": "local",
  • "tracking_opted_in": true,
  • "teams": [
    ]
}

PlatformAuthenticateLocalUser

Authenticate a user with password

Request Body schema: application/json
email
required
string
password
required
string

Responses

Request samples

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

Response samples

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

PlatformResetLocalUserPassword

Reset user password with token

Request Body schema: application/json
email
required
string
reset_token
required
string
new_password
required
string

Responses

Request samples

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

Response samples

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

PlatformChangeLocalUserPassword

Change user password

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
email
required
string
old_password
required
string
new_password
required
string

Responses

Request samples

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

Response samples

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

PlatformListLocalUsers

List all users

Authorizations:
bearerAuthcookieAuth
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": {
    }
}

PlatformAddLocalUser

Add new user

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
email
required
string
name
required
string
is_admin
boolean
Deprecated

DEPRECATED. Use roles instead

password
string
roles
required
Array of strings >= 0 items
Items Enum: "admin:write" "admin:read"

Global roles for the user

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "is_admin": true,
  • "password": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "email": "[email protected]",
  • "name": "Sarah O'Connor",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "profile_image_url": "string",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "is_admin": true,
  • "roles": [
    ],
  • "enabled": true,
  • "provider": "local",
  • "tracking_opted_in": true
}

PlatformGetLocalUser

Get user details

Authorizations:
bearerAuthcookieAuth
path Parameters
user_id
required
string <uuid> (PlatformUserID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the User

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "email": "[email protected]",
  • "name": "Sarah O'Connor",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "profile_image_url": "string",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "is_admin": true,
  • "roles": [
    ],
  • "enabled": true,
  • "provider": "local",
  • "tracking_opted_in": true,
  • "teams": [
    ]
}

PlatformUpdateLocalUser

Update user

Authorizations:
bearerAuthcookieAuth
path Parameters
user_id
required
string <uuid> (PlatformUserID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the User

Request Body schema: application/json
email
string
name
string
password
string
enabled
boolean
is_admin
boolean
Deprecated

DEPRECATED. Use roles instead

roles
Array of strings
Items Enum: "admin:write" "admin:read"

Global roles for the user

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "password": "string",
  • "enabled": true,
  • "is_admin": true,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "email": "[email protected]",
  • "name": "Sarah O'Connor",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "profile_image_url": "string",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "is_admin": true,
  • "roles": [
    ],
  • "enabled": true,
  • "provider": "local",
  • "tracking_opted_in": true
}

PlatformDeleteLocalUser

Delete user

Authorizations:
bearerAuthcookieAuth
path Parameters
user_id
required
string <uuid> (PlatformUserID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the User

Responses

Response samples

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

PlatformCreateLocalUserResetToken

Create password reset token for user

Authorizations:
bearerAuthcookieAuth
path Parameters
user_id
required
string <uuid> (PlatformUserID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the User

Responses

Response samples

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

teams

PlatformListTeams

List all teams

Authorizations:
bearerAuthcookieAuth
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": {
    }
}

PlatformCreateTeam

Create a team owned by the current user.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
name
required
string (PlatformTeamName) <= 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",
  • "internal": false
}

PlatformGetTeamByName

Get a team by name

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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",
  • "internal": false
}

PlatformUpdateTeam

Update team attributes

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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",
  • "internal": false
}

PlatformCreateTeamImages

Get URLs to upload images for a given team

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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": {
    }
}

PlatformGetTeamMemberships

Get memberships to the team.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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": {
    }
}

PlatformRemoveTeamMembership

Remove a user from the team

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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": {
    }
}

PlatformDeleteTeamMembership Deprecated

Remove a user from the team

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

The unique name for the team.

email
required
string

Responses

Response samples

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

PlatformListTeamInvitations

List of open invitations to the team

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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": {
    }
}

PlatformDeleteTeamInvitation

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

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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
{}

Response samples

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

PlatformAcceptTeamInvitation

Accept an invitation to the team, creating a user membership

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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:read",
  • "roles": [
    ],
  • "team": {
    }
}

PlatformListUsersByTeam

List all users in the current team.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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": {
    }
}

PlatformListTeamAPIKeys

List all team API Keys

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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": {
    },
  • "allowed_roles": [
    ]
}

PlatformCreateTeamAPIKey

Create new team API Key.

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

The unique name for the team.

Request Body schema: application/json
name
required
string (PlatformAPIKeyName) [ 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>
Array of objects (PlatformAPIKeyTeamRole)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "name": "cli-api-key",
  • "created_by": "[email protected]",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "key": "1234567890abcdef1234567890abcdef",
  • "created_at": "2017-07-14T16:53:42Z",
  • "expires_at": "2017-07-14T16:53:42Z",
  • "last_access_at": "2017-07-14T16:53:42Z",
  • "expired": false,
  • "roles": [
    ]
}

PlatformDeleteTeamAPIKey

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

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

The unique name for the team.

apikey_id
required
string <uuid> (PlatformAPIKeyID)
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": {
    }
}

PlatformCreateAWSOnboarding

Create an interactive onboarding for AWS

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

The unique name for the team.

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "issuer_url": "string",
  • "audience": "string",
  • "subject": "string",
  • "notify_path": "string",
  • "template_url": "string",
  • "notify_token": "string"
}

PlatformGetAWSOnboarding

Query an interactive onboarding for AWS

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

The unique name for the team.

onboarding_id
required
string <uuid> (PlatformOnboardingID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the cloud provider onboarding session

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "stage": "string",
  • "created_at": "2017-07-14T16:53:42Z",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "issuer_url": "string",
  • "audience": "string",
  • "subject": "string",
  • "management_role_arn": "string",
  • "failure_reason": "string"
}

PlatformNotifyOnboarding

Update onboarding state

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

The unique name for the team.

onboarding_id
required
string <uuid> (PlatformOnboardingID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the cloud provider onboarding session

Request Body schema: application/json
status
required
string
Enum: "deployed" "failed" "started"
management_role_arn
string

ARN of the role to use for account management (required if status is deployed)

reason
string

Reason for deployment failure (required if status is failed)

Responses

Request samples

Content type
application/json
{
  • "status": "deployed",
  • "management_role_arn": "string",
  • "reason": "string"
}

Response samples

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

PlatformGetAWSAccountsInRoot

Query AWS accounts under organization root

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

The unique name for the team.

onboarding_id
required
string <uuid> (PlatformOnboardingID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the cloud provider onboarding session

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "arn": "string",
  • "type": "OU",
  • "name": "string",
  • "children": [
    ]
}

PlatformGetAWSAccountsInParent

Query AWS accounts under a specifc Organizational Unit

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

The unique name for the team.

onboarding_id
required
string <uuid> (PlatformOnboardingID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the cloud provider onboarding session

aws_orgunit_id
required
string (PlatformOrganizationalUnitID) ^ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}$
Example: ou-7f3s-j8zfa1ao

ID of an organizational unit in AWS

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "arn": "string",
  • "type": "OU",
  • "name": "string",
  • "children": [
    ]
}

PlatformGetTeamUsageSummary

Get a summary of usage for the specified time range.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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": {
    }
}

PlatformGetGroupedTeamUsageSummary

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

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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": {
    }
}

PlatformManageListAllTeams

List all teams

Authorizations:
bearerAuthcookieAuth
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": {
    }
}

PlatformManageGetTeam

Get a team

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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",
  • "internal": false
}

PlatformManageDeleteTeam

Delete a team

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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,
  • "errors": [
    ],
  • "field_errors": {
    }
}

PlatformManageListTeamMembers

List team members

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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": {
    }
}

PlatformManageAddTeamMember

Add team member

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

The unique name for the team.

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

ID of the User

roles
required
Array of strings
Items Enum: "admin:write" "admin:read" "general:read" "general:write"

Responses

Request samples

Content type
application/json
{
  • "user_id": "12345678-1234-1234-1234-1234567890ab",
  • "roles": [
    ]
}

Response samples

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

PlatformManageRemoveTeamMember

Remove team member

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

The unique name for the team.

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

ID of the User

Responses

Request samples

Content type
application/json
{
  • "user_id": "12345678-1234-1234-1234-1234567890ab"
}

Response samples

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

plugins

PlatformListPlugins

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).

include_release_stages
Array of strings (PlatformPluginReleaseStage)
Items Enum: "coming-soon" "preview" "ga" "deprecated"

Include these release stages in the response

exclude_release_stages
Array of strings (PlatformPluginReleaseStage)
Default: "deprecated"
Items Enum: "coming-soon" "preview" "ga" "deprecated"

Exclude these release stages from the response

Responses

Response samples

Content type
application/json
{}

PlatformCreatePlugin

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

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

The unique name for the team.

kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

category
required
string (PlatformPluginCategory)
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" "finance" "customer-support" "other"

Supported categories for plugins

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

Supported price categories for billing

tier
string (PlatformPluginTier)
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 (PlatformPluginReleaseStageCreate)
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
string <url>

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

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
{}

PlatformGetPlugin

Get details about a given plugin.

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PlatformPluginName) <= 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",
  • "logo": "https://storage.googleapis.com/cq-cloud-images/9ac4cb31-e971-4879-8619-87dc22b0f98e",
  • "display_name": "AWS Source Plugin",
  • "official": true,
  • "release_stage": "coming-soon",
  • "repository": "https://github.com/cloudquery/cloudquery",
  • "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",
  • "pinned_version": {
    }
}

PlatformUpdatePlugin

Update a plugin

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

Request Body schema: application/json
category
string (PlatformPluginCategory)
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" "finance" "customer-support" "other"

Supported categories for plugins

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

Supported price categories for billing

tier
string (PlatformPluginTier)
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>

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

public
boolean

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

release_stage
string (PlatformPluginReleaseStageUpdate)
Enum: "coming-soon" "preview" "ga" "deprecated"

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
{}

PlatformDeletePluginByTeamAndPluginName

Delete plugin by team and plugin name

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PlatformPluginName) <= 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": {
    }
}

PlatformListPluginVersions

List all versions for a given plugin

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

plugin_name
required
string (PlatformPluginName) <= 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

version_filter
string (PlatformVersionFilter) ^[^~]?v[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z-]+(...

A version filter in semantic version format with prefix ranges.

Responses

Response samples

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

PlatformGetPluginVersion

Get details about a given plugin version.

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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",
  • "ui_base_url": "string"
}

PlatformCreatePluginVersion

Create a new plugin version, or update a draft version

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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 (PlatformPluginProtocols)
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 (PlatformPluginPackageType)
Enum: "native" "docker"

The package type of the plugin assets

spec_json_schema
string (PlatformPluginSpecJSONSchema)

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": [
    ]
}

PlatformUpdatePluginVersion

Update a given plugin version

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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 (PlatformPluginProtocols)
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 (PlatformPluginSpecJSONSchema)

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": [
    ]
}

PlatformListPluginVersionDocs

List all documentation pages for a given plugin version

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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": {
    }
}

PlatformCreatePluginVersionDocs

Create or update one or more plugin version docs pages

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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": [
    ]
}

PlatformReplacePluginVersionDocs

Replace (override) multiple plugin version docs pages

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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": [
    ]
}

PlatformDeletePluginVersionDocs

Delete one or more plugin version docs pages.

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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 (PlatformPluginDocsPageName) [^[\w,\s-]+$]

Responses

Request samples

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

Response samples

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

PlatformListPluginVersionTables

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

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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": {
    }
}

PlatformCreatePluginVersionTables

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:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 255 characters ^[a-z](-?[a-z0-9]+)+$
Example: cloudquery

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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": [
    ]
}

PlatformDeletePluginVersionTables

Delete one or more plugin version tables.

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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 (PlatformPluginTableName) [^[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": {
    }
}

PlatformGetPluginVersionTable

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

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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,
  • "permissions_needed": [
    ]
}

PlatformDownloadPluginAsset

Download an asset for a given plugin version and target

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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
{}

PlatformUploadPluginAsset

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

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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"
}

PlatformUploadPluginUIAssets

Get URLs to upload UI assets for a given plugin version

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

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

The version in semantic version format.

Request Body schema: application/json
ui_id
string <uuid>
required
Array of objects (CloudQuery Plugin UI Asset Upload Request)

Responses

Request samples

Content type
application/json
{
  • "ui_id": "afb63387-f196-483b-9a66-289f136bad88",
  • "assets": [
    ]
}

Response samples

Content type
application/json
{
  • "ui_id": "string",
  • "assets": [
    ]
}

PlatformFinalizePluginUIAssetUpload

Finalize UI asset upload

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

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

The version in semantic version format.

Request Body schema: application/json
ui_id
required
string

ID representing the finished upload

Responses

Request samples

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

Response samples

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

PlatformRemovePluginUIAssets

Remove UI assets for a given plugin version

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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
{
  • "message": "string",
  • "status": 0,
  • "errors": [
    ],
  • "field_errors": {
    }
}

PlatformListPluginsByTeam

List all plugins for the team.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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
{}

PlatformDownloadPluginAssetByTeam

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

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

The unique name for the team.

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

The unique name for the team.

plugin_kind
required
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: source

The kind of plugin, ie. source or destination.

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

The unique name for the plugin.

version_name
required
string (PlatformVersionName) ^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
{}

PlatformListPluginMirrors

List plugin mirror jobs

Authorizations:
bearerAuthcookieAuth
query Parameters
status
Array of strings (PlatformPluginMirrorRunStatus)
Items Enum: "completed" "failed" "started" "cancelled" "created"

Plugin mirror run status filters

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": {
    },
  • "mirroring_available": true
}

PlatformMirrorPlugins

Spawn a plugin mirroring job

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
required
required
Array of objects (PlatformPluginMirrorRunVersion)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed"
}

PlatformGetPluginMirror

Get a plugin mirror job

Authorizations:
bearerAuthcookieAuth
path Parameters
plugin_mirror_id
required
string <uuid> (PlatformPluginMirrorRunID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of mirror run

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "versions": [
    ]
}

PlatformUploadPlugins

Upload a plugin bundle

Authorizations:
bearerAuthcookieAuth
Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{}

images

PlatformUploadImage

Get a URL to upload image that will be publicly accessible

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
required
content_type
required
string (PlatformContentType)
Enum: "image/jpeg" "image/png" "image/webp"

The HTTP Content-Type of the image or asset

Responses

Request samples

Content type
application/json
{
  • "content_type": "image/png"
}

Response samples

Content type
application/json
{}

healthcheck

PlatformIndex

Index endpoint, returns 200

Responses

Response samples

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

PlatformHealthCheck

Health check endpoint, returns 200

Responses

Response samples

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

registry

PlatformAuthRegistryRequest

Performs authentication and authorization for our image registry.

Authorizations:
basicAuth
query Parameters
account
string

Username used for docker login

service
string

Service requesting the JWT token

scope
string

Multi-value string containing the repository being access and the operation type (push/pull)

header Parameters
X-Meta-Plugin-Version
string
Example: v1.0.0

Plugin version name

X-Meta-User-Team-Name
string

User's team name

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token": "string"
}

syncs

PlatformCreateSyncSourceTestConnection

Create a test source connection.

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

The unique name for the team.

Request Body schema: application/json
required
path
required
string (PlatformSyncPluginPath) ^cloudquery/[^/]+

Plugin path in CloudQuery registry

source_name
string

Name of an existing source

version
required
string

Version of the plugin

object <Plugin parameters, specific to each plugin>
Array of objects (PlatformSyncEnvCreate)

Environment variables for the plugin. All environment variables will be stored as secrets.

connector_id
string <uuid> (PlatformConnectorID)

ID of the connector that will be used to authenticate the destination.

Responses

Request samples

Content type
application/json
{
  • "path": "string",
  • "source_name": "string",
  • "version": "v1.2.3",
  • "spec": { },
  • "env": [
    ],
  • "connector_id": "12345678-1234-1234-1234-1234567890ab"
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string"
}

PlatformGetSyncSourceTestConnection

Get a sync source test connection.

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

The unique name for the team.

sync_source_test_connection_id
required
string <uuid> (PlatformSyncSourceTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Source Test Connection

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string"
}

PlatformUpdateSyncTestConnectionForSyncSource

Update a sync source test connection.

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

The unique name for the team.

sync_source_test_connection_id
required
string <uuid> (PlatformSyncSourceTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Source Test Connection

Request Body schema: application/json
status
required
string (PlatformSyncTestConnectionStatus)
Enum: "completed" "failed" "started" "created"

The status of the sync run

failure_reason
string

Reason for failure

failure_code
string

Code for failure

Responses

Request samples

Content type
application/json
{
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS"
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string"
}

PlatformGetSyncSourceTestConnectionLogs

Get logs for a sync source test connection.

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

The unique name for the team.

sync_source_test_connection_id
required
string <uuid> (PlatformSyncSourceTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Source Test Connection

header Parameters
Accept
string

Responses

Response samples

Content type
{}

PlatformPromoteSyncSourceTestConnection

Promote a sync source test connection to a sync source.

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

The unique name for the team.

sync_source_test_connection_id
required
string <uuid> (PlatformSyncSourceTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Source Test Connection

Request Body schema: application/json
required
name
required
string^[a-zA-Z0-9_-]+$

Descriptive, unique name for the source

display_name
string (PlatformDisplayName) [ 1 .. 255 ] characters ^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-'\(\...

A human-readable display name

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 tables that should be skipped. Wildcards are supported.

overwrite_source
boolean

Set this to allow overwriting an existing sync source. Defaults to true to preserve compatibility.

Responses

Request samples

Content type
application/json
{
  • "name": "my-source-definition",
  • "display_name": "Human Readable Name",
  • "tables": [
    ],
  • "skip_tables": [
    ],
  • "overwrite_source": true
}

Response samples

Content type
application/json
{
  • "name": "my-source-definition",
  • "display_name": "Human Readable Name",
  • "path": "string",
  • "version": "v1.2.3",
  • "tables": [
    ],
  • "skip_tables": [
    ],
  • "spec": { },
  • "env": [
    ],
  • "last_update_source": "yaml",
  • "connector_id": "12345678-1234-1234-1234-1234567890ab",
  • "created_at": "2023-07-14T16:53:42Z",
  • "updated_at": "2023-07-14T16:53:42Z",
  • "draft": true,
  • "previous_version": "v1.2.2"
}

PlatformCreateSyncDestinationTestConnection

Create a test destination connection.

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

The unique name for the team.

Request Body schema: application/json
required
path
required
string (PlatformSyncPluginPath) ^cloudquery/[^/]+

Plugin path in CloudQuery registry

destination_name
string

Name of an existing destination

version
required
string

Version of the plugin

write_mode
string (PlatformSyncDestinationWriteMode)
Enum: "append" "overwrite" "overwrite-delete-stale"

Write mode for the destination

migrate_mode
string (PlatformSyncDestinationMigrateMode)
Enum: "safe" "forced"

Migrate mode for the destination

object <Plugin parameters, specific to each plugin>
Array of objects (PlatformSyncEnvCreate)

Environment variables for the plugin. All environment variables will be stored as secrets.

connector_id
string <uuid> (PlatformConnectorID)

ID of the connector that will be used to authenticate the destination.

Responses

Request samples

Content type
application/json
{
  • "path": "string",
  • "destination_name": "string",
  • "version": "v1.2.3",
  • "write_mode": "append",
  • "migrate_mode": "safe",
  • "spec": { },
  • "env": [
    ],
  • "connector_id": "12345678-1234-1234-1234-1234567890ab"
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string"
}

PlatformGetSyncDestinationTestConnection

Get a sync destination test connection.

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

The unique name for the team.

sync_destination_test_connection_id
required
string <uuid> (PlatformSyncDestinationTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Destination Test Connection

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string"
}

PlatformUpdateSyncTestConnectionForSyncDestination

Update a sync destination test connection.

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

The unique name for the team.

sync_destination_test_connection_id
required
string <uuid> (PlatformSyncDestinationTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Destination Test Connection

Request Body schema: application/json
status
required
string (PlatformSyncTestConnectionStatus)
Enum: "completed" "failed" "started" "created"

The status of the sync run

failure_reason
string

Reason for failure

failure_code
string

Code for failure

Responses

Request samples

Content type
application/json
{
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS"
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string"
}

PlatformGetSyncDestinationTestConnectionLogs

Get logs for a sync destination test connection.

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

The unique name for the team.

sync_destination_test_connection_id
required
string <uuid> (PlatformSyncDestinationTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Destination Test Connection

header Parameters
Accept
string

Responses

Response samples

Content type
{}

PlatformPromoteSyncDestinationTestConnection

Promote a sync destination test connection to a sync destination.

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

The unique name for the team.

sync_destination_test_connection_id
required
string <uuid> (PlatformSyncDestinationTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Destination Test Connection

Request Body schema: application/json
required
name
required
string^[a-zA-Z0-9_-]+$

Descriptive, unique name for the destination

display_name
string (PlatformDisplayName) [ 1 .. 255 ] characters ^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-'\(\...

A human-readable display name

write_mode
string (PlatformSyncDestinationWriteMode)
Enum: "append" "overwrite" "overwrite-delete-stale"

Write mode for the destination

migrate_mode
string (PlatformSyncDestinationMigrateMode)
Enum: "safe" "forced"

Migrate mode for the destination

sync_group_id
string
send_sync_summary
boolean
overwrite_destination
boolean

Set this to allow overwriting an existing sync destination. Defaults to true to preserve compatibility.

Responses

Request samples

Content type
application/json
{
  • "name": "my-destination-definition",
  • "display_name": "Human Readable Name",
  • "write_mode": "append",
  • "migrate_mode": "safe",
  • "sync_group_id": "string",
  • "send_sync_summary": true,
  • "overwrite_destination": true
}

Response samples

Content type
application/json
{
  • "name": "my-destination-definition",
  • "display_name": "Human Readable Name",
  • "path": "string",
  • "version": "v1.2.3",
  • "write_mode": "append",
  • "migrate_mode": "safe",
  • "sync_group_id": "string",
  • "send_sync_summary": true,
  • "spec": { },
  • "env": [
    ],
  • "last_update_source": "yaml",
  • "connector_id": "12345678-1234-1234-1234-1234567890ab",
  • "transformers": [
    ],
  • "created_at": "2023-07-14T16:53:42Z",
  • "updated_at": "2023-07-14T16:53:42Z",
  • "draft": true,
  • "previous_version": "v1.2.2"
}

PlatformCreateSyncTransformerTestConnection

Create a test transformer connection.

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

The unique name for the team.

Request Body schema: application/json
required
path
required
string (PlatformSyncPluginPath) ^cloudquery/[^/]+

Plugin path in CloudQuery registry

transformer_name
string

Name of an existing transformer

version
required
string

Version of the plugin

object <Plugin parameters, specific to each plugin>
Array of objects (PlatformSyncEnvCreate)

Environment variables for the plugin. All environment variables will be stored as secrets.

connector_id
string <uuid> (PlatformConnectorID)

ID of the connector that will be used to authenticate the destination.

Responses

Request samples

Content type
application/json
{
  • "path": "string",
  • "transformer_name": "string",
  • "version": "v1.2.3",
  • "spec": { },
  • "env": [
    ],
  • "connector_id": "12345678-1234-1234-1234-1234567890ab"
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string"
}

PlatformGetSyncTransformerTestConnection

Get a sync transformer test connection.

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

The unique name for the team.

sync_transformer_test_connection_id
required
string <uuid> (PlatformSyncTransformerTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Transformer Test Connection

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string"
}

PlatformUpdateSyncTestConnectionForSyncTransformer

Update a sync transformer test connection.

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

The unique name for the team.

sync_transformer_test_connection_id
required
string <uuid> (PlatformSyncTransformerTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Transformer Test Connection

Request Body schema: application/json
status
required
string (PlatformSyncTestConnectionStatus)
Enum: "completed" "failed" "started" "created"

The status of the sync run

failure_reason
string

Reason for failure

failure_code
string

Code for failure

Responses

Request samples

Content type
application/json
{
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS"
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string"
}

PlatformGetSyncTransformerTestConnectionLogs

Get logs for a sync transformer test connection.

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

The unique name for the team.

sync_transformer_test_connection_id
required
string <uuid> (PlatformSyncTransformerTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Transformer Test Connection

header Parameters
Accept
string

Responses

Response samples

Content type
{}

PlatformPromoteSyncTransformerTestConnection

Promote a sync transformer test connection to a sync transformer.

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

The unique name for the team.

sync_transformer_test_connection_id
required
string <uuid> (PlatformSyncTransformerTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Sync Transformer Test Connection

Request Body schema: application/json
required
name
required
string^[a-zA-Z0-9_-]+$

Descriptive, unique name for the transformer

display_name
string (PlatformDisplayName) [ 1 .. 255 ] characters ^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-'\(\...

A human-readable display name

overwrite_transformer
boolean

Set this to allow overwriting an existing sync transformer. Defaults to true to preserve compatibility.

Responses

Request samples

Content type
application/json
{
  • "name": "my-transformer-definition",
  • "display_name": "Human Readable Name",
  • "overwrite_transformer": true
}

Response samples

Content type
application/json
{
  • "name": "my-transformer-definition",
  • "display_name": "Human Readable Name",
  • "path": "string",
  • "version": "v1.2.3",
  • "spec": { },
  • "env": [
    ],
  • "last_update_source": "yaml",
  • "connector_id": "12345678-1234-1234-1234-1234567890ab",
  • "created_at": "2023-07-14T16:53:42Z",
  • "updated_at": "2023-07-14T16:53:42Z",
  • "draft": true
}

PlatformListSyncUpgrades

List all version upgrades for syncs

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

sort_by
Array of strings
Items Enum: "kind" "path" "prev_version" "new_version" "created_at"

Sort by options

sort_dir
Array of strings (SyncSortDirection)
Items Enum: "asc" "desc"

Sync sort direction options

path
string (PlatformSyncPluginPath) ^cloudquery/[^/]+
Example: path=cloudquery/aws

Filter by plugin path

kind
string (PlatformPluginKind)
Enum: "source" "destination" "transformer"
Example: kind=source

Filter by plugin kind

platform_version
string
Example: platform_version=v1.1.0

Filter by platform version

Responses

Response samples

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

PlatformListSyncSources

List all sync source definitions.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

filter
string^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-']*$...

Filter by name or display name

sort_by
Array of strings (SyncGenericSortBy)
Items Enum: "name" "display_name" "path" "version" "created_at" "updated_at" "draft"

Sort by options

sort_dir
Array of strings (SyncSortDirection)
Items Enum: "asc" "desc"

Sync sort direction options

Responses

Response samples

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

PlatformGetSyncSource

Get a single sync source definition.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Responses

Response samples

Content type
application/json
{
  • "name": "my-source-definition",
  • "display_name": "Human Readable Name",
  • "path": "string",
  • "version": "v1.2.3",
  • "tables": [
    ],
  • "skip_tables": [
    ],
  • "spec": { },
  • "env": [
    ],
  • "last_update_source": "yaml",
  • "connector_id": "12345678-1234-1234-1234-1234567890ab",
  • "created_at": "2023-07-14T16:53:42Z",
  • "updated_at": "2023-07-14T16:53:42Z",
  • "draft": true,
  • "previous_version": "v1.2.2"
}

PlatformUpdateSyncSource

Update a Sync Source definition.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Request Body schema: application/json
required
display_name
string (PlatformDisplayName) [ 1 .. 255 ] characters ^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-'\(\...

A human-readable display name

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 tables that should be skipped. Wildcards are supported.

last_update_source
string (PlatformSyncLastUpdateSource)
Enum: "yaml" "ui"

How was the source or destination been created or updated last

Responses

Request samples

Content type
application/json
{
  • "display_name": "Human Readable Name",
  • "tables": [
    ],
  • "skip_tables": [
    ],
  • "last_update_source": "yaml"
}

Response samples

Content type
application/json
{
  • "name": "my-source-definition",
  • "display_name": "Human Readable Name",
  • "path": "string",
  • "version": "v1.2.3",
  • "tables": [
    ],
  • "skip_tables": [
    ],
  • "spec": { },
  • "env": [
    ],
  • "last_update_source": "yaml",
  • "connector_id": "12345678-1234-1234-1234-1234567890ab",
  • "created_at": "2023-07-14T16:53:42Z",
  • "updated_at": "2023-07-14T16:53:42Z",
  • "draft": true,
  • "previous_version": "v1.2.2"
}

PlatformDeleteSyncSource

Delete a Sync Source definition. Any syncs relying on this source must be deleted first.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Responses

Response samples

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

PlatformMigrateSyncSource

Run migrations on all syncs which use this Sync Source.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Responses

Response samples

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

PlatformGetTestConnectionForSyncSource

Get test connection details for sync source.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

sync_test_connection_id
required
string <uuid> (PlatformSyncTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

unique ID of the test connection

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string",
  • "plugin_kind": "source"
}

PlatformListSyncSourceSyncs

List all Syncs for a given sync source.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

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

sort_by
Array of strings (SyncSortBy)
Items Enum: "cpu" "created_at" "created_by" "destinations" "disabled" "display_name" "memory" "name" "schedule" "source" "updated_at" "last_run_created_at" "last_run_updated_at" "last_run_completed_at" "last_run_errors" "last_run_warnings" "last_run_total_rows" "last_run_status" "last_run_migration"

Sort by options

sort_dir
Array of strings (SyncSortDirection)
Items Enum: "asc" "desc"

Sync sort direction options

filter
string^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-']*$...

Filter by name or display name

Responses

Response samples

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

PlatformListSyncDestinations

List all sync destination definitions.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

filter
string^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-']*$...

Filter by name or display name

sort_by
Array of strings (SyncGenericSortBy)
Items Enum: "name" "display_name" "path" "version" "created_at" "updated_at" "draft"

Sort by options

sort_dir
Array of strings (SyncSortDirection)
Items Enum: "asc" "desc"

Sync sort direction options

Responses

Response samples

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

PlatformGetSyncDestination

Get a single sync destination definition.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Responses

Response samples

Content type
application/json
{
  • "name": "my-destination-definition",
  • "display_name": "Human Readable Name",
  • "path": "string",
  • "version": "v1.2.3",
  • "write_mode": "append",
  • "migrate_mode": "safe",
  • "sync_group_id": "string",
  • "send_sync_summary": true,
  • "spec": { },
  • "env": [
    ],
  • "last_update_source": "yaml",
  • "connector_id": "12345678-1234-1234-1234-1234567890ab",
  • "transformers": [
    ],
  • "created_at": "2023-07-14T16:53:42Z",
  • "updated_at": "2023-07-14T16:53:42Z",
  • "draft": true,
  • "previous_version": "v1.2.2"
}

PlatformUpdateSyncDestination

Update a Sync Destination definition.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Request Body schema: application/json
required
display_name
string (PlatformDisplayName) [ 1 .. 255 ] characters ^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-'\(\...

A human-readable display name

write_mode
string (PlatformSyncDestinationWriteModeUpdate)
Enum: "append" "overwrite" "overwrite-delete-stale"

Write mode for the destination, for updating

migrate_mode
string (PlatformSyncDestinationMigrateModeUpdate)
Enum: "safe" "forced"

Migrate mode for the destination, for updating

sync_group_id
string
send_sync_summary
boolean
last_update_source
string (PlatformSyncLastUpdateSource)
Enum: "yaml" "ui"

How was the source or destination been created or updated last

transformers
Array of strings[^[a-zA-Z0-9_-]+$]

Responses

Request samples

Content type
application/json
{
  • "display_name": "Human Readable Name",
  • "write_mode": "append",
  • "migrate_mode": "safe",
  • "sync_group_id": "string",
  • "send_sync_summary": true,
  • "last_update_source": "yaml",
  • "transformers": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "my-destination-definition",
  • "display_name": "Human Readable Name",
  • "path": "string",
  • "version": "v1.2.3",
  • "write_mode": "append",
  • "migrate_mode": "safe",
  • "sync_group_id": "string",
  • "send_sync_summary": true,
  • "spec": { },
  • "env": [
    ],
  • "last_update_source": "yaml",
  • "connector_id": "12345678-1234-1234-1234-1234567890ab",
  • "transformers": [
    ],
  • "created_at": "2023-07-14T16:53:42Z",
  • "updated_at": "2023-07-14T16:53:42Z",
  • "draft": true,
  • "previous_version": "v1.2.2"
}

PlatformDeleteSyncDestination

Delete a Sync Destination definition. Any syncs relying on this destination must be deleted first.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Responses

Response samples

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

PlatformMigrateSyncDestination

Run migrations on all syncs which use this Sync Destination.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Responses

Response samples

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

PlatformGetTestConnectionForSyncDestination

Get test connection details for sync destination.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

sync_test_connection_id
required
string <uuid> (PlatformSyncTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

unique ID of the test connection

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string",
  • "plugin_kind": "source"
}

PlatformListSyncDestinationSyncs

List all Syncs for a given sync destination.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

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

sort_by
Array of strings (SyncSortBy)
Items Enum: "cpu" "created_at" "created_by" "destinations" "disabled" "display_name" "memory" "name" "schedule" "source" "updated_at" "last_run_created_at" "last_run_updated_at" "last_run_completed_at" "last_run_errors" "last_run_warnings" "last_run_total_rows" "last_run_status" "last_run_migration"

Sort by options

sort_dir
Array of strings (SyncSortDirection)
Items Enum: "asc" "desc"

Sync sort direction options

filter
string^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-']*$...

Filter by name or display name

Responses

Response samples

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

PlatformListSyncTransformers

List all sync transformer definitions.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

filter
string^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-']*$...

Filter by name or display name

sort_by
Array of strings (SyncGenericSortBy)
Items Enum: "name" "display_name" "path" "version" "created_at" "updated_at" "draft"

Sort by options

sort_dir
Array of strings (SyncSortDirection)
Items Enum: "asc" "desc"

Sync sort direction options

Responses

Response samples

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

PlatformGetSyncTransformer

Get a single sync transformer definition.

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

The unique name for the team.

sync_transformer_name
required
string^[a-zA-Z0-9_-]+$

Unique name of the sync transformer

Responses

Response samples

Content type
application/json
{
  • "name": "my-transformer-definition",
  • "display_name": "Human Readable Name",
  • "path": "string",
  • "version": "v1.2.3",
  • "spec": { },
  • "env": [
    ],
  • "last_update_source": "yaml",
  • "connector_id": "12345678-1234-1234-1234-1234567890ab",
  • "created_at": "2023-07-14T16:53:42Z",
  • "updated_at": "2023-07-14T16:53:42Z",
  • "draft": true
}

PlatformUpdateSyncTransformer

Update a Sync Transformer definition.

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

The unique name for the team.

sync_transformer_name
required
string^[a-zA-Z0-9_-]+$

Unique name of the sync transformer

Request Body schema: application/json
required
display_name
string (PlatformDisplayName) [ 1 .. 255 ] characters ^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-'\(\...

A human-readable display name

last_update_source
string (PlatformSyncLastUpdateSource)
Enum: "yaml" "ui"

How was the source or destination been created or updated last

Responses

Request samples

Content type
application/json
{
  • "display_name": "Human Readable Name",
  • "last_update_source": "yaml"
}

Response samples

Content type
application/json
{
  • "name": "my-transformer-definition",
  • "display_name": "Human Readable Name",
  • "path": "string",
  • "version": "v1.2.3",
  • "spec": { },
  • "env": [
    ],
  • "last_update_source": "yaml",
  • "connector_id": "12345678-1234-1234-1234-1234567890ab",
  • "created_at": "2023-07-14T16:53:42Z",
  • "updated_at": "2023-07-14T16:53:42Z",
  • "draft": true
}

PlatformDeleteSyncTransformer

Delete a Sync Transformer definition. Any syncs relying on this transformer must be deleted first.

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

The unique name for the team.

sync_transformer_name
required
string^[a-zA-Z0-9_-]+$

Unique name of the sync transformer

Responses

Response samples

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

PlatformGetTestConnectionForSyncTransformer

Get test connection details for sync transformer.

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

The unique name for the team.

sync_transformer_name
required
string^[a-zA-Z0-9_-]+$

Unique name of the sync transformer

sync_test_connection_id
required
string <uuid> (PlatformSyncTestConnectionID)
Example: 12345678-1234-1234-1234-1234567890ab

unique ID of the test connection

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "failure_reason": "password authentication failed for user \"exampleuser\"",
  • "failure_code": "INVALID_CREDENTIALS",
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "plugin_path": "string",
  • "plugin_version": "string",
  • "plugin_kind": "source"
}

PlatformListSyncTransformerSyncs

List all Syncs for a given sync transformer.

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

The unique name for the team.

sync_transformer_name
required
string^[a-zA-Z0-9_-]+$

Unique name of the sync transformer

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": {
    }
}

PlatformListSyncTransformerSyncDestinations

List all Sync Destinations for a given sync transformer.

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

The unique name for the team.

sync_transformer_name
required
string^[a-zA-Z0-9_-]+$

Unique name of the sync transformer

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": {
    }
}

PlatformListSyncs

List all Syncs.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

sort_by
Array of strings (SyncSortBy)
Items Enum: "cpu" "created_at" "created_by" "destinations" "disabled" "display_name" "memory" "name" "schedule" "source" "updated_at" "last_run_created_at" "last_run_updated_at" "last_run_completed_at" "last_run_errors" "last_run_warnings" "last_run_total_rows" "last_run_status" "last_run_migration"

Sort by options

sort_dir
Array of strings (SyncSortDirection)
Items Enum: "asc" "desc"

Sync sort direction options

filter
string^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-']*$...

Filter by name or display name

Responses

Response samples

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

PlatformCreateSync

Create new Sync definition. Sync runs can be scheduled automatically, or triggered manually after sync is created.

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

The unique name for the team.

Request Body schema: application/json
required
name
required
string^[a-zA-Z0-9_-]+$

Descriptive, unique name for the sync

display_name
string (PlatformDisplayName) [ 1 .. 255 ] characters ^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-'\(\...

A human-readable display name

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

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "display_name": "Human Readable Name",
  • "source": "string",
  • "destinations": [
    ],
  • "schedule": "string",
  • "disabled": false,
  • "cpu": "1",
  • "memory": "2Gi"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "display_name": "Human Readable Name",
  • "source": "string",
  • "destinations": [
    ],
  • "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"
}

PlatformGetSync

Get a Sync

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "display_name": "Human Readable Name",
  • "source": "string",
  • "destinations": [
    ],
  • "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"
}

PlatformUpdateSync

Update a Sync

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Request Body schema: application/json
display_name
string (PlatformDisplayName) [ 1 .. 255 ] characters ^[a-zA-Z\p{L}\p{N}_][a-zA-Z\p{L}\p{N}_ \-'\(\...

A human-readable display name

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 (PlatformSyncEnv)

Environment variables for the sync

cpu
string
Default: "1"

CPU quota for the sync

memory
string
Default: "2Gi"

Memory quota for the sync

Responses

Request samples

Content type
application/json
{
  • "display_name": "Human Readable Name",
  • "source": "string",
  • "destinations": [
    ],
  • "schedule": "string",
  • "disabled": false,
  • "env": [
    ],
  • "cpu": "1",
  • "memory": "2Gi"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "display_name": "Human Readable Name",
  • "source": "string",
  • "destinations": [
    ],
  • "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"
}

PlatformDeleteSync

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.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Responses

Response samples

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

PlatformListSyncRuns

List all Sync Runs.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

query Parameters
migration_filter
boolean

Filter by migration

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": {
    }
}

PlatformCreateSyncRun

Create new SyncRun. This will trigger a manual job run.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

Responses

Response samples

Content type
application/json
{
  • "sync_name": "string",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "status_reason": "error",
  • "workers": [
    ],
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "total_rows": 0,
  • "warnings": 0,
  • "errors": 0,
  • "migration": true
}

PlatformGetSyncRun

Get a Sync Run.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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> (PlatformSyncRunID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the SyncRun

Responses

Response samples

Content type
application/json
{
  • "sync_name": "string",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "status_reason": "error",
  • "workers": [
    ],
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "total_rows": 0,
  • "warnings": 0,
  • "errors": 0,
  • "migration": true,
  • "cpu_seconds": 0.1,
  • "memory_byte_seconds": 0.1,
  • "network_egress_bytes": 0.1
}

PlatformUpdateSyncRun

Update a SyncRun

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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> (PlatformSyncRunID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the SyncRun

Request Body schema: application/json
status
string (PlatformSyncRunStatus)
Enum: "completed" "failed" "started" "cancelled" "created" "pending"

The status of the sync run

status_reason
string (PlatformSyncRunStatusReason)
Enum: "error" "oom_killed" "partial_success"

The reason for the status

Responses

Request samples

Content type
application/json
{
  • "status": "completed",
  • "status_reason": "error"
}

Response samples

Content type
application/json
{
  • "sync_name": "string",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "status": "completed",
  • "status_reason": "error",
  • "workers": [
    ],
  • "created_at": "2017-07-14T16:53:42Z",
  • "completed_at": "2017-07-14T16:53:42Z",
  • "total_rows": 0,
  • "warnings": 0,
  • "errors": 0,
  • "migration": true
}

PlatformGetSyncRunLogs

Get logs for a sync run.

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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> (PlatformSyncRunID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the SyncRun

query Parameters
table
string

Table name to filter logs by. Use a single dash ("-") as input to exclude all table-specific log lines.

header Parameters
Accept
string

Responses

Response samples

Content type
{}

PlatformListConnectors

List all configured connectors

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

filter_type
string

Filter connectors by a given type.

filter_plugin
string
Example: filter_plugin=cloudquery/source/googleanalytics

Filter connectors by a given plugin reference. Mutually exclusive with type.

Responses

Response samples

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

PlatformCreateConnector

Create new connector

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

The unique name for the team.

Request Body schema: application/json
required
type
required
string

Type of the connector

name
required
string

Name of the connector

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "type": "string",
  • "name": "string",
  • "status": "created",
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformGetConnector

Get a configured connector

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

The unique name for the team.

connector_id
required
string <uuid> (PlatformConnectorID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Connector

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "type": "string",
  • "name": "string",
  • "status": "created",
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformUpdateConnector

Update a connector

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

The unique name for the team.

connector_id
required
string <uuid> (PlatformConnectorID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Connector

Request Body schema: application/json
name
string

Name of the connector

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "type": "string",
  • "name": "string",
  • "status": "created",
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformRevokeConnector

Revoke authentication for a given connector. Any syncs relying on this connector will stop running until the connector is reauthenticated or sync references are updated.

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

The unique name for the team.

connector_id
required
string <uuid> (PlatformConnectorID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Connector

Responses

Response samples

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

PlatformGetConnectorAuthStatusAWS

Get authentication status for the given AWS connector

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

The unique name for the team.

connector_id
required
string <uuid> (PlatformConnectorID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Connector

Responses

Response samples

Content type
application/json
{
  • "role_arn": "string",
  • "external_id": "string"
}

PlatformAuthenticateConnectorAWS

Authenticate or reauthenticate the given AWS connector

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

The unique name for the team.

connector_id
required
string <uuid> (PlatformConnectorID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Connector

Request Body schema: application/json
required
plugin_team
required
string

Team that owns the plugin we are authenticating the connector for

plugin_kind
required
string

Kind of the plugin

plugin_name
required
string

Name of the plugin

plugin_version
string

Version of the plugin

object <Plugin parameters, specific to each plugin>
Array of objects (PlatformSyncEnvCreate)

Environment variables used in the spec.

tables
Array of strings

Tables to authenticate, setting from the outer spec

skip_tables
Array of strings

Tables to skip authentication, setting from the outer spec

skip_dependent_tables
boolean

Whether to skip dependent tables, setting from the outer spec

Responses

Request samples

Content type
application/json
{
  • "plugin_team": "cloudquery",
  • "plugin_kind": "source",
  • "plugin_name": "aws",
  • "plugin_version": "v27.1.0",
  • "spec": { },
  • "env": [
    ],
  • "tables": [
    ],
  • "skip_tables": [
    ],
  • "skip_dependent_tables": true
}

Response samples

Content type
application/json
{
  • "redirect_url": "string",
  • "role_template_url": "string",
  • "suggested_external_id": "string",
  • "suggested_policy_arns": [
    ]
}

PlatformAuthenticateConnectorFinishAWS

Complete authentication for the given AWS connector

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

The unique name for the team.

connector_id
required
string <uuid> (PlatformConnectorID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Connector

Request Body schema: application/json
required
role_arn
required
string

ARN of role created by the user

external_id
string

External ID in the role definition. Optional. If not provided the previously suggested external ID will be used. Empty string will remove the external ID.

Responses

Request samples

Content type
application/json
{
  • "role_arn": "string",
  • "external_id": "string"
}

Response samples

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

PlatformGetConnectorAuthStatusGCP

Get authentication status for the given GCP connector

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

The unique name for the team.

connector_id
required
string <uuid> (PlatformConnectorID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Connector

Responses

Response samples

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

PlatformAuthenticateConnectorGCP

Authenticate or reauthenticate the given GCP connector

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

The unique name for the team.

connector_id
required
string <uuid> (PlatformConnectorID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Connector

Request Body schema: application/json
required
plugin_team
required
string

Team that owns the plugin we are authenticating the connector for

plugin_kind
required
string

Kind of the plugin

plugin_name
required
string

Name of the plugin

Responses

Request samples

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

Response samples

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

PlatformAuthenticateConnectorFinishGCP

Complete authentication for the given GCP connector

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

The unique name for the team.

connector_id
required
string <uuid> (PlatformConnectorID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Connector

Responses

Response samples

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

PlatformAuthenticateConnectorOAuth

Authenticate or reauthenticate the given OAuth connector

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

The unique name for the team.

connector_id
required
string <uuid> (PlatformConnectorID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Connector

Request Body schema: application/json
required
plugin_team
required
string

Team that owns the plugin we are authenticating the connector for

plugin_kind
required
string

Kind of the plugin

plugin_name
required
string

Name of the plugin

plugin_version
string

Version of the plugin

base_url
required
string

Base of the URL the callback url will be constructed from

object <Plugin parameters, specific to each plugin>
Array of objects (PlatformSyncEnvCreate)

Environment variables used in the spec.

tables
Array of strings

Tables to authenticate, setting from the outer spec

skip_tables
Array of strings

Tables to skip authentication, setting from the outer spec

skip_dependent_tables
boolean

Whether to skip dependent tables, setting from the outer spec

flavor
string

Override default flavor

Responses

Request samples

Content type
application/json
{
  • "plugin_team": "cloudquery",
  • "plugin_kind": "source",
  • "plugin_name": "googleanalytics",
  • "plugin_version": "v3.0.0",
  • "base_url": "https://cloud.cloudquery.io/oauth",
  • "spec": { },
  • "env": [
    ],
  • "tables": [
    ],
  • "skip_tables": [
    ],
  • "skip_dependent_tables": true,
  • "flavor": "string"
}

Response samples

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

PlatformAuthenticateConnectorFinishOAuth

Complete authentication for the given OAuth connector

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

The unique name for the team.

connector_id
required
string <uuid> (PlatformConnectorID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the Connector

Request Body schema: application/json
required
return_url
required
string

URL the user was redirected to (including new parameter values) after the OAuth flow is complete

base_url
required
string

Base of the URL the callback url was constructed from

object <Plugin parameters, specific to each plugin>
Array of objects (PlatformSyncEnvCreate)

Environment variables used in the spec.

Responses

Request samples

Content type
application/json
{}

Response samples

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

PlatformGetSyncRunStats

Get statistics on a Sync Run

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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> (PlatformSyncRunID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the SyncRun

Responses

Response samples

Content type
application/json
{
  • "completed_tables": 0,
  • "started_at": "2017-07-14T16:53:42Z",
  • "last_completed_at": "2017-07-14T16:53:42Z",
  • "resources": 0,
  • "errors": 0,
  • "panics": 0
}

PlatformGetSyncRunTables

Get table details on a Sync Run

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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> (PlatformSyncRunID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the SyncRun

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

sort_by
Array of strings (TableSortBy)

Table sort by options. This sorts the rows that are returned in the result set.

sort_dir
Array of strings (TableSortDirection)
Items Enum: "asc" "desc"

Table sort direction options. This sorts the rows that are returned in the result set.

Responses

Response samples

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

admin

PlatformManageGetPlatformRegistry

Get platform registry information

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "installation_id": "string",
  • "activation_id": "0ce2fdf3-fac1-4457-a525-d0c69229a8dd",
  • "team_name": "string",
  • "api_key_last_four": "string",
  • "last_activated_at": "2019-08-24T14:15:22Z",
  • "next_activation_at": "2019-08-24T14:15:22Z",
  • "offline_license_registered_to": "string",
  • "offline_license_expires_at": "2019-08-24T14:15:22Z"
}

PlatformManageRegisterPlatform

Register platform usage by API key

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
required
api_key
required
string >= 32 characters

Team API key to activate platform with

Responses

Request samples

Content type
application/json
{
  • "api_key": "stringstringstringstringstringst"
}

Response samples

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

PlatformManageRegisterPlatformWithOfflineLicense

Register platform usage by offline license

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
required
license
required
string <byte>

Offline license

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "registered_to": "string",
  • "expires_at": "2019-08-24T14:15:22Z"
}

PlatformManageGetSAML

Get SAML integration information

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "platform_base_url": "string",
  • "platform_sso_url": "string",
  • "platform_entity_id": "string",
  • "platform_metadata_download_url": "string",
  • "platform_certificate_download_url": "string",
  • "metadata_url": "string",
  • "metadata_xml": "string",
  • "logout_url": "string",
  • "role_group_key": "groups",
  • "role_group_value_admins": "string",
  • "role_mappings": {
    },
  • "default_roles": [
    ],
  • "disable_access_if_no_role_group": true,
  • "enabled": true,
  • "can_enable": true
}

PlatformManageUpdateSAML

Update SAML integration information

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
required
platform_base_url
string <url>

Base URL to the platform. This should be set first. https recommended.

metadata_url
string <url>

Metadata URL from identity provider. Mutually exclusive with metadata_xml

metadata_xml
string <url>

Metadata file contents from identity provider. Mutually exclusive with metadata_url

logout_url
string <url>

Logout URL from identity provider

role_group_key
string

Role group key name

role_group_value_admins
string
Deprecated

Role group value for admin users

object

Mapping from IdP group names to roles. Each key is a potential IdP group value for the specified role_group_key, and each value is an array of roles to assign to users in that group.

default_roles
Array of strings (PlatformRole)
Items Enum: "admin:write" "admin:read" "general:read" "general:write"

Default roles for new users who are not in any group

disable_access_if_no_role_group
boolean

Whether to disable access if no role group is found in the SAML assertion. If true, users without a role group will not be able to log in.

enabled
boolean

Whether to enable or disable SAML

Responses

Request samples

Content type
application/json
{
  • "platform_base_url": "string",
  • "metadata_url": "string",
  • "metadata_xml": "string",
  • "logout_url": "string",
  • "role_group_key": "string",
  • "role_group_value_admins": "string",
  • "role_mappings": {
    },
  • "default_roles": [
    ],
  • "disable_access_if_no_role_group": true,
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "platform_base_url": "string",
  • "platform_sso_url": "string",
  • "platform_entity_id": "string",
  • "platform_metadata_download_url": "string",
  • "platform_certificate_download_url": "string",
  • "metadata_url": "string",
  • "metadata_xml": "string",
  • "logout_url": "string",
  • "role_group_key": "groups",
  • "role_group_value_admins": "string",
  • "role_mappings": {
    },
  • "default_roles": [
    ],
  • "disable_access_if_no_role_group": true,
  • "enabled": true,
  • "can_enable": true
}

PlatformManageListAllTeams

List all teams

Authorizations:
bearerAuthcookieAuth
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": {
    }
}

PlatformManageGetTeam

Get a team

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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",
  • "internal": false
}

PlatformManageDeleteTeam

Delete a team

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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,
  • "errors": [
    ],
  • "field_errors": {
    }
}

PlatformManageListTeamMembers

List team members

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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": {
    }
}

PlatformManageAddTeamMember

Add team member

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

The unique name for the team.

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

ID of the User

roles
required
Array of strings
Items Enum: "admin:write" "admin:read" "general:read" "general:write"

Responses

Request samples

Content type
application/json
{
  • "user_id": "12345678-1234-1234-1234-1234567890ab",
  • "roles": [
    ]
}

Response samples

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

PlatformManageRemoveTeamMember

Remove team member

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

The unique name for the team.

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

ID of the User

Responses

Request samples

Content type
application/json
{
  • "user_id": "12345678-1234-1234-1234-1234567890ab"
}

Response samples

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

PlatformListLocalUsers

List all users

Authorizations:
bearerAuthcookieAuth
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": {
    }
}

PlatformAddLocalUser

Add new user

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
email
required
string
name
required
string
is_admin
boolean
Deprecated

DEPRECATED. Use roles instead

password
string
roles
required
Array of strings >= 0 items
Items Enum: "admin:write" "admin:read"

Global roles for the user

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "is_admin": true,
  • "password": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "email": "[email protected]",
  • "name": "Sarah O'Connor",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "profile_image_url": "string",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "is_admin": true,
  • "roles": [
    ],
  • "enabled": true,
  • "provider": "local",
  • "tracking_opted_in": true
}

PlatformGetLocalUser

Get user details

Authorizations:
bearerAuthcookieAuth
path Parameters
user_id
required
string <uuid> (PlatformUserID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the User

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "email": "[email protected]",
  • "name": "Sarah O'Connor",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "profile_image_url": "string",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "is_admin": true,
  • "roles": [
    ],
  • "enabled": true,
  • "provider": "local",
  • "tracking_opted_in": true,
  • "teams": [
    ]
}

PlatformUpdateLocalUser

Update user

Authorizations:
bearerAuthcookieAuth
path Parameters
user_id
required
string <uuid> (PlatformUserID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the User

Request Body schema: application/json
email
string
name
string
password
string
enabled
boolean
is_admin
boolean
Deprecated

DEPRECATED. Use roles instead

roles
Array of strings
Items Enum: "admin:write" "admin:read"

Global roles for the user

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "password": "string",
  • "enabled": true,
  • "is_admin": true,
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "2017-07-14T16:53:42Z",
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "email": "[email protected]",
  • "name": "Sarah O'Connor",
  • "updated_at": "2017-07-14T16:53:42Z",
  • "profile_image_url": "string",
  • "last_login_at": "2019-08-24T14:15:22Z",
  • "is_admin": true,
  • "roles": [
    ],
  • "enabled": true,
  • "provider": "local",
  • "tracking_opted_in": true
}

PlatformDeleteLocalUser

Delete user

Authorizations:
bearerAuthcookieAuth
path Parameters
user_id
required
string <uuid> (PlatformUserID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the User

Responses

Response samples

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

PlatformCreateLocalUserResetToken

Create password reset token for user

Authorizations:
bearerAuthcookieAuth
path Parameters
user_id
required
string <uuid> (PlatformUserID)
Example: 12345678-1234-1234-1234-1234567890ab

ID of the User

Responses

Response samples

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

PlatformUploadPlugins

Upload a plugin bundle

Authorizations:
bearerAuthcookieAuth
Request Body schema:
required
string <binary>

Responses

Response samples

Content type
application/json
{}

PlatformAssetViewGetStatus

Get assetview status

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "is_running": true
}

PlatformAssetViewTrigger

Trigger assetview run

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

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

PlatformAssetViewListLogs

List asset view logs

Authorizations:
bearerAuthcookieAuth
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

type
Array of strings (PlatformAssetViewRunType)
Items Enum: "client_table" "s3_source"

AssetView run type filters

Responses

Response samples

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

queries

PlatformListAllQueries

List all queries

Authorizations:
bearerAuthcookieAuth
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

tag
Array of strings (PlatformQueryTag)

Query tags

name_filter
string

Filter by query name.

query_filter
string

Filter by query

Responses

Response samples

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

PlatformExecuteAdHocQuery

Run an ad-hoc SQL query against any table. Further filtering can optionally be applied on top of the raw SQL results using the optional parameters. Filtering can be useful in situations where a saved query needs to be further filtered, grouped or paginated, such as in dashboards or reports.

Authorizations:
bearerAuthcookieAuth
query Parameters
select
Array of strings (TableSelect)

Table selects. This filters the columns that are returned in the result set.

filter_mode
string
Default: "smart"
Enum: "smart" "search" "column"

Table filter mode.

Smart mode switches between column and search mode based on the filtered table and

Search mode allows searching deeply nested data but is not available on all tables as it requires a separate indexing step. Search mode is only available on resource tables or queries derived from resource tables results that contain _cq_id and _cq_source_id. Search mode may also be used against cloud_assets but it will only return results from resource tables.

Column mode searches purely using the columns in the table. It will work on all table results but it is not optimized for arbitrary substring searches and so may be slow on larger tables.

filter
Array of strings (PlatformFilterExpression)
Example: filter=resource_type=aws_s3_buckets

Table filters. This filters the rows that are returned in the result set.

filter_id
Array of strings <uuid> (PlatformFilterID) [ items <uuid > ]

Table filter IDs. These should be valid Saved Filter IDs. These filters will be applied to the query results before returning them.

sort_by
Array of strings (TableSortBy)

Table sort by options. This sorts the rows that are returned in the result set.

sort_dir
Array of strings (TableSortDirection)
Items Enum: "asc" "desc"

Table sort direction options. This sorts the rows that are returned in the result set.

group_by
Array of strings (TableGroupBy)

Table group by options. This groups the rows that are returned in the result set by the given columns.

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

Request Body schema: application/json
required
query
required
string

Responses

Request samples

Content type
application/json
{
  • "query": "SELECT account_id, instance_id, instance_type, region, name, tags FROM aws_ec2_instance WHERE instance_type = 't2.micro'"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "metadata": {
    }
}

PlatformSaveQuery

Save a query to execute later

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
required
name
required
string
query
required
string
public
boolean
Default: true
tags
Array of strings (PlatformQueryTag)
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "Find all t2.micro EC2 instances",
  • "query": "SELECT account_id, instance_id, instance_type, region, name, tags FROM aws_ec2_instance WHERE instance_type = 't2.micro'",
  • "public": true,
  • "tags": [
    ],
  • "description": "Query to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Find all t2.micro EC2 instances",
  • "query": "SELECT account_id, instance_id, instance_type, region, name, tags FROM aws_ec2_instance WHERE instance_type = 't2.micro'",
  • "description": "Query to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table",
  • "user_id": "12345678-1234-1234-1234-1234567890ab",
  • "tags": [
    ],
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformListQueryTags

List Query Tags

Authorizations:
bearerAuthcookieAuth
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": {
    }
}

PlatformGetSavedQuery

Get a saved query

Authorizations:
bearerAuthcookieAuth
path Parameters
query_id
required
string <uuid> (PlatformQueryID)

The unique ID for the query.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Find all t2.micro EC2 instances",
  • "query": "SELECT account_id, instance_id, instance_type, region, name, tags FROM aws_ec2_instance WHERE instance_type = 't2.micro'",
  • "description": "Query to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table",
  • "user_id": "12345678-1234-1234-1234-1234567890ab",
  • "tags": [
    ],
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformUpdateQuery

Update a saved query

Authorizations:
bearerAuthcookieAuth
path Parameters
query_id
required
string <uuid> (PlatformQueryID)

The unique ID for the query.

Request Body schema: application/json
name
string
query
string
public
boolean
tags
Array of strings (PlatformQueryTag)
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "Find all t2.micro EC2 instances",
  • "query": "SELECT account_id, instance_id, instance_type, region, name, tags FROM aws_ec2_instances WHERE instance_type = 't2.micro'",
  • "public": true,
  • "tags": [
    ],
  • "description": "Query to find all EC2 instances of type t2.micro from the aws_ec2_instances raw table"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Find all t2.micro EC2 instances",
  • "query": "SELECT account_id, instance_id, instance_type, region, name, tags FROM aws_ec2_instance WHERE instance_type = 't2.micro'",
  • "description": "Query to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table",
  • "user_id": "12345678-1234-1234-1234-1234567890ab",
  • "tags": [
    ],
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformDeleteSavedQuery

Delete a saved query

Authorizations:
bearerAuthcookieAuth
path Parameters
query_id
required
string <uuid> (PlatformQueryID)

The unique ID for the query.

Responses

Response samples

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

PlatformExecuteSavedQuery

Execute a saved query

Authorizations:
bearerAuthcookieAuth
path Parameters
query_id
required
string <uuid> (PlatformQueryID)

The unique ID for the query.

query Parameters
select
Array of strings (TableSelect)

Table selects. This filters the columns that are returned in the result set.

filter_mode
string
Default: "smart"
Enum: "smart" "search" "column"

Table filter mode.

Smart mode switches between column and search mode based on the filtered table and

Search mode allows searching deeply nested data but is not available on all tables as it requires a separate indexing step. Search mode is only available on resource tables or queries derived from resource tables results that contain _cq_id and _cq_source_id. Search mode may also be used against cloud_assets but it will only return results from resource tables.

Column mode searches purely using the columns in the table. It will work on all table results but it is not optimized for arbitrary substring searches and so may be slow on larger tables.

filter
Array of strings (PlatformFilterExpression)
Example: filter=resource_type=aws_s3_buckets

Table filters. This filters the rows that are returned in the result set.

filter_id
Array of strings <uuid> (PlatformFilterID) [ items <uuid > ]

Table filter IDs. These should be valid Saved Filter IDs. These filters will be applied to the query results before returning them.

sort_by
Array of strings (TableSortBy)

Table sort by options. This sorts the rows that are returned in the result set.

sort_dir
Array of strings (TableSortDirection)
Items Enum: "asc" "desc"

Table sort direction options. This sorts the rows that are returned in the result set.

group_by
Array of strings (TableGroupBy)

Table group by options. This groups the rows that are returned in the result set by the given columns.

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
{
  • "data": {
    },
  • "metadata": {
    }
}

PlatformQueryListFilters

List Query Filters

Authorizations:
bearerAuthcookieAuth
path Parameters
query_id
required
string <uuid> (PlatformQueryID)

The unique ID for the query.

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

tag
Array of strings (PlatformFilterTag)

Filter tags

Responses

Response samples

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

PlatformQuerySaveFilter

Save Query Filter

Authorizations:
bearerAuthcookieAuth
path Parameters
query_id
required
string <uuid> (PlatformQueryID)

The unique ID for the query.

Request Body schema: application/json
required
name
required
string
expression
required
string (PlatformFilterExpression)

A table column filter.

public
boolean
Default: true
tags
Array of strings (PlatformFilterTag)
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "t2.micro EC2 instances",
  • "expression": "resource_type=aws_s3_buckets",
  • "public": true,
  • "tags": [
    ],
  • "description": "Filter to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table"
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "name": "t2.micro EC2 instances",
  • "expression": "resource_type=aws_s3_buckets",
  • "description": "Filter to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table",
  • "table": "cloud_assets",
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "user_id": "12345678-1234-1234-1234-1234567890ab",
  • "tags": [
    ],
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformQueryListFilterTags

List Filter Tags For A Saved Query

Authorizations:
bearerAuthcookieAuth
path Parameters
query_id
required
string <uuid> (PlatformQueryID)

The unique ID for the query.

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": {
    }
}

PlatformTableListFilterTags

List Filter Tags For A Table

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

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": {
    }
}

tables

PlatformListTables

List Tables

Authorizations:
bearerAuthcookieAuth
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": {
    }
}

PlatformTableListRows

List Table Rows

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

query Parameters
select
Array of strings (TableSelect)

Table selects. This filters the columns that are returned in the result set.

filter_mode
string
Default: "smart"
Enum: "smart" "search" "column"

Table filter mode.

Smart mode switches between column and search mode based on the filtered table and

Search mode allows searching deeply nested data but is not available on all tables as it requires a separate indexing step. Search mode is only available on resource tables or queries derived from resource tables results that contain _cq_id and _cq_source_id. Search mode may also be used against cloud_assets but it will only return results from resource tables.

Column mode searches purely using the columns in the table. It will work on all table results but it is not optimized for arbitrary substring searches and so may be slow on larger tables.

filter
Array of strings (PlatformFilterExpression)
Example: filter=resource_type=aws_s3_buckets

Table filters. This filters the rows that are returned in the result set.

filter_id
Array of strings <uuid> (PlatformFilterID) [ items <uuid > ]

Table filter IDs. These should be valid Saved Filter IDs. These filters will be applied to the query results before returning them.

sort_by
Array of strings (TableSortBy)

Table sort by options. This sorts the rows that are returned in the result set.

sort_dir
Array of strings (TableSortDirection)
Items Enum: "asc" "desc"

Table sort direction options. This sorts the rows that are returned in the result set.

group_by
Array of strings (TableGroupBy)

Table group by options. This groups the rows that are returned in the result set by the given columns.

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
{
  • "data": {
    },
  • "metadata": {
    }
}

PlatformTableRowById

Get Table row

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

table_row_id
required
string (PlatformTableRowID)
Example: table_12345678-1234-1234-1234-1234567890ab

ID of the Resource

query Parameters
filter_mode
string
Default: "smart"
Enum: "smart" "search" "column"

Table filter mode.

Smart mode switches between column and search mode based on the filtered table and

Search mode allows searching deeply nested data but is not available on all tables as it requires a separate indexing step. Search mode is only available on resource tables or queries derived from resource tables results that contain _cq_id and _cq_source_id. Search mode may also be used against cloud_assets but it will only return results from resource tables.

Column mode searches purely using the columns in the table. It will work on all table results but it is not optimized for arbitrary substring searches and so may be slow on larger tables.

filter
Array of strings (PlatformFilterExpression)
Example: filter=resource_type=aws_s3_buckets

Table filters. This filters the rows that are returned in the result set.

filter_id
Array of strings <uuid> (PlatformFilterID) [ items <uuid > ]

Table filter IDs. These should be valid Saved Filter IDs. These filters will be applied to the query results before returning them.

Responses

Response samples

Content type
application/json
{
  • "data": { },
  • "matches": [
    ]
}

PlatformTableSchema

Get Table Schema

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

Responses

Response samples

Content type
application/json
{
  • "schema": [
    ],
  • "default_columns": [
    ]
}

PlatformBatchTableSchemas

Get Table Schemas

Authorizations:
bearerAuthcookieAuth
query Parameters
tables
required
Array of strings[ items non-empty ]
Example: tables=aws_ec2_instances&tables=aws_s3_buckets

A list of table names to retrieve schemas for

Responses

Response samples

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

PlatformTableListFilters

List Table Filters

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

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

tag
Array of strings (PlatformFilterTag)

Filter tags

Responses

Response samples

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

PlatformTableSaveFilter

Save Table Filter

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

Request Body schema: application/json
required
name
required
string
expression
required
string (PlatformFilterExpression)

A table column filter.

public
boolean
Default: true
tags
Array of strings (PlatformFilterTag)
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "t2.micro EC2 instances",
  • "expression": "resource_type=aws_s3_buckets",
  • "public": true,
  • "tags": [
    ],
  • "description": "Filter to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table"
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "name": "t2.micro EC2 instances",
  • "expression": "resource_type=aws_s3_buckets",
  • "description": "Filter to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table",
  • "table": "cloud_assets",
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "user_id": "12345678-1234-1234-1234-1234567890ab",
  • "tags": [
    ],
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformTableListRelations

List Table Relations

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

query Parameters
relation_name
string

Filter by related table name

Responses

Response samples

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

PlatformTableListColumns

Get Table Columns

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

query Parameters
filter_mode
string
Default: "smart"
Enum: "smart" "search" "column"

Table filter mode.

Smart mode switches between column and search mode based on the filtered table and

Search mode allows searching deeply nested data but is not available on all tables as it requires a separate indexing step. Search mode is only available on resource tables or queries derived from resource tables results that contain _cq_id and _cq_source_id. Search mode may also be used against cloud_assets but it will only return results from resource tables.

Column mode searches purely using the columns in the table. It will work on all table results but it is not optimized for arbitrary substring searches and so may be slow on larger tables.

filter
string

Filter by column name

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": {
    }
}

PlatformTableColumnListValues

Get Table Column Values

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

column_name
required
string

The name of a table column.

query Parameters
filter_mode
string
Default: "smart"
Enum: "smart" "search" "column"

Table filter mode.

Smart mode switches between column and search mode based on the filtered table and

Search mode allows searching deeply nested data but is not available on all tables as it requires a separate indexing step. Search mode is only available on resource tables or queries derived from resource tables results that contain _cq_id and _cq_source_id. Search mode may also be used against cloud_assets but it will only return results from resource tables.

Column mode searches purely using the columns in the table. It will work on all table results but it is not optimized for arbitrary substring searches and so may be slow on larger tables.

filter
string

Filter by column value.

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": {
    }
}

filters

PlatformQueryListFilters

List Query Filters

Authorizations:
bearerAuthcookieAuth
path Parameters
query_id
required
string <uuid> (PlatformQueryID)

The unique ID for the query.

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

tag
Array of strings (PlatformFilterTag)

Filter tags

Responses

Response samples

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

PlatformQuerySaveFilter

Save Query Filter

Authorizations:
bearerAuthcookieAuth
path Parameters
query_id
required
string <uuid> (PlatformQueryID)

The unique ID for the query.

Request Body schema: application/json
required
name
required
string
expression
required
string (PlatformFilterExpression)

A table column filter.

public
boolean
Default: true
tags
Array of strings (PlatformFilterTag)
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "t2.micro EC2 instances",
  • "expression": "resource_type=aws_s3_buckets",
  • "public": true,
  • "tags": [
    ],
  • "description": "Filter to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table"
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "name": "t2.micro EC2 instances",
  • "expression": "resource_type=aws_s3_buckets",
  • "description": "Filter to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table",
  • "table": "cloud_assets",
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "user_id": "12345678-1234-1234-1234-1234567890ab",
  • "tags": [
    ],
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformQueryListFilterTags

List Filter Tags For A Saved Query

Authorizations:
bearerAuthcookieAuth
path Parameters
query_id
required
string <uuid> (PlatformQueryID)

The unique ID for the query.

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": {
    }
}

PlatformTableListFilters

List Table Filters

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

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

tag
Array of strings (PlatformFilterTag)

Filter tags

Responses

Response samples

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

PlatformTableSaveFilter

Save Table Filter

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

Request Body schema: application/json
required
name
required
string
expression
required
string (PlatformFilterExpression)

A table column filter.

public
boolean
Default: true
tags
Array of strings (PlatformFilterTag)
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "t2.micro EC2 instances",
  • "expression": "resource_type=aws_s3_buckets",
  • "public": true,
  • "tags": [
    ],
  • "description": "Filter to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table"
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "name": "t2.micro EC2 instances",
  • "expression": "resource_type=aws_s3_buckets",
  • "description": "Filter to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table",
  • "table": "cloud_assets",
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "user_id": "12345678-1234-1234-1234-1234567890ab",
  • "tags": [
    ],
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformTableListFilterTags

List Filter Tags For A Table

Authorizations:
bearerAuthcookieAuth
path Parameters
table_name
required
string (PlatformTableName)
Example: cloud_assets

The name of the table.

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": {
    }
}

PlatformListFilters

List Filters

Authorizations:
bearerAuthcookieAuth
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

tag
Array of strings (PlatformFilterTag)

Filter tags

name_filter
string

Filter by filter name

expression_filter
string

Filter by filter expression

Responses

Response samples

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

PlatformListFilterTags

List Filter Tags

Authorizations:
bearerAuthcookieAuth
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": {
    }
}

PlatformGetFilterByID

Get a table filter by ID

Authorizations:
bearerAuthcookieAuth
path Parameters
filter_id
required
string <uuid> (PlatformFilterID)

The unique ID for the filter.

Responses

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "name": "t2.micro EC2 instances",
  • "expression": "resource_type=aws_s3_buckets",
  • "description": "Filter to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table",
  • "table": "cloud_assets",
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "user_id": "12345678-1234-1234-1234-1234567890ab",
  • "tags": [
    ],
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformUpdateFilter

Update a table filter

Authorizations:
bearerAuthcookieAuth
path Parameters
filter_id
required
string <uuid> (PlatformFilterID)

The unique ID for the filter.

Request Body schema: application/json
name
string
description
string
expression
string (PlatformFilterExpression)

A table column filter.

tags
Array of strings (PlatformFilterTag)

Responses

Request samples

Content type
application/json
{
  • "name": "t2.micro EC2 instances",
  • "description": "string",
  • "expression": "resource_type=aws_s3_buckets",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "12345678-1234-1234-1234-1234567890ab",
  • "name": "t2.micro EC2 instances",
  • "expression": "resource_type=aws_s3_buckets",
  • "description": "Filter to find all EC2 instances of type t2.micro from the aws_ec2_instance raw table",
  • "table": "cloud_assets",
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "user_id": "12345678-1234-1234-1234-1234567890ab",
  • "tags": [
    ],
  • "created_at": "2017-07-14T16:53:42Z"
}

PlatformDeleteFilter

Delete a table filter

Authorizations:
bearerAuthcookieAuth
path Parameters
filter_id
required
string <uuid> (PlatformFilterID)

The unique ID for the filter.

Responses

Response samples

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

custom-columns

PlatformListAllCustomColumns

List all custom columns

Authorizations:
bearerAuthcookieAuth
path Parameters
team_name
required
string (PlatformTeamName) <= 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

sort_by
Array of strings (CustomColumnSortBy)
Items Enum: "id" "description" "table_name" "column_name" "label" "column_type" "value_type" "value_expr" "created_by" "team_name" "created_at" "updated_at"

Sort by options

sort_dir
Array of strings (CustomColumnSortDirection)
Items Enum: "asc" "desc"

Custom column sort direction options

table
string

Filter columns by table name.

search_term
string

Filter columns by name, label, or description.

Responses

Response samples

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

PlatformSaveCustomColumn

Save a custom column

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

The unique name for the team.

Request Body schema: application/json
required
description
string
table_name
required
string

Table this column applies to.

column_name
required
string
label
required
string
column_type
string (PlatformCustomColumnColumnType)
Enum: "String" "Integer" "Float" "Boolean" "DateTime"

Data type of the column. Only needed for value_type=external.

value_type
required
string (PlatformCustomColumnValueType)
Enum: "expression" "external"
value_expr
string

Value expression. For value_type=expression, this is the actual SQL query. For value_type=external this is the default value.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "table_name": "cloud_assets",
  • "column_name": "environment",
  • "label": "Environment name",
  • "column_type": "String",
  • "value_type": "expression",
  • "value_expr": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "table_name": "cloud_assets",
  • "column_name": "environment",
  • "label": "Environment name",
  • "column_type": "String",
  • "value_type": "expression",
  • "value_expr": "string",
  • "created_by": {
    },
  • "created_at": "2017-07-14T16:53:42Z",
  • "team_name": "cloudquery"
}

PlatformGetCustomColumn

Get a custom column

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

The unique name for the team.

custom_column_id
required
string <uuid> (PlatformCustomColumnID)

The unique ID for the custom column.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "table_name": "cloud_assets",
  • "column_name": "environment",
  • "label": "Environment name",
  • "column_type": "String",
  • "value_type": "expression",
  • "value_expr": "string",
  • "created_by": {
    },
  • "created_at": "2017-07-14T16:53:42Z",
  • "team_name": "cloudquery"
}

PlatformUpdateCustomColumn

Update a custom column

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

The unique name for the team.

custom_column_id
required
string <uuid> (PlatformCustomColumnID)

The unique ID for the custom column.

Request Body schema: application/json
description
string
table_name
required
string

Table this column applies to.

column_name
required
string
label
required
string
column_type
string (PlatformCustomColumnColumnType)
Enum: "String" "Integer" "Float" "Boolean" "DateTime"

Data type of the column. Only needed for value_type=external.

value_type
required
string (PlatformCustomColumnValueType)
Enum: "expression" "external"
value_expr
string

Value expression. For value_type=expression, this is the actual SQL query. For value_type=external this is the default value.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "table_name": "cloud_assets",
  • "column_name": "environment",
  • "label": "Environment name",
  • "column_type": "String",
  • "value_type": "expression",
  • "value_expr": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "description": "string",
  • "table_name": "cloud_assets",
  • "column_name": "environment",
  • "label": "Environment name",
  • "column_type": "String",
  • "value_type": "expression",
  • "value_expr": "string",
  • "created_by": {
    },
  • "created_at": "2017-07-14T16:53:42Z",
  • "team_name": "cloudquery"
}

PlatformDeleteCustomColumn

Delete a custom column

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

The unique name for the team.

custom_column_id
required
string <uuid> (PlatformCustomColumnID)

The unique ID for the custom column.

Responses

Response samples

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

PlatformPutCustomColumnData

Import data into a Custom Column

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

The unique name for the team.

custom_column_id
required
string <uuid> (PlatformCustomColumnID)

The unique ID for the custom column.

Request Body schema: application/json
required
required
Array of objects (Filter selecting assets, and value which should be assigned to matches.)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "data": {
    }
}

PlatformPutCustomColumnValues

Edit values within a Custom Column

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

The unique name for the team.

custom_column_id
required
string <uuid> (PlatformCustomColumnID)

The unique ID for the custom column.

Request Body schema: application/json
required
required
Array of objects (The cq_id of the row and the value to set.)

Responses

Request samples

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

Response samples

Content type
application/json
{ }

policies

PlatformListPolicies

List Policies

Authorizations:
bearerAuthcookieAuth
query Parameters
search_term
string

Filter policies by name.

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

sort_by
Array of strings (PlatformPolicySortBy)
Items Enum: "id" "name" "description" "status" "filter_id" "evaluated_resources" "rule_violations" "created_by" "created_at" "updated_at"

Sort by options

sort_dir
Array of strings (CustomColumnSortDirection)
Items Enum: "asc" "desc"

Platform policies sort direction options

sort
string

DEPRECATED! Sorting order.

Responses

Response samples

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

PlatformCreatePolicy

Create Policy

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
required
name
required
string
description
required
string
framework_ids
required
Array of strings <uuid> [ items <uuid > ]
filter_id
string
status
required
string
Enum: "paused" "active"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "framework_ids": [
    ],
  • "filter_id": "string",
  • "status": "paused"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

PlatformListAllFrameworks

List All Frameworks

Authorizations:
bearerAuthcookieAuth
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
{
  • "frameworks": [
    ],
  • "metadata": {
    }
}

PlatformGetPolicy

Get Policy

Authorizations:
bearerAuthcookieAuth
path Parameters
policy_id
required
string <uuid>

ID of the policy.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

PlatformUpdatePolicy

Update Policy

Authorizations:
bearerAuthcookieAuth
path Parameters
policy_id
required
string <uuid>

ID of the policy.

Request Body schema: application/json
required
name
required
string
description
required
string
framework_ids
required
Array of strings <uuid> [ items <uuid > ]
filter_id
string
status
required
string
Enum: "paused" "active"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "framework_ids": [
    ],
  • "filter_id": "string",
  • "status": "paused"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

PlatformDeletePolicy

Delete Policy

Authorizations:
bearerAuthcookieAuth
path Parameters
policy_id
required
string <uuid>

ID of the policy.

Responses

Response samples

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

PlatformListPolicyFrameworks

List Policy Frameworks

Authorizations:
bearerAuthcookieAuth
path Parameters
policy_id
required
string <uuid>

ID of the policy.

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

sort_by
Array of strings (PlatformPolicyFrameworkSortBy)
Items Enum: "id" "label" "description"

Sort by options

sort_dir
Array of strings (CustomColumnSortDirection)
Items Enum: "asc" "desc"

Platform policies sort direction options

search_term
string

Filter rules by name.

sort
string

DEPRECATED! Sorting order.

Responses

Response samples

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

PlatformListPolicyRules

List Policy Rules

Authorizations:
bearerAuthcookieAuth
path Parameters
policy_id
required
string <uuid>

ID of the policy.

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

sort_by
Array of strings (PlatformPolicyRuleSortBy)
Items Enum: "id" "framework_id" "name" "description" "risk" "category" "violations" "version"

Sort by options

sort_dir
Array of strings (CustomColumnSortDirection)
Items Enum: "asc" "desc"

Platform policies sort direction options

search_term
string

Filter rules by name.

sort
string

Sorting order.

Responses

Response samples

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

PlatformListPolicyRuleDetails

List Policy Rule Details

Authorizations:
bearerAuthcookieAuth
path Parameters
policy_id
required
string <uuid>

ID of the policy.

rule_id
required
string <uuid>

ID of the rule.

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

sort_by
Array of strings (PlatformPolicyRuleDetailSortBy)
Items Enum: "name" "cloud" "account" "region" "tags"

Sort by options

sort_dir
Array of strings (CustomColumnSortDirection)
Items Enum: "asc" "desc"

Platform policies sort direction options

search_term
string

Filter rules by name.

sort
string

DEPRECATED! Sorting order.

Responses

Response samples

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

PlatformTogglePolicy

Toggle Policy status

Authorizations:
bearerAuthcookieAuth
path Parameters
policy_id
required
string <uuid>

ID of the policy.

query Parameters
status
required
string
Enum: "paused" "active"

Responses

Response samples

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

PlatformGetPolicyViolationsHistory

Get Policy Violations History for defined period.

Authorizations:
bearerAuthcookieAuth
path Parameters
policy_id
required
string <uuid>

ID of the policy.

query Parameters
start
string <date-time>

A valid ISO 8601 date string representing the inclusive start of the period within which to return history entities. Defaults to start of current month if not specified.

end
string <date-time>

A valid ISO 8601 date string representing the exclusive end of the period within which to return history entities. Defaults to end of current month if not specified.

Responses

Response samples

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

analytics

Get OpenAPI JSON

Returns the OpenAPI definition in JSON format.

Responses

Response samples

Content type
application/json
{ }

platform

PlatformListPlatformVersions

List platform versions

Authorizations:
bearerAuthcookieAuth
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": {
    }
}