Skip to main content
Server path: /turbot-pipes-pipelines | Type: Application | PCID required: Yes

Tools

ToolDescription
turbot_pipes_pipelines_org_workspace_datatank_createCreate org workspace Datatank
turbot_pipes_pipelines_org_workspace_datatank_deleteDelete org workspace Datatank
turbot_pipes_pipelines_org_workspace_datatank_getGet org workspace Datatank
turbot_pipes_pipelines_org_workspace_datatank_listList org workspace Datatank
turbot_pipes_pipelines_org_workspace_datatank_table_createCreate org workspace Datatank table
turbot_pipes_pipelines_org_workspace_datatank_table_deleteDelete org workspace Datatank table
turbot_pipes_pipelines_org_workspace_datatank_table_getGet org workspace Datatank table
turbot_pipes_pipelines_org_workspace_datatank_table_listList org workspace Datatank tables
turbot_pipes_pipelines_org_workspace_datatank_table_updateUpdate org workspace Datatank table
turbot_pipes_pipelines_org_workspace_datatank_updateUpdate org workspace Datatank
turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_commandRun organization workspace Flowpipe pipeline command
turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_getGet org workspace pipeline
turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_listList organization workspace pipelines
turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_list_triggersGet org workspace pipeline triggers
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_commandRun organization workspace Flowpipe trigger command
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_createCreate org workspace trigger
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_deleteDelete org workspace pipeline
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_getGet org workspace flowpipe trigger
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_listList organization workspace triggers
turbot_pipes_pipelines_org_workspace_flowpipe_trigger_updateUpdate org workspace trigger
turbot_pipes_pipelines_org_workspace_mod_getGet organization workspace installed mod
turbot_pipes_pipelines_org_workspace_mod_installInstall a mod to an organization workspace
turbot_pipes_pipelines_org_workspace_mod_listList organization workspace installed mods
turbot_pipes_pipelines_org_workspace_mod_uninstallUninstall mod from organization workspace.
turbot_pipes_pipelines_org_workspace_mod_updateUpdate a mod in an organization workspace
turbot_pipes_pipelines_org_workspace_pipeline_commandRun org workspace pipeline command
turbot_pipes_pipelines_org_workspace_pipeline_createCreate org workspace pipeline
turbot_pipes_pipelines_org_workspace_pipeline_deleteDelete org workspace pipeline
turbot_pipes_pipelines_org_workspace_pipeline_getGet org workspace pipeline
turbot_pipes_pipelines_org_workspace_pipeline_listList org workspace pipelines
turbot_pipes_pipelines_org_workspace_pipeline_updateUpdate org workspace pipeline

turbot_pipes_pipelines_org_workspace_datatank_create

Create org workspace Datatank Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org where we want to create the workspace Datatank.
workspace_handlestringYesThe handle of the workspace.
descriptionstringNodescription
desired_statestringNodesired_state
handlestringYeshandle

turbot_pipes_pipelines_org_workspace_datatank_delete

Delete org workspace Datatank Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org.
workspace_handlestringYesThe handle of the workspace.
datatank_handlestringYesThe name of the workspace Datatank to be deleted.

turbot_pipes_pipelines_org_workspace_datatank_get

Get org workspace Datatank Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org.
workspace_handlestringYesThe handle of the workspace.
datatank_handlestringYesThe name of the workspace Datatank.

turbot_pipes_pipelines_org_workspace_datatank_list

List org workspace Datatank Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org for which we want to list the workspace Datatank.
workspace_handlestringYesThe handle of the workspace.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_pipelines_org_workspace_datatank_table_create

Create org workspace Datatank table Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org where we want to create the workspace Datatank table.
workspace_handlestringYesThe handle of the workspace.
datatank_handlestringYesThe name of the Datatank.
descriptionstringNodescription
desired_statestringNodesired_state
frequencyobjectNofrequency
namestringYesname
part_perstringNopart_per
skip_initial_refreshbooleanNoskip_initial_refresh
source_querystringNosource_query
source_schemastringNosource_schema
source_tablestringNosource_table
typestringYestype

