Skip to main content
New to Corsair? See API access, authentication, and error handling.

Actor

get

actor.get Get authenticated actor Risk: read
Input: empty object Output

listActivity

actor.listActivity List activity for actor Risk: read
Input Output

listConnections

actor.listConnections List connections for actor Risk: read
Input Output

listOrgs

actor.listOrgs List organizations for actor Risk: read
Input Output

listWorkspaces

actor.listWorkspaces List workspaces accessible by actor Risk: read
Input Output

Ai

createUserAiKey

ai.createUserAiKey Create user AI key Risk: write
Input Output: Record<string, any>

deleteOrgWorkspaceConversation

ai.deleteOrgWorkspaceConversation Delete AI conversation in org workspace Risk: destructive
Input Output: Record<string, any>

getUserAiKey

ai.getUserAiKey Get user AI key metadata Risk: read
Input Output: Record<string, any>

getUserWorkspaceConversation

ai.getUserWorkspaceConversation Get AI conversation details Risk: read
Input Output: Record<string, any>

listUserAiKeys

ai.listUserAiKeys List user AI keys Risk: read
Input Output

listUserWorkspaceConversations

ai.listUserWorkspaceConversations List AI conversations Risk: read
Input Output

sendUserWorkspaceChatMessage

ai.sendUserWorkspaceChatMessage Send chat message to workspace AI Risk: write
Input Output: Record<string, any>

testUserAiKey

ai.testUserAiKey Test user AI key Risk: read
Input Output: Record<string, any>

updateUserAiKey

ai.updateUserAiKey Update user AI key Risk: write
Input Output: Record<string, any>

updateUserWorkspaceConversation

ai.updateUserWorkspaceConversation Update AI conversation Risk: write
Input Output: Record<string, any>

Auth

createLoginTokenEmail

auth.createLoginTokenEmail Send login token to email Risk: write
Input Output: Record<string, any>

createSignup

auth.createSignup Create new user signup Risk: write
Input Output: Record<string, any>

createUserPassword

auth.createUserPassword Create user password Risk: write
Input Output: Record<string, any>

deleteUserToken

auth.deleteUserToken Delete user token Risk: destructive
Input Output: Record<string, any>

getAuthProvider

auth.getAuthProvider Get OAuth provider details Risk: read
Input Output: Record<string, any>

getUserPassword

auth.getUserPassword Get user password status Risk: read
Input Output: Record<string, any>

getUserToken

auth.getUserToken Get user token metadata Risk: read
Input Output: Record<string, any>

initiateLogin

auth.initiateLogin Initiate user login Risk: write
Input Output: Record<string, any>

updateUserToken

auth.updateUserToken Update user token status Risk: write
Input Output: Record<string, any>

Billing

deleteOrgBillingSubscription

billing.deleteOrgBillingSubscription Delete org billing subscription Risk: destructive
Input Output: Record<string, any>

getOrgBillingInvoice

billing.getOrgBillingInvoice Get org billing invoice Risk: read
Input Output: Record<string, any>

getUserBillingPlan

billing.getUserBillingPlan Get user billing plan Risk: read
Input Output: Record<string, any>

getUserBillingUpcomingInvoice

billing.getUserBillingUpcomingInvoice Get user upcoming invoice Risk: read
Input Output: Record<string, any> \| null

listUserBillingInvoices

billing.listUserBillingInvoices List user billing invoices Risk: read
Input Output

listUserBillingPaymentMethods

billing.listUserBillingPaymentMethods List user payment methods Risk: read
Input Output

listUserBillingSubscriptions

billing.listUserBillingSubscriptions List user billing subscriptions Risk: read
Input Output

updateOrgBillingSubscription

billing.updateOrgBillingSubscription Update org billing subscription Risk: write
Input Output: Record<string, any>

Connections

createOrgConnection

connections.createOrgConnection Create org connection Risk: write
Input Output

createOrgConnectionFolder

connections.createOrgConnectionFolder Create org connection folder Risk: write
Input Output: Record<string, any>

createUserConnection

connections.createUserConnection Create user connection Risk: write
Input Output

deleteOrgConnectionPermission

connections.deleteOrgConnectionPermission Delete org connection permission Risk: destructive
Input Output: Record<string, any>

deleteUserConnectionDeprecated

