Skip to content

turbot/pipes-sdk-go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Go SDK for Turbot Pipes

Turbot Pipes is an intelligence, automation & security platform built specifically for DevOps.

For help on getting started with Turbot Pipes, please visit https://turbot.com/pipes.

Getting Started

Here's an example of listing the workspaces for your user:

package main

import (
    "context"
    "fmt"
    "os"

    pipes "github.com/turbot/pipes-sdk-go"
)

func main() {
    // Create a default configuration
    configuration := pipes.NewConfiguration()

    // Add your Turbot Pipes user token as an auth header
    configuration.AddDefaultHeader("Authorization", fmt.Sprintf("Bearer %s", os.Getenv("PIPES_TOKEN")))

    // Create a client
    client := pipes.NewAPIClient(configuration)

    // Find your authenticated user info
    actor, _, err := client.Actors.Get(context.Background()).Execute()

    if err != nil {
      // Do something with the error
      return
    }

    // List your workspaces
    workspaces, _, err := client.UserWorkspaces.List(context.Background(), actor.Handle).Execute()

    if err != nil {
      // Do something with the error
      return
    }
}

Usages

For more detailed examples of using the SDK, please check out the following open source projects:

Documentation for API Endpoints

All URIs are relative to https://pipes.turbot.com/api/v0