turbot_pipes_pipelines_org_workspace_datatank_table_delete

Delete org workspace Datatank table Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org.
workspace_handlestringYesThe handle of the workspace.
datatank_handlestringYesThe name of the workspace Datatank to be deleted.
datatank_table_namestringYesThe name of the workspace Datatank table.

turbot_pipes_pipelines_org_workspace_datatank_table_get

Get org workspace Datatank table Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org where we want to create the workspace Datatank table.
workspace_handlestringYesThe handle of the workspace.
datatank_handlestringYesThe name of the workspace Datatank.
datatank_table_namestringYesThe name of the workspace Datatank table.

turbot_pipes_pipelines_org_workspace_datatank_table_list

List org workspace Datatank tables Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the user for which we want to list the workspace Datatank tables.
workspace_handlestringYesThe handle of the workspace.
datatank_handlestringYesThe name of the Datatank.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_pipelines_org_workspace_datatank_table_update

Update org workspace Datatank table Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org for which we want to list the workspace Datatank.
workspace_handlestringYesThe handle of the workspace.
datatank_handlestringYesThe name of the workspace Datatank.
datatank_table_namestringYesThe name of the workspace Datatank table to be updated.
descriptionstringNodescription
desired_statestringNodesired_state
frequencyobjectNofrequency
namestringNoname
skip_initial_refreshbooleanNoskip_initial_refresh
source_querystringNosource_query
source_schemastringNosource_schema

turbot_pipes_pipelines_org_workspace_datatank_update

Update org workspace Datatank Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org.
workspace_handlestringYesThe handle of the workspace.
datatank_handlestringYesThe name of the workspace Datatank.
descriptionstringNodescription
desired_statestringNodesired_state

turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_command

Run organization workspace Flowpipe pipeline command Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace where the Flowpipe pipeline exists.
pipeline_namestringYesIdentifier of the Flowpipe pipeline on which the command will be run.
argsobjectNoargs
commandstringYescommand

turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_get

Get org workspace pipeline Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace where the pipeline exists.
pipeline_idstringYesThe id of the pipeline whose detail needs to be fetched.

turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_list

List organization workspace pipelines Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace for which we want to list the pipelines.
wherestringNoThe SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_pipelines_org_workspace_flowpipe_pipeline_list_triggers

Get org workspace pipeline triggers Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org which contains the workspace.
workspace_handlestringYesThe handle of the workspace where the pipeline exists.
pipeline_idstringYesThe id of the pipeline whose triggers need to be fetched.
wherestringNoThe SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_pipelines_org_workspace_flowpipe_trigger_command

Run organization workspace Flowpipe trigger command Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace where the Flowpipe trigger exists.
trigger_namestringYesIdentifier of the Flowpipe trigger on which the command will be run.
argsobjectNoargs
commandstringYescommand

turbot_pipes_pipelines_org_workspace_flowpipe_trigger_create

Create org workspace trigger Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org which contains the workspace.
workspace_handlestringYesThe handle of the workspace where we want to create the trigger.
argsobjectYesA map of arguments to be passed to be trigger.
descriptionstringNoOptional description for the trigger.
namestringNoThe name of the trigger, has to be unique in a workspace.
pipelinestringYesThe name / identifier of the pipeline which needs to be triggered.
scheduleobjectYesschedule
statestringNoThe state of the trigger.
titlestringNoOptional title for the trigger.

turbot_pipes_pipelines_org_workspace_flowpipe_trigger_delete

Delete org workspace pipeline Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace where the pipeline exists.
trigger_namestringYesThe name of the trigger which needs to be deleted.

turbot_pipes_pipelines_org_workspace_flowpipe_trigger_get

Get org workspace flowpipe trigger Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org which contains the workspace.
workspace_handlestringYesThe handle of the workspace where the trigger exists.
trigger_namestringYesThe name of the flowpipe trigger whose details needs to be fetched.