connections.deleteUserConnectionDeprecated Delete user connection (deprecated) Risk: destructive
Input Output: Record<string, any>

getOrgConnectionPermission

connections.getOrgConnectionPermission Get org connection permission Risk: read
Input Output: Record<string, any>

getUserConnection

connections.getUserConnection Get user connection details Risk: read
Input Output

listUserConnections

connections.listUserConnections List connections for user Risk: read
Input Output

testUserConnection

connections.testUserConnection Test user connection credentials Risk: read
Input Output: Record<string, any>

updateOrgConnection

connections.updateOrgConnection Update org connection Risk: write
Input Output

updateOrgConnectionFolder

connections.updateOrgConnectionFolder Update org connection folder Risk: write
Input Output: Record<string, any>

updateUserConnection

connections.updateUserConnection Update user connection Risk: write
Input Output

Datatanks

createUserWorkspaceDatatank

datatanks.createUserWorkspaceDatatank Create user workspace Datatank Risk: write
Input Output

createUserWorkspaceDatatankTable

datatanks.createUserWorkspaceDatatankTable Create Datatank table Risk: write
Input
Output: Record<string, any>

getDatatankTable

datatanks.getDatatankTable Get Datatank table details Risk: read
Input Output: Record<string, any>

getUserWorkspaceDatatank

datatanks.getUserWorkspaceDatatank Get user workspace Datatank Risk: read
Input Output

getUserWorkspaceSchema

datatanks.getUserWorkspaceSchema Get user workspace schema Risk: read
Input Output: Record<string, any>

getUserWorkspaceSchemaTable

datatanks.getUserWorkspaceSchemaTable Get schema table details Risk: read
Input Output: Record<string, any>

listOrgWorkspaceDatatanks

datatanks.listOrgWorkspaceDatatanks List org workspace Datatanks Risk: read
Input Output

listUserWorkspaceDatatankPartitions

datatanks.listUserWorkspaceDatatankPartitions List Datatank partitions Risk: read
Input Output

listUserWorkspaceDatatanks

datatanks.listUserWorkspaceDatatanks List user workspace Datatanks Risk: read
Input Output

listUserWorkspaceDatatankTables

datatanks.listUserWorkspaceDatatankTables List Datatank tables Risk: read
Input Output

listUserWorkspaceSchemas

datatanks.listUserWorkspaceSchemas List user workspace schemas Risk: read
Input Output

listUserWorkspaceSchemaTables

datatanks.listUserWorkspaceSchemaTables List schema tables Risk: read
Input Output

Identities

getIdentity

identities.getIdentity Get identity details by handle Risk: read
Input Output: Record<string, any>

getIdentityAvatar

identities.getIdentityAvatar Get identity avatar Risk: read
Input Output

listIdentities

identities.listIdentities List identities Risk: read
Input Output

Integrations

createUserIntegration

integrations.createUserIntegration Create user integration Risk: write
Input Output: Record<string, any>

deleteUserIntegration

integrations.deleteUserIntegration Delete user integration Risk: destructive
Input Output: Record<string, any>

getOrgIntegration

integrations.getOrgIntegration Get org integration Risk: read
Input Output: Record<string, any>

getOrgWorkspaceIntegration

integrations.getOrgWorkspaceIntegration Get org workspace integration Risk: read
Input Output: Record<string, any>

getUserIntegration

integrations.getUserIntegration Get user integration details Risk: read
Input Output: Record<string, any>

getUserWorkspaceIntegration

integrations.getUserWorkspaceIntegration Get user workspace integration Risk: read
Input Output: Record<string, any>

installUserSlackIntegration

integrations.installUserSlackIntegration Install Slack integration for user Risk: write
Input Output: Record<string, any>

listUserIntegrations

integrations.listUserIntegrations List integrations for user Risk: read
Input Output

listUserWorkspaceIntegrations

integrations.listUserWorkspaceIntegrations List user workspace integrations Risk: read
Input Output

testUserIntegration

integrations.testUserIntegration Test user integration Risk: read
Input Output: Record<string, any>

updateUserIntegration

integrations.updateUserIntegration Update user integration Risk: write
Input Output: Record<string, any>

Mods

createUserWorkspaceModVariableSetting

mods.createUserWorkspaceModVariableSetting Create mod variable setting Risk: write
Input Output: Record<string, any>

deleteOrgWorkspaceModVariableSetting