Class Method HTTP request Description
Actors Get Get /actor Actor information
Actors ListActivity Get /actor/activity List actor activity
Actors ListConnections Get /actor/conn List actor connections
Actors ListOrgInvites Get /actor/org/invite List org invites for actor
Actors ListOrgs Get /actor/org List actor orgs
Actors ListWorkspaces Get /actor/workspace List actor workspaces
Auth ConfirmLogin Get /login/confirm Confirm user login
Auth ConfirmSignup Get /signup/confirm Confirm user signup
Auth Login Post /login User login
Auth LoginTokenCreate Post /login/token Generate temporary token request
Auth LoginTokenDelete Delete /login/token/{temporary_token_request_id} Delete temporary token request
Auth LoginTokenGet Get /login/token/{temporary_token_request_id} Get temporary token request
Auth LoginTokenUpdate Patch /login/token/{temporary_token_request_id} Update temporary token request
Auth Logout Get /logout/{provider} User logout
Auth PostProviderCallback Post /auth/{provider}/callback Post auth provider callback
Auth Provider Get /auth/{provider} Auth Provider
Auth ProviderCallback Get /auth/{provider}/callback Auth provider callback
Auth Signup Post /signup User signup
Identities Get Get /identity/{identity_handle} Get identity
Identities GetAvatar Get /identity/{identity_handle}/avatar Get identity avatar
Identities List Get /identity List identities
OrgConnections Create Post /org/{org_handle}/connection Create org connection
OrgConnections CreateDeprecated Post /org/{org_handle}/conn Create org connection
OrgConnections Delete Delete /org/{org_handle}/connection/{connection_handle} Delete org connection
OrgConnections DeleteDeprecated Delete /org/{org_handle}/conn/{conn_handle} Delete org connection
OrgConnections Get Get /org/{org_handle}/connection/{connection_handle} Get org connection
OrgConnections GetDeprecated Get /org/{org_handle}/conn/{conn_handle} Get org connection
OrgConnections List Get /org/{org_handle}/connection List org connections
OrgConnections ListDeprecated Get /org/{org_handle}/conn List org connections
OrgConnections ListWorkspaces Get /org/{org_handle}/connection/{connection_handle}/workspace List org connection workspaces
OrgConnections ListWorkspacesDeprecated Get /org/{org_handle}/conn/{conn_handle}/workspace List org connection workspaces
OrgConnections Test Post /org/{org_handle}/connection/{connection_handle}/test Test org connection
OrgConnections TestDeprecated Post /org/{org_handle}/conn/{conn_handle}/test Test org connection
OrgConnections Update Patch /org/{org_handle}/connection/{connection_handle} Update org connection
OrgConnections UpdateDeprecated Patch /org/{org_handle}/conn/{conn_handle} Update org connection
OrgMembers ConfirmInvite Get /org/{org_handle}/member/invite/confirm Confirm org member invite
OrgMembers Create Post /org/{org_handle}/member Create Org Member
OrgMembers Delete Delete /org/{org_handle}/member/{user_handle} Delete org member
OrgMembers DeleteInvite Delete /org/{org_handle}/member/invite Delete org member invite
OrgMembers Get Get /org/{org_handle}/member/{user_handle} Get org member
OrgMembers Invite Post /org/{org_handle}/member/invite Invite org member
OrgMembers List Get /org/{org_handle}/member List Organization Members
OrgMembers Update Patch /org/{org_handle}/member/{user_handle} Update org member
OrgProcesses Get Get /org/{org_handle}/process/{process_id} Get Org process
OrgProcesses List Get /org/{org_handle}/process List Org processes
OrgProcesses Log Get /org/{org_handle}/process/{process_id}/log/{log_file}.{content_type} List Org process logs
OrgWorkspaceAggregators Create Post /org/{org_handle}/workspace/{workspace_handle}/aggregator Create an aggregator for an org workspace
OrgWorkspaceAggregators Delete Delete /org/{org_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle} Delete an aggregator for a org workspace
OrgWorkspaceAggregators Get Get /org/{org_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle} Get an aggregator for a org workspace
OrgWorkspaceAggregators GetConnection Get /org/{org_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle}/connection/{connection_handle} Get a connection in the scope of an aggregator for a org workspace
OrgWorkspaceAggregators List Get /org/{org_handle}/workspace/{workspace_handle}/aggregator List aggregators for an org workspace
OrgWorkspaceAggregators ListConnections Get /org/{org_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle}/connection List connections in the scope of an aggregator for a org workspace
OrgWorkspaceAggregators Update Patch /org/{org_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle} Update an aggregator for a org workspace
OrgWorkspaceConnectionAssociations Create Post /org/{org_handle}/workspace/{workspace_handle}/conn Create org workspace connection association
OrgWorkspaceConnectionAssociations Delete Delete /org/{org_handle}/workspace/{workspace_handle}/conn/{conn_handle} Delete org workspace connection association
OrgWorkspaceConnectionAssociations Get Get /org/{org_handle}/workspace/{workspace_handle}/conn/{conn_handle} Get org workspace connection association
OrgWorkspaceConnectionAssociations List Get /org/{org_handle}/workspace/{workspace_handle}/conn List org workspace connection associations
OrgWorkspaceDatatankParts Command Post /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part/{datatank_part_id}/command Run org workspace Datatank table partition command
OrgWorkspaceDatatankParts Get Get /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/table/{datatank_part_id} Get org workspace Datatank table partition
OrgWorkspaceDatatankParts List Get /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part List org workspace Datatank partitions
OrgWorkspaceDatatankParts Update Patch /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part/{datatank_part_id} Update org workspace Datatank table partition
OrgWorkspaceDatatankTables Create Post /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table Create org workspace Datatank table
OrgWorkspaceDatatankTables Delete Delete /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name} Delete org workspace Datatank table
OrgWorkspaceDatatankTables Get Get /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name} Get org workspace Datatank table
OrgWorkspaceDatatankTables List Get /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table List org workspace Datatank tables
OrgWorkspaceDatatankTables Update Patch /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name} Update org workspace Datatank table
OrgWorkspaceDatatanks Create Post /org/{org_handle}/workspace/{workspace_handle}/datatank Create org workspace Datatank
OrgWorkspaceDatatanks Delete Delete /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle} Delete org workspace Datatank
OrgWorkspaceDatatanks Get Get /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle} Get org workspace Datatank
OrgWorkspaceDatatanks List Get /org/{org_handle}/workspace/{workspace_handle}/datatank List org workspace Datatank
OrgWorkspaceDatatanks Update Patch /org/{org_handle}/workspace/{workspace_handle}/datatank/{datatank_handle} Update org workspace Datatank
OrgWorkspaceMembers Create Post /org/{org_handle}/workspace/{workspace_handle}/member Create Org Workspace Member
OrgWorkspaceMembers Delete Delete /org/{org_handle}/workspace/{workspace_handle}/member/{user_handle} Delete Org Workspace Member
OrgWorkspaceMembers Get Get /org/{org_handle}/workspace/{workspace_handle}/member/{user_handle} Get Org Workspace Member
OrgWorkspaceMembers List Get /org/{org_handle}/workspace/{workspace_handle}/member List Organization Workspace Members
OrgWorkspaceMembers Update Patch /org/{org_handle}/workspace/{workspace_handle}/member/{user_handle} Update Org Workspace Member
OrgWorkspaceModVariables CreateSetting Post /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable Create a setting for a mod variable in an organization workspace
OrgWorkspaceModVariables DeleteSetting Delete /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable/{variable_name} Delete setting for a mod variable in an organization workspace
OrgWorkspaceModVariables GetSetting Get /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable/{variable_name} Get setting for a mod variable in an organization workspace
OrgWorkspaceModVariables List Get /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable List variables in an organization workspace mod
OrgWorkspaceModVariables UpdateSetting Patch /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable/{variable_name} Update setting for a mod variable in an organization workspace
OrgWorkspaceMods Get Get /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias} Get organization workspace installed mod
OrgWorkspaceMods Install Post /org/{org_handle}/workspace/{workspace_handle}/mod Install a mod to an organization workspace
OrgWorkspaceMods List Get /org/{org_handle}/workspace/{workspace_handle}/mod List organization workspace installed mods
OrgWorkspaceMods Uninstall Delete /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias} Uninstall mod from organization workspace.
OrgWorkspaceMods Update Patch /org/{org_handle}/workspace/{workspace_handle}/mod/{mod_alias} Update a mod in an organization workspace
OrgWorkspacePipelines Command Post /org/{org_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id}/command Run org workspace pipeline command
OrgWorkspacePipelines Create Post /org/{org_handle}/workspace/{workspace_handle}/pipeline Create org workspace pipeline
OrgWorkspacePipelines Delete Delete /org/{org_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id} Delete org workspace pipeline
OrgWorkspacePipelines Get Get /org/{org_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id} Get org workspace pipeline
OrgWorkspacePipelines List Get /org/{org_handle}/workspace/{workspace_handle}/pipeline List org workspace pipelines
OrgWorkspacePipelines Update Patch /org/{org_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id} Update org workspace pipeline
OrgWorkspaceProcesses Get Get /org/{org_handle}/workspace/{workspace_handle}/process/{process_id} Get org workspace process
OrgWorkspaceProcesses List Get /org/{org_handle}/workspace/{workspace_handle}/process List org workspace processes
OrgWorkspaceProcesses Log Get /org/{org_handle}/workspace/{workspace_handle}/process/{process_id}/log/{log_file}.{content_type} List org workspace process logs
OrgWorkspaceSchemas Attach Post /org/{org_handle}/workspace/{workspace_handle}/schema Attach a schema to an org workspace
OrgWorkspaceSchemas Detach Delete /org/{org_handle}/workspace/{workspace_handle}/schema/{schema_name} Detach a schema from an org workspace
OrgWorkspaceSchemas Get Get /org/{org_handle}/workspace/{workspace_handle}/schema/{schema_name} Get org workspace schema
OrgWorkspaceSchemas Get_0 Get /org/{org_handle}/workspace/{workspace_handle}/schema/{schema_name}/table List org workspace schema tables
OrgWorkspaceSchemas List Get /org/{org_handle}/workspace/{workspace_handle}/schema List org workspace schemas
OrgWorkspaceSnapshots Create Post /org/{org_handle}/workspace/{workspace_handle}/snapshot Create org workspace snapshot
OrgWorkspaceSnapshots Delete Delete /org/{org_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id} Delete org workspace snapshot
OrgWorkspaceSnapshots Download Get /org/{org_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id}.{content_type} Download org workspace snapshot
OrgWorkspaceSnapshots Get Get /org/{org_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id} Get org workspace snapshot
OrgWorkspaceSnapshots List Get /org/{org_handle}/workspace/{workspace_handle}/snapshot List org workspace snapshots
OrgWorkspaceSnapshots Update Patch /org/{org_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id} Update org workspace snapshot
OrgWorkspaceUsages List Get /org/{org_handle}/workspace/{workspace_handle}/usage List org workspace usage
OrgWorkspaces Command Post /org/{org_handle}/workspace/{workspace_handle}/command Run org workspace command
OrgWorkspaces Create Post /org/{org_handle}/workspace Create org workspace
OrgWorkspaces Delete Delete /org/{org_handle}/workspace/{workspace_handle} Delete org workspace
OrgWorkspaces Get Get /org/{org_handle}/workspace/{workspace_handle} Get org workspace
OrgWorkspaces GetQuery Get /org/{org_handle}/workspace/{workspace_handle}/query Query org workspace
OrgWorkspaces GetQueryWithExtensions Get /org/{org_handle}/workspace/{workspace_handle}/query/data.{extensions} Query org workspace with extensions
OrgWorkspaces List Get /org/{org_handle}/workspace List org workspaces
OrgWorkspaces ListAuditLogs Get /org/{org_handle}/workspace/{workspace_handle}/audit_log Org workspace audit logs
OrgWorkspaces ListDBLogs Get /org/{org_handle}/workspace/{workspace_handle}/db_log Org workspace logs
OrgWorkspaces PostQuery Post /org/{org_handle}/workspace/{workspace_handle}/query Query org workspace
OrgWorkspaces PostQueryWithExtensions Post /org/{org_handle}/workspace/{workspace_handle}/query/data.{extensions} Query org workspace with extensions
OrgWorkspaces Update Patch /org/{org_handle}/workspace/{workspace_handle} Update org workspace
Orgs Create Post /org Create org
Orgs CreateAvatar Post /org/{org_handle}/avatar Create org avatar
Orgs Delete Delete /org/{org_handle} Delete org
Orgs DeleteAvatar Delete /org/{org_handle}/avatar Delete org avatar
Orgs Get Get /org/{org_handle} Get org
Orgs GetQuota Get /org/{org_handle}/quota Org quota
Orgs List Get /org List orgs
Orgs ListAuditLogs Get /org/{org_handle}/audit_log Org audit logs
Orgs ListConstraints Get /org/{org_handle}/constraint List org constraints
Orgs ListFeatures Get /org/{org_handle}/feature Org features
Orgs ListUsage Get /org/{org_handle}/usage List org usage
Orgs Update Patch /org/{org_handle} Update org
TenantMembers ConfirmInvite Get /tenant/{tenant_handle}/member/invite/confirm Confirm tenant member invite
TenantMembers Delete Delete /tenant/{tenant_handle}/member/{user_handle} Delete tenant member
TenantMembers DeleteInvite Delete /tenant/{tenant_handle}/member/invite Delete tenant member invite
TenantMembers Get Get /tenant/{tenant_handle}/member/{user_handle} Get tenant member
TenantMembers Invite Post /tenant/{tenant_handle}/member/invite Invite tenant member
TenantMembers List Get /tenant/{tenant_handle}/member List Tenant Members
TenantMembers Update Patch /tenant/{tenant_handle}/member/{user_handle} Update tenant member
Tenants Create Post /tenant Create tenant
Tenants CreateAvatar Post /tenant/{tenant_handle}/avatar Create tenant avatar
Tenants Delete Delete /tenant/{tenant_handle} Delete tenant
Tenants DeleteAvatar Delete /tenant/{tenant_handle}/avatar Delete tenant avatar
Tenants Get Get /tenant/{tenant_handle} Get tenant
Tenants GetAvatar Get /tenant/{tenant_handle}/avatar Get tenant avatar
Tenants GetSettings Get /settings Get tenant settings
Tenants List Get /tenant List tenants
Tenants ListConstraints Get /tenant/{tenant_handle}/constraint List tenant constraints
Tenants ListUsage Get /tenant/{tenant_handle}/usage List tenant usage
Tenants Update Patch /tenant/{tenant_handle} Update tenant
Tenants UpdateSettings Patch /settings Update tenant settings
UserConnections Create Post /user/{user_handle}/connection Create user connection
UserConnections CreateDeprecated Post /user/{user_handle}/conn Create user connection
UserConnections Delete Delete /user/{user_handle}/connection/{connection_handle} Delete user connection
UserConnections DeleteDeprecated Delete /user/{user_handle}/conn/{conn_handle} Delete user connection
UserConnections Get Get /user/{user_handle}/connection/{connection_handle} Get user connection
UserConnections GetDeprecated Get /user/{user_handle}/conn/{conn_handle} Get user connection
UserConnections List Get /user/{user_handle}/connection List user connections
UserConnections ListDeprecated Get /user/{user_handle}/conn List user connections
UserConnections ListWorkspaces Get /user/{user_handle}/connection/{connection_handle}/workspace List user connection workspaces
UserConnections ListWorkspacesDeprecated Get /user/{user_handle}/conn/{conn_handle}/workspace List user connection workspaces
UserConnections Test Post /user/{user_handle}/connection/{connection_handle}/test Test user connection
UserConnections TestDeprecated Post /user/{user_handle}/conn/{conn_handle}/test Test user connection
UserConnections Update Patch /user/{user_handle}/connection/{connection_handle} Update user connection
UserConnections UpdateDeprecated Patch /user/{user_handle}/conn/{conn_handle} Update user connection
UserProcesses Get Get /user/{user_handle}/process/{process_id} Get User process
UserProcesses List Get /user/{user_handle}/process List User processes
UserProcesses Log Get /user/{user_handle}/process/{process_id}/log/{log_file}.{content_type} List user process logs
UserTokens Create Post /user/{user_handle}/token Create token
UserTokens Delete Delete /user/{user_handle}/token/{token_id} Delete token
UserTokens Get Get /user/{user_handle}/token/{token_id} Get token
UserTokens List Get /user/{user_handle}/token List tokens
UserTokens Update Patch /user/{user_handle}/token/{token_id} Update token
UserWorkspaceAggregators Create Post /user/{user_handle}/workspace/{workspace_handle}/aggregator Create an aggregator for a user workspace
UserWorkspaceAggregators Delete Delete /user/{user_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle} Delete an aggregator for a user workspace
UserWorkspaceAggregators Get Get /user/{user_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle} Get an aggregator for a user workspace
UserWorkspaceAggregators GetConnection Get /user/{user_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle}/connection/{connection_handle} Get a connection in the scope of an aggregator for a user workspace
UserWorkspaceAggregators List Get /user/{user_handle}/workspace/{workspace_handle}/aggregator List aggregators for a user workspace
UserWorkspaceAggregators ListConnections Get /user/{user_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle}/connection List connections in the scope of an aggregator for a user workspace
UserWorkspaceAggregators Update Patch /user/{user_handle}/workspace/{workspace_handle}/aggregator/{aggregator_handle} Update an aggregator for a user workspace
UserWorkspaceConnectionAssociations Create Post /user/{user_handle}/workspace/{workspace_handle}/conn Create user workspace connection association
UserWorkspaceConnectionAssociations Delete Delete /user/{user_handle}/workspace/{workspace_handle}/conn/{conn_handle} Delete user workspace connection association
UserWorkspaceConnectionAssociations Get Get /user/{user_handle}/workspace/{workspace_handle}/conn/{conn_handle} Get user workspace connection association
UserWorkspaceConnectionAssociations List Get /user/{user_handle}/workspace/{workspace_handle}/conn List user workspace connection associations
UserWorkspaceDatatankParts Command Post /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part/{datatank_part_id}/command Run user workspace Datatank table partition command
UserWorkspaceDatatankParts Get Get /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/table/{datatank_part_id} Get user workspace Datatank table partition
UserWorkspaceDatatankParts List Get /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part List user workspace Datatank partitions
UserWorkspaceDatatankParts Update Patch /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name}/part/{datatank_part_id} Update user workspace Datatank table partition
UserWorkspaceDatatankTables Create Post /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table Create user workspace Datatank table
UserWorkspaceDatatankTables Delete Delete /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name} Delete user workspace Datatank table
UserWorkspaceDatatankTables Get Get /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name} Get user workspace Datatank table
UserWorkspaceDatatankTables List Get /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table List user workspace Datatank tables
UserWorkspaceDatatankTables Update Patch /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle}/table/{datatank_table_name} Update user workspace Datatank table
UserWorkspaceDatatanks Create Post /user/{user_handle}/workspace/{workspace_handle}/datatank Create user workspace Datatank
UserWorkspaceDatatanks Delete Delete /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle} Delete user workspace Datatank table
UserWorkspaceDatatanks Get Get /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle} Get user workspace Datatank
UserWorkspaceDatatanks List Get /user/{user_handle}/workspace/{workspace_handle}/datatank List user workspace Datatank
UserWorkspaceDatatanks Update Patch /user/{user_handle}/workspace/{workspace_handle}/datatank/{datatank_handle} Update user workspace Datatank
UserWorkspaceModVariables CreateSetting Post /user/{user_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable Create a setting for a mod variable in a user workspace
UserWorkspaceModVariables DeleteSetting Delete /user/{user_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable/{variable_name} Delete setting for a mod variable in a user workspace
UserWorkspaceModVariables GetSetting Get /user/{user_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable/{variable_name} Get setting for a mod variable in a user workspace
UserWorkspaceModVariables List Get /user/{user_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable List variables for a user workspace mod
UserWorkspaceModVariables UpdateSetting Patch /user/{user_handle}/workspace/{workspace_handle}/mod/{mod_alias}/variable/{variable_name} Update setting for a mod variable in a user workspace
UserWorkspaceMods Get Get /user/{user_handle}/workspace/{workspace_handle}/mod/{mod_alias} Get user workspace installed mod
UserWorkspaceMods Install Post /user/{user_handle}/workspace/{workspace_handle}/mod Install a mod to a user's workspace
UserWorkspaceMods List Get /user/{user_handle}/workspace/{workspace_handle}/mod List user workspace installed mods
UserWorkspaceMods Uninstall Delete /user/{user_handle}/workspace/{workspace_handle}/mod/{mod_alias} Uninstall mod from a user's workspace.
UserWorkspaceMods Update Patch /user/{user_handle}/workspace/{workspace_handle}/mod/{mod_alias} Update a mod in a user's workspace
UserWorkspacePipelines Command Post /user/{user_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id}/command Run user workspace pipeline command
UserWorkspacePipelines Create Post /user/{user_handle}/workspace/{workspace_handle}/pipeline Create user workspace pipeline
UserWorkspacePipelines Delete Delete /user/{user_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id} Delete user workspace pipeline
UserWorkspacePipelines Get Get /user/{user_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id} Get user workspace pipeline
UserWorkspacePipelines List Get /user/{user_handle}/workspace/{workspace_handle}/pipeline List user workspace pipelines
UserWorkspacePipelines Update Patch /user/{user_handle}/workspace/{workspace_handle}/pipeline/{pipeline_id} Update user workspace pipeline
UserWorkspaceProcesses Get Get /user/{user_handle}/workspace/{workspace_handle}/process/{process_id} Get user workspace process
UserWorkspaceProcesses List Get /user/{user_handle}/workspace/{workspace_handle}/process List user workspace processes
UserWorkspaceProcesses Log Get /user/{user_handle}/workspace/{workspace_handle}/process/{process_id}/log/{log_file}.{content_type} List user workspace process logs
UserWorkspaceSchemas Attach Post /user/{user_handle}/workspace/{workspace_handle}/schema Attach a schema to a user workspace
UserWorkspaceSchemas Detach Delete /user/{user_handle}/workspace/{workspace_handle}/schema/{schema_name} Detach a schema from a user workspace
UserWorkspaceSchemas Get Get /user/{user_handle}/workspace/{workspace_handle}/schema/{schema_name} Get user workspace schema
UserWorkspaceSchemas Get_0 Get /user/{user_handle}/workspace/{workspace_handle}/schema/{schema_name}/table List user workspace schema tables
UserWorkspaceSchemas List Get /user/{user_handle}/workspace/{workspace_handle}/schema List user workspace schemas
UserWorkspaceSnapshots Create Post /user/{user_handle}/workspace/{workspace_handle}/snapshot Create user workspace snapshot
UserWorkspaceSnapshots Delete Delete /user/{user_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id} Delete user workspace snapshot
UserWorkspaceSnapshots Download Get /user/{user_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id}.{content_type} Download user workspace snapshot
UserWorkspaceSnapshots Get Get /user/{user_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id} Get user workspace snapshot
UserWorkspaceSnapshots List Get /user/{user_handle}/workspace/{workspace_handle}/snapshot List user workspace snapshots
UserWorkspaceSnapshots Update Patch /user/{user_handle}/workspace/{workspace_handle}/snapshot/{snapshot_id} Update user workspace snapshot
UserWorkspaceUsages List Get /user/{user_handle}/workspace/{workspace_handle}/usage List user workspace usage
UserWorkspaces Command Post /user/{user_handle}/workspace/{workspace_handle}/command Run user workspace command
UserWorkspaces Create Post /user/{user_handle}/workspace Create user workspace
UserWorkspaces Delete Delete /user/{user_handle}/workspace/{workspace_handle} Delete user workspace
UserWorkspaces Get Get /user/{user_handle}/workspace/{workspace_handle} Get user workspace
UserWorkspaces GetQuery Get /user/{user_handle}/workspace/{workspace_handle}/query Query user workspace
UserWorkspaces GetQueryWithExtensions Get /user/{user_handle}/workspace/{workspace_handle}/query/data.{extensions} Query user workspace with extensions
UserWorkspaces List Get /user/{user_handle}/workspace List user workspaces
UserWorkspaces ListAuditLogs Get /user/{user_handle}/workspace/{workspace_handle}/audit_log User workspace audit logs
UserWorkspaces ListDBLogs Get /user/{user_handle}/workspace/{workspace_handle}/db_log User workspace logs
UserWorkspaces PostQuery Post /user/{user_handle}/workspace/{workspace_handle}/query Query user workspace
UserWorkspaces PostQueryWithExtensions Post /user/{user_handle}/workspace/{workspace_handle}/query/data.{extensions} Query user workspace with extensions
UserWorkspaces Update Patch /user/{user_handle}/workspace/{workspace_handle} Update user workspace
Users Create Post /user Create user
Users CreateAvatar Post /user/{user_handle}/avatar Create user avatar
Users CreateDBPassword Post /user/{user_handle}/password Create user password
Users Delete Delete /user/{user_handle} Delete user
Users DeleteAvatar Delete /user/{user_handle}/avatar Delete user avatar
Users Get Get /user/{user_handle} Get user
Users GetDBPassword Get /user/{user_handle}/password Get user password
Users GetEmail Get /user/{user_handle}/email/{email_id} Get user email
Users GetPreferences Get /user/{user_handle}/preferences Get user preferences
Users GetQuota Get /user/{user_handle}/quota User quota
Users List Get /user List users
Users ListAuditLogs Get /user/{user_handle}/audit_log User audit logs
Users ListConstraints Get /user/{user_handle}/constraint List user constraints
Users ListEmails Get /user/{user_handle}/email List user emails
Users ListFeatures Get /user/{user_handle}/feature User features
Users ListUsage Get /user/{user_handle}/usage List user usage
Users Update Patch /user/{user_handle} Update user
Users UpdatePreferences Patch /user/{user_handle}/preferences Update user preferences

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author