turbot_pipes_pipelines_org_workspace_flowpipe_trigger_list

List organization workspace triggers Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace for which we want to list the triggers.
wherestringNoThe SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_pipelines_org_workspace_flowpipe_trigger_update

Update org workspace trigger Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the org which contains the workspace.
workspace_handlestringYesThe handle of the workspace where the trigger exists.
trigger_namestringYesThe name of the trigger which needs to be updated.
argsobjectNoA map of arguments to be passed to be trigger.
descriptionstringNoOptional description for the trigger.
namestringNoThe name of the trigger.
scheduleobjectNoschedule
statestringNoThe desired state of the trigger.
titlestringNoOptional title for the trigger.

turbot_pipes_pipelines_org_workspace_mod_get

Get organization workspace installed mod Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of an organization that owns the workspace.
workspace_handlestringYesThe handle of the workspace where mod was installed.
mod_aliasstringYesThe mod alias or mod ID

turbot_pipes_pipelines_org_workspace_mod_install

Install a mod to an organization workspace Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of an organization that owns the workspace.
workspace_handlestringYesThe handle of the workspace where the mod will be installed.
branchstringNobranch
constraintstringNoconstraint
integration_handlestringNointegration_handle
pathstringNopath
versionstringNoversion

turbot_pipes_pipelines_org_workspace_mod_list

List organization workspace installed mods Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of an organization that owns the workspace.
workspace_handlestringYesThe handle of the workspace where mods were installed
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_pipelines_org_workspace_mod_uninstall

Uninstall mod from organization workspace. Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of an organization that owns the workspace.
workspace_handlestringYesThe handle of the workspace where the mod was installed.
mod_aliasstringYesThe mod alias or mod ID to delete.

turbot_pipes_pipelines_org_workspace_mod_update

Update a mod in an organization workspace Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of an organization that owns the workspace.
workspace_handlestringYesThe handle of the workspace where the mod will be updated.
mod_aliasstringYesThe mod alias or mod ID to update.
branchstringNobranch
constraintstringNoconstraint
versionstringNoversion

turbot_pipes_pipelines_org_workspace_pipeline_command

Run org workspace pipeline command Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace where the pipeline exists.
pipeline_idstringYesId of the pipeline on which the command will be run.
argsobjectNoargs
commandstringYescommand

turbot_pipes_pipelines_org_workspace_pipeline_create

Create org workspace pipeline Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace where we want to create the pipeline.
argsobjectYesargs
desired_statestringNoThe desired state of the pipeline.
frequencyobjectYesfrequency
pipelinestringYesThe name of the pipeline to be executed.
tagsobjectNotags
titlestringYesThe title of the pipeline.

turbot_pipes_pipelines_org_workspace_pipeline_delete

Delete org workspace pipeline Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace where the pipeline exists.
pipeline_idstringYesProvide the id of the pipeline which needs to be deleted.

turbot_pipes_pipelines_org_workspace_pipeline_get

Get org workspace pipeline Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace where the pipeline exists.
pipeline_idstringYesThe id of the pipeline whose detail needs to be fetched.

turbot_pipes_pipelines_org_workspace_pipeline_list

List org workspace pipelines Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace for which we want to list the pipelines.
wherestringNoThe SQL where filter you wish to apply to this request. The filter will be parsed and sanitised and checked against the supported columns for this API.
limitintegerNoThe max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
next_tokenstringNoWhen list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.

turbot_pipes_pipelines_org_workspace_pipeline_update

Update org workspace pipeline Parameters:
ParameterTypeRequiredDefaultDescription
org_handlestringYesThe handle of the organization which contains the workspace.
workspace_handlestringYesThe handle of the workspace where the pipeline exists.
pipeline_idstringYesThe id of the pipeline which needs to be updated.
argsobjectNoargs
desired_statestringNoThe desired state of the pipeline.
frequencyobjectNofrequency
tagsobjectNotags
titlestringNoThe title of the pipeline.