mods.deleteOrgWorkspaceModVariableSetting Delete org mod variable setting Risk: destructive
Input Output: Record<string, any>

deleteUserWorkspaceModVariableSetting

mods.deleteUserWorkspaceModVariableSetting Delete mod variable setting Risk: destructive
Input Output: Record<string, any>

getOrgWorkspaceModVariableSetting

mods.getOrgWorkspaceModVariableSetting Get org mod variable setting Risk: read
Input Output: Record<string, any>

getUserWorkspaceMod

mods.getUserWorkspaceMod Get installed mod details Risk: read
Input Output: Record<string, any>

getUserWorkspaceModVariableSetting

mods.getUserWorkspaceModVariableSetting Get mod variable setting Risk: read
Input Output: Record<string, any>

installUserWorkspaceMod

mods.installUserWorkspaceMod Install mod in user workspace Risk: write
Input Output: Record<string, any>

listOrgWorkspaceMods

mods.listOrgWorkspaceMods List installed mods in org workspace Risk: read
Input Output

listUserWorkspaceMods

mods.listUserWorkspaceMods List installed mods in workspace Risk: read
Input Output

listUserWorkspaceModVariables

mods.listUserWorkspaceModVariables List mod variables Risk: read
Input Output

Notifiers

createUserNotifier

notifiers.createUserNotifier Create user notifier Risk: write
Input Output: Record<string, any>

createUserWorkspaceNotifier

notifiers.createUserWorkspaceNotifier Create workspace notifier Risk: write
Input Output: Record<string, any>

deleteUserWorkspaceNotifier

notifiers.deleteUserWorkspaceNotifier Delete workspace notifier Risk: destructive
Input Output: Record<string, any>

getOrgWorkspaceNotifier

notifiers.getOrgWorkspaceNotifier Get org workspace notifier Risk: read
Input Output: Record<string, any>

getUserWorkspaceNotifier

notifiers.getUserWorkspaceNotifier Get workspace notifier Risk: read
Input Output: Record<string, any>

listUserNotifiers

notifiers.listUserNotifiers List user notifiers Risk: read
Input Output

listUserWorkspaceNotifiers

notifiers.listUserWorkspaceNotifiers List workspace notifiers Risk: read
Input Output

postUserWorkspaceNotifierCommand

notifiers.postUserWorkspaceNotifierCommand Post command to workspace notifier Risk: write
Input Output

Orgs

delete

orgs.delete Delete an organization Risk: destructive
Input Output: Record<string, any>

deleteWorkspace

orgs.deleteWorkspace Delete organization workspace Risk: destructive
Input Output: Record<string, any>

get

orgs.get Get organization details Risk: read
Input Output

getMember

orgs.getMember Get organization member details Risk: read
Input Output: Record<string, any>

listProcesses

orgs.listProcesses List organization processes Risk: read
Input Output

listServiceAccounts

orgs.listServiceAccounts List organization service accounts Risk: read
Input Output

listUsage

orgs.listUsage List organization usage Risk: read
Input Output

listWorkspaces

orgs.listWorkspaces List organization workspaces Risk: read
Input Output

runWorkspaceCommand

orgs.runWorkspaceCommand Run command on org workspace Risk: write
Input Output

updateMemberRole

orgs.updateMemberRole Update organization member role Risk: write
Input Output: Record<string, any>

updateServiceAccount

orgs.updateServiceAccount Update service account Risk: write
Input Output: Record<string, any>

updateServiceAccountToken

orgs.updateServiceAccountToken Update service account token Risk: write
Input Output: Record<string, any>

Pipelines

deleteUserWorkspacePipeline

pipelines.deleteUserWorkspacePipeline Delete pipeline from workspace Risk: destructive
Input Output: Record<string, any>

getOrgWorkspaceFlowpipeTrigger

pipelines.getOrgWorkspaceFlowpipeTrigger Get Flowpipe trigger details Risk: read
Input Output: Record<string, any>

getUserWorkspaceFlowpipeMod

pipelines.getUserWorkspaceFlowpipeMod Get Flowpipe mod details Risk: read
Input Output: Record<string, any>

getUserWorkspaceFlowpipePipeline

pipelines.getUserWorkspaceFlowpipePipeline Get Flowpipe pipeline details Risk: read
Input Output: Record<string, any>

getUserWorkspacePipeline

pipelines.getUserWorkspacePipeline Get pipeline details Risk: read
Input Output: Record<string, any>

installUserWorkspaceFlowpipeMod

pipelines.installUserWorkspaceFlowpipeMod Install Flowpipe mod Risk: write
Input Output: Record<string, any>

listOrgWorkspaceFlowpipeModVariables

pipelines.listOrgWorkspaceFlowpipeModVariables List org Flowpipe mod variables Risk: read
Input Output

listOrgWorkspacePipelines

pipelines.listOrgWorkspacePipelines List pipelines in org workspace Risk: read
Input Output

listUserWorkspaceFlowpipeInputs

pipelines.listUserWorkspaceFlowpipeInputs List Flowpipe inputs Risk: read
Input Output

listUserWorkspaceFlowpipeModVariables

pipelines.listUserWorkspaceFlowpipeModVariables List user Flowpipe mod variables Risk: read
Input Output

listUserWorkspaceFlowpipePipelines

pipelines.listUserWorkspaceFlowpipePipelines List Flowpipe pipelines Risk: read
Input Output

listUserWorkspaceFlowpipeTriggers

pipelines.listUserWorkspaceFlowpipeTriggers List Flowpipe triggers Risk: read
Input Output

listUserWorkspacePipelines

pipelines.listUserWorkspacePipelines List pipelines in workspace Risk: read
Input Output

listUserWorkspacePipelineTriggers

pipelines.listUserWorkspacePipelineTriggers List triggers for pipeline Risk: read
Input Output

runUserWorkspaceFlowpipePipelineCommand

pipelines.runUserWorkspaceFlowpipePipelineCommand Run Flowpipe pipeline command Risk: write
Input Output

runUserWorkspaceFlowpipeTriggerCommand

pipelines.runUserWorkspaceFlowpipeTriggerCommand Run Flowpipe trigger command Risk: write
Input Output

uninstallFlowpipeMod

pipelines.uninstallFlowpipeMod Uninstall Flowpipe mod Risk: destructive
Input Output: Record<string, any>

uninstallOrgWorkspaceFlowpipeMod

pipelines.uninstallOrgWorkspaceFlowpipeMod Uninstall org Flowpipe mod Risk: destructive
Input Output: Record<string, any>

Query

createOrgWorkspaceQuery

query.createOrgWorkspaceQuery Execute query in org workspace Risk: write
Input Output: Record<string, any>

createOrgWorkspaceSnapshot

query.createOrgWorkspaceSnapshot Create workspace snapshot Risk: write
Input
Output: Record<string, any>

getOrgWorkspaceQueryData

query.getOrgWorkspaceQueryData Get query data from org workspace Risk: read
Input Output: Record<string, any>

getUserWorkspaceQuery

query.getUserWorkspaceQuery Execute query in user workspace (GET) Risk: read
Input Output: Record<string, any>

getUserWorkspaceQueryData

query.getUserWorkspaceQueryData Get query data from user workspace Risk: read
Input Output: Record<string, any>

listUserWorkspaceSnapshots

query.listUserWorkspaceSnapshots List workspace snapshots Risk: read
Input Output

postUserWorkspaceQuery

query.postUserWorkspaceQuery Execute query in user workspace (POST) Risk: write
Input Output: Record<string, any>

runUserWorkspaceQuery

query.runUserWorkspaceQuery Run query in user workspace Risk: write
Input Output: Record<string, any>

Tenants

getTenant

tenants.getTenant Get tenant information Risk: read
Input Output: Record<string, any>

getTenantAvatar

tenants.getTenantAvatar Get tenant avatar image Risk: read
Input Output

getTenantSettings

tenants.getTenantSettings Get tenant settings Risk: read
Input: empty object Output: Record<string, any>

listTenants

tenants.listTenants List accessible tenants Risk: read
Input Output

Users

deleteUserAvatar

users.deleteUserAvatar Delete custom user avatar Risk: destructive
Input Output: Record<string, any>

get

users.get Get user details by handle Risk: read
Input Output

getUserEmail

users.getUserEmail Get user email details Risk: read
Input Output: Record<string, any>

getUserPreferences

users.getUserPreferences Get user preferences Risk: read
Input Output: Record<string, any>

getUserProcess

users.getUserProcess Get user process details Risk: read
Input Output

getUserWorkspace

users.getUserWorkspace Get user workspace details Risk: read
Input Output

listAuditLogs

users.listAuditLogs List user audit logs Risk: read
Input Output

listConstraints

users.listConstraints List user constraints Risk: read
Input Output

listProcesses

users.listProcesses List processes for user Risk: read
Input Output

listUsage

users.listUsage List user usage metrics Risk: read
Input Output

listUserEmails

users.listUserEmails List user emails Risk: read
Input Output

listWorkspaces

users.listWorkspaces List workspaces for user Risk: read
Input Output

runUserWorkspaceCommand

users.runUserWorkspaceCommand Run command on user workspace Risk: write
Input Output

update

users.update Update user information Risk: write
Input Output

updateUserPreferences

users.updateUserPreferences Update user preferences Risk: write
Input Output: Record<string, any>

updateUserWorkspace

users.updateUserWorkspace Update user workspace Risk: write
Input Output

Workspaces

createOrgWorkspaceAggregator

workspaces.createOrgWorkspaceAggregator Create org workspace aggregator Risk: write
Input Output: Record<string, any>

createOrgWorkspaceConnection

workspaces.createOrgWorkspaceConnection Create org workspace connection Risk: write
Input Output

createOrgWorkspaceConnectionFolder

workspaces.createOrgWorkspaceConnectionFolder Create org workspace connection folder Risk: write
Input Output: Record<string, any>

createUserWorkspaceConnection

workspaces.createUserWorkspaceConnection Create user workspace connection Risk: write
Input Output

createUserWorkspaceConnectionFolder

workspaces.createUserWorkspaceConnectionFolder Create user workspace connection folder Risk: write
Input Output: Record<string, any>

getOrgWorkspaceConnection

workspaces.getOrgWorkspaceConnection Get org workspace connection Risk: read
Input Output

getOrgWorkspaceConnectionFolder

workspaces.getOrgWorkspaceConnectionFolder Get org workspace connection folder Risk: read
Input Output: Record<string, any>

getUserWorkspaceAggregator

workspaces.getUserWorkspaceAggregator Get user workspace aggregator Risk: read
Input Output: Record<string, any>

getUserWorkspaceConnection

workspaces.getUserWorkspaceConnection Get user workspace connection Risk: read
Input Output

getUserWorkspaceConnectionFolder

workspaces.getUserWorkspaceConnectionFolder Get user workspace connection folder Risk: read
Input Output: Record<string, any>

getUserWorkspaceProcess

workspaces.getUserWorkspaceProcess Get workspace process Risk: read
Input Output

getUserWorkspaceProcessLog

workspaces.getUserWorkspaceProcessLog Get workspace process logs Risk: read
Input Output

listOrgWorkspaceProcesses

workspaces.listOrgWorkspaceProcesses List org workspace processes Risk: read
Input Output

listUserWorkspaceAggregatorConnections

workspaces.listUserWorkspaceAggregatorConnections List user workspace aggregator connections Risk: read
Input Output

listUserWorkspaceAggregators

workspaces.listUserWorkspaceAggregators List user workspace aggregators Risk: read
Input Output

listUserWorkspaceAuditLogs

workspaces.listUserWorkspaceAuditLogs List workspace audit logs Risk: read
Input Output

listUserWorkspaceConnectionAssociations

workspaces.listUserWorkspaceConnectionAssociations List user workspace connection associations Risk: read
Input Output

listUserWorkspaceConnectionFolders

workspaces.listUserWorkspaceConnectionFolders List user workspace connection folders Risk: read
Input Output

listUserWorkspaceConnections

workspaces.listUserWorkspaceConnections List user workspace connections Risk: read
Input Output

listUserWorkspaceConnectionTree

workspaces.listUserWorkspaceConnectionTree List user workspace connection tree Risk: read
Input Output: Record<string, any>

listUserWorkspaceDatabaseLogs

workspaces.listUserWorkspaceDatabaseLogs List workspace database logs Risk: read
Input Output

listUserWorkspaceProcesses

workspaces.listUserWorkspaceProcesses List workspace processes Risk: read
Input Output

listUserWorkspaceUsage

workspaces.listUserWorkspaceUsage List user workspace usage Risk: read
Input Output

testUserWorkspaceConnection

workspaces.testUserWorkspaceConnection Test user workspace connection Risk: read
Input Output: Record<string, any>