> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Turbot Pipes

The Turbot Pipes connector lets your AI agent act in each user's Turbot Pipes account. Each user connects their own Turbot Pipes access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** Bearer Token
**Categories:** Developer Tools, Databases
**Tools:** 60: 36 read, 16 write, 8 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=TURBOTPIPES)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Turbot Pipes connection

   In **AgentKit > Connections**, create a Turbot Pipes connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'turbotpipes'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Turbot Pipes:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'turbotpipes_actor_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "turbotpipes"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Turbot Pipes:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="turbotpipes_actor_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Turbot Pipes credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'turbotpipes_actor_get',
  toolInput: {},
  connector: 'turbotpipes',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="turbotpipes_actor_get",
    tool_input={},
    connection_name="turbotpipes",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `turbotpipes_actor_get`

Get Current Actor · Read-only

Get the Turbot Pipes user the API token belongs to.
Returns the user's ID, handle, display name, email and status.
Use this to find your user handle for the identity_handle input.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `turbotpipes_actor_orgs_list`

List My Orgs · Read-only

List the Turbot Pipes organizations the token's user belongs to.
Returns org memberships with the org handle, display name and your role, plus next_token for paging.
Use this to find org handles for the identity_handle input.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{}`

### `turbotpipes_actor_workspaces_list`

List My Workspaces · Read-only

List every Turbot Pipes workspace the token's user can access, across the user and all their orgs.
Returns workspaces with handle, owner identity, state and database details, plus next_token for paging.
Use this to find a workspace across identities. Use turbotpipes_workspaces_list for one identity's workspaces.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{}`

### `turbotpipes_audit_log_list`

List Audit Logs · Read-only

List the audit log of a Turbot Pipes user or org.
Returns audit entries with action type, actor, target, data and time, plus next_token for paging.
Use this for who-did-what across an identity. Use turbotpipes_workspace_audit_log_list for one workspace.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user"}`

### `turbotpipes_connection_get`

Get Connection · Read-only

Get one connection of a Turbot Pipes user or org.
Returns the connection with handle, plugin, config (secrets masked) and timestamps.
Use this for a connection's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `connection_handle` (`string`, required): The handle of the connection whose detail needs to be fetched. Example: aws_prod.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.

Example input: `{"connection_handle":"<connection_handle>","identity_handle":"<identity_handle>","identity_type":"user"}`

### `turbotpipes_connection_test`

Test Connection · Read-only

Test a plugin config for a Turbot Pipes user or org connection for basic connectivity, before you create or update the connection.
Returns the test result with state and any error.
Use this to check credentials. Use turbotpipes_connection_create to save the connection.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `connection_handle` (`string`, required): The handle of the connection to be tested. For connections that are not yet created, use underscore _ as the handle, else pass the handle of the existing connection. Example: aws_prod.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `plugin` (`string`, required): Steampipe plugin name, such as aws or github. Example: aws.
- `config` (`object`, optional): Plugin configuration to test, as a JSON object. Example: {"regions": ["us-east-1"], "access_key": "AKIAEXAMPLE", "secret_key": "example-secret"}

Example input: `{"connection_handle":"<connection_handle>","identity_handle":"<identity_handle>","identity_type":"user","plugin":"<plugin>"}`

### `turbotpipes_connections_list`

List Connections · Read-only

List the connections (plugin credentials) of a Turbot Pipes user or org.
Returns connections with handle, plugin, type and timestamps, plus next_token for paging.
Use this for identity-level connections. Use turbotpipes_workspace_connections_list for a workspace's connections.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user"}`

### `turbotpipes_identities_search`

Search Identities · Read-only

Search Turbot Pipes identities (users and orgs) by text.
Returns matching identities with handle, type and display name.
Use this to look up a user or org handle.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
- `q` (`string`, optional): Optional free-text search to filter the identities. Example: acme.

Example input: `{}`

### `turbotpipes_integrations_list`

List Integrations · Read-only

List the integrations (GitHub, GitLab, Slack and others) of a Turbot Pipes user or org.
Returns integrations with handle, type, state and timestamps, plus next_token for paging.
Use this to find an integration handle, for example for private mod repositories.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user"}`

### `turbotpipes_org_members_list`

List Org Members · Read-only

List the members of a Turbot Pipes organization.
Returns members with user handle, display name, email, role and status, plus next_token for paging.
Use this to see who is in an org. Use turbotpipes_org_workspace_members_list for one workspace.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `org_handle` (`string`, required): Specify the organization handle. Example: acme.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
- `q` (`string`, optional): Optional free-text search to filter the org members. Example: acme.

Example input: `{"org_handle":"<org_handle>"}`

### `turbotpipes_org_workspace_members_list`

List Org Workspace Members · Read-only

List the members of a workspace that belongs to a Turbot Pipes organization.
Returns members with user handle, role and status, plus next_token for paging.
Use this to see who can access an org workspace.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `org_handle` (`string`, required): Specify the handle of the organization where the member need to be invited. Example: acme.
- `workspace_handle` (`string`, required): Specify the handle of the workspace where the member need to be invited. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
- `q` (`string`, optional): Optional free-text search to filter the org workspace members. Example: acme.

Example input: `{"org_handle":"<org_handle>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_usage_list`

List Usage · Read-only

List the metered usage of a Turbot Pipes user or org.
Returns usage records with type, workspace, amount and time, plus next_token for paging.
Use this to check consumption by workspace.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
- `where` (`string`, optional): The 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. Example: state = 'finished'.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user"}`

### `turbotpipes_workspace_audit_log_list`

List Workspace Audit Logs · Read-only

List the audit log of a Turbot Pipes workspace.
Returns audit entries with action type, actor, target, data and time, plus next_token for paging.
Use this for changes in one workspace.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace whose logs needs to be fetched. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_connection_get`

Get Workspace Connection · Read-only

Get one connection association of a Turbot Pipes workspace.
Returns the association with the connection details.
Use this for a workspace connection's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `connection_handle` (`string`, required): The handle of the connection whose association details needs to be fetched. Example: aws_prod.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace where the connection exist. Example: dev.

Example input: `{"connection_handle":"<connection_handle>","identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_connections_list`

List Workspace Connections · Read-only

List the connections associated with a Turbot Pipes workspace.
Returns the associations with the connection handle, plugin and workspace, plus next_token for paging.
Use this to see which connections a workspace uses.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace where you want to list the associations. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_datatank_get`

Get Workspace Datatank · Read-only

Get one Datatank of a Turbot Pipes workspace.
Returns the Datatank with handle, description, state and timestamps.
Use this for a Datatank's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `datatank_handle` (`string`, required): The name of the workspace Datatank. Example: aws_cache.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace. Example: dev.

Example input: `{"datatank_handle":"<datatank_handle>","identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_datatank_tables_list`

List Workspace Datatank Tables · Read-only

List the tables of a Turbot Pipes workspace Datatank.
Returns tables with name, type, source query, frequency, state and last update.
Use this to see what a Datatank stores.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `datatank_handle` (`string`, required): The name of the Datatank. Example: aws_cache.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{"datatank_handle":"<datatank_handle>","identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_datatanks_list`

List Workspace Datatanks · Read-only

List the Datatanks of a Turbot Pipes workspace; a Datatank stores query results as tables for faster queries.
Returns Datatanks with handle, description, state and timestamps, plus next_token for paging.
Use this to find Datatanks. Use turbotpipes_workspace_datatank_tables_list for their tables.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_flowpipe_pipeline_get`

Get Flowpipe Pipeline · Read-only

Get one Flowpipe pipeline of a Turbot Pipes workspace.
Returns the pipeline with name, title, description, parameters and mod.
Use this to see a pipeline's parameters before running it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `pipeline_id` (`string`, required): The id of the pipeline whose detail needs to be fetched. Example: pipe_cg7l1m5d4cq1rr6j1fi0.
- `workspace_handle` (`string`, required): The handle of the workspace where the pipeline exists. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","pipeline_id":"<pipeline_id>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_flowpipe_pipelines_list`

List Flowpipe Pipelines · Read-only

List the Flowpipe pipelines available in a Turbot Pipes workspace from its installed Flowpipe mods.
Returns pipelines with ID, name, title, description and parameters, plus next_token for paging.
Use this to find a Flowpipe pipeline to run with turbotpipes_workspace_flowpipe_pipeline_run.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace for which we want to list the pipelines. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
- `where` (`string`, optional): The 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. Example: state = 'finished'.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_get`

Get Workspace · Read-only

Get one Turbot Pipes workspace.
Returns the workspace with handle, state, instance type, database name and host, search path and timestamps.
Use this for a workspace's details. Use turbotpipes_workspace_query to run SQL in it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace whose detail needs to be fetched. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_mod_get`

Get Workspace Mod · Read-only

Get one mod installed in a Turbot Pipes workspace.
Returns the mod with alias, path, constraint, installed version and state.
Use this for a mod's details. Use turbotpipes_workspace_mod_variables_list for its variables.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `mod_alias` (`string`, required): The mod alias or mod ID. Example: aws_compliance.
- `workspace_handle` (`string`, required): The handle of the workspace where mod was installed. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","mod_alias":"<mod_alias>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_mod_variables_list`

List Workspace Mod Variables · Read-only

List the variables of a mod in a Turbot Pipes workspace, with their defaults and settings.
Returns variables with name, type, description, default and the workspace setting.
Use this before setting a variable with turbotpipes_workspace_mod_variable_set.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `mod_alias` (`string`, required): The mod alias or mod ID for which we want the variables to be listed. Example: aws_compliance.
- `workspace_handle` (`string`, required): The handle of the workspace where the mod was installed. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","mod_alias":"<mod_alias>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_mods_list`

List Workspace Mods · Read-only

List the Powerpipe mods installed in a Turbot Pipes workspace.
Returns mods with alias, path, version constraint, installed version and state.
Use this to see installed mods. Use turbotpipes_workspace_mod_install to add one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace where mods were installed. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_pipeline_get`

Get Workspace Pipeline · Read-only

Get one scheduled pipeline of a Turbot Pipes workspace.
Returns the pipeline with title, type, args, frequency, state and last process.
Use this for a pipeline's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `pipeline_id` (`string`, required): The id of the pipeline whose detail needs to be fetched. Example: pipe_cg7l1m5d4cq1rr6j1fi0.
- `workspace_handle` (`string`, required): The handle of the workspace where the pipeline exists. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","pipeline_id":"<pipeline_id>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_pipelines_list`

List Workspace Pipelines · Read-only

List the scheduled pipelines of a Turbot Pipes workspace, such as dashboard and query snapshot schedules.
Returns pipelines with ID, title, pipeline type, frequency, state and last process, plus next_token for paging.
Use this to see scheduled jobs. Use turbotpipes_workspace_pipeline_get for one pipeline.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace for which we want to list the pipelines. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
- `where` (`string`, optional): The 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. Example: state = 'finished'.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_process_get`

Get Workspace Process · Read-only

Get one process of a Turbot Pipes workspace.
Returns the process with type, state, pipeline and timestamps.
Use this to check whether a run or command finished.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `process_id` (`string`, required): The id of the process to be fetched. Example: p_cg7l1m5d4cq1rr6j1fi0.
- `workspace_handle` (`string`, required): The handle of the workspace whose process needs to be fetched. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","process_id":"<process_id>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_processes_list`

List Workspace Processes · Read-only

List the processes (pipeline runs, mod installs, workspace commands) of a Turbot Pipes workspace.
Returns processes with ID, type, state, pipeline and timestamps, plus next_token for paging.
Use this to check recent jobs. Filter with where, such as state = 'failed'.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace where you want to list the processes. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
- `where` (`string`, optional): The 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. Example: state = 'finished'.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_query`

Query Workspace · Read-only

Run a SQL query against a Turbot Pipes workspace's Steampipe database, up to 5,000 rows or 30 seconds.
Returns the columns and rows of the result.
Use this to query cloud and SaaS data through the workspace's connections. Use turbotpipes_workspace_schema_tables_list to find tables.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `sql` (`string`, required): The sql query to perform against the workspace. Example: select name, region from aws_s3_bucket limit 10.
- `workspace_handle` (`string`, required): The handle of the workspace to query. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","sql":"<sql>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_schema_get`

Get Workspace Schema · Read-only

Get one schema attached to a Turbot Pipes workspace.
Returns the schema with name, type and its connection or aggregator.
Use this for a schema's details. Use turbotpipes_workspace_schema_tables_list for its tables.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `schema_name` (`string`, required): The name of the schema whose detail needs to be fetched. Example: aws_prod.
- `workspace_handle` (`string`, required): The handle of the workspace where the schema exists. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","schema_name":"<schema_name>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_schema_table_get`

Get Workspace Schema Table · Read-only

Get one table in a schema of a Turbot Pipes workspace.
Returns the table with its description and columns (name, type, description).
Use this to see a table's columns before writing a query.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `schema_name` (`string`, required): The name of the schema to which the table belongs. Example: aws_prod.
- `table_name` (`string`, required): The name of the table whose detail needs to be fetched. Example: aws_s3_bucket.
- `workspace_handle` (`string`, required): The handle of the workspace where the schema exists. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","schema_name":"<schema_name>","table_name":"<table_name>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_schema_tables_list`

List Workspace Schema Tables · Read-only

List the tables in a schema of a Turbot Pipes workspace.
Returns tables with name and description.
Use this to find tables to query. Use turbotpipes_workspace_schema_table_get for a table's columns.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `schema_name` (`string`, required): The name of the schema whose detail needs to be fetched. Example: aws_prod.
- `workspace_handle` (`string`, required): The handle of the workspace where the schema exists. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","schema_name":"<schema_name>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_schemas_list`

List Workspace Schemas · Read-only

List the schemas attached to a Turbot Pipes workspace, one per connection or aggregator.
Returns schemas with name, type and the connection or aggregator they come from.
Use this to see what data a workspace can query.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace to get the schemas for. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_snapshot_get`

Get Workspace Snapshot · Read-only

Get one snapshot of a Turbot Pipes workspace.
Returns the snapshot metadata with title, dashboard, visibility, tags and the user who created it.
Use this for a snapshot's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `snapshot_id` (`string`, required): The handle of the snapshot whose detail needs to be fetched. Example: snap_cg7l1m5d4cq1rr6j1fi0_4z9k8ugh8oz0ijexqv1t0xx3o.
- `workspace_handle` (`string`, required): The handle of the workspace that the snapshot belongs to. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","snapshot_id":"<snapshot_id>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_snapshots_list`

List Workspace Snapshots · Read-only

List the dashboard and query snapshots of a Turbot Pipes workspace.
Returns snapshots with ID, title, dashboard name, visibility, tags and timestamps, plus next_token for paging.
Use this to find snapshots. Use turbotpipes_workspace_snapshot_get for one snapshot.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace to list snapshots for. Example: dev.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.
- `where` (`string`, optional): The 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. Example: state = 'finished'.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspaces_list`

List Workspaces · Read-only

List the workspaces of a Turbot Pipes user or org.
Returns workspaces with handle, state, instance type, database host and timestamps, plus next_token for paging.
Use this for one identity's workspaces. Use turbotpipes_actor_workspaces_list for all of yours.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `limit` (`integer`, optional): The 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. Example: 25.
- `next_token` (`string`, optional): When 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. Example: eyJpZCI6InNuYXBfY2c3bDFtNWQ0Y3ExcnI2ajFmaTAifQ.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user"}`

### `turbotpipes_connection_create`

Create Connection · Write

Create a connection (a Steampipe plugin with its config) for a Turbot Pipes user or org.
Returns the new connection.
Use this to add credentials for a plugin such as aws or github. Use turbotpipes_workspace_connection_create to create one directly in a workspace.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `handle` (`string`, required): Connection handle: lowercase letters, numbers and underscores; it becomes the schema name. Example: aws_prod.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `plugin` (`string`, required): Steampipe plugin name, such as aws, azure, gcp, github or slack. Example: aws.
- `config` (`object`, optional): Plugin configuration as a JSON object, with the same keys as the plugin's Steampipe connection config. Example: {"regions": ["us-east-1"], "access_key": "AKIAEXAMPLE", "secret_key": "example-secret"}
- `mode` (`string`, optional): The mode of this request. Example: available. One of: `available`.
- `parent_id` (`string`, optional): ID of the connection folder to create it in. Example: cf_cg7l1m5d4cq1rr6j1fi0.

Example input: `{"handle":"<handle>","identity_handle":"<identity_handle>","identity_type":"user","plugin":"<plugin>"}`

### `turbotpipes_connection_update`

Update Connection · Write

Update a connection of a Turbot Pipes user or org: rename it, change its config or move it to a folder.
Returns the updated connection.
Use this to rotate credentials or change plugin settings.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `connection_handle` (`string`, required): The handle of the connection which needs to be updated. Example: aws_prod.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `config` (`object`, optional): New plugin configuration as a JSON object. Example: {"regions": ["us-east-1", "eu-west-1"]}
- `handle` (`string`, optional): New connection handle. Example: aws_production.
- `mode` (`string`, optional): The mode of this request. Example: available. One of: `available`.
- `parent_id` (`string`, optional): ID of the connection folder to move it to. Example: cf_cg7l1m5d4cq1rr6j1fi0.

Example input: `{"connection_handle":"<connection_handle>","identity_handle":"<identity_handle>","identity_type":"user"}`

### `turbotpipes_workspace_command`

Run Workspace Command · Write

Run a command on a Turbot Pipes workspace: reboot, stop, start or upgrade its database.
Returns the command and the ID of the process that runs it.
Use this to restart or upgrade a workspace. Use turbotpipes_workspace_process_get to follow the process.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `command` (`string`, required): Command to run: reboot, stop, start or upgrade. Example: reboot. One of: `reboot`, `stop`, `start`, `upgrade`.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace where command will be executed. Example: dev.

Example input: `{"command":"reboot","identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_connection_create`

Add Workspace Connection · Write

Create a connection in a Turbot Pipes workspace, or associate the identity's existing connection with the workspace.
Returns the workspace connection association.
Use this to give a workspace access to a plugin. Use turbotpipes_connection_create for an identity-level connection.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `handle` (`string`, required): Connection handle; use the handle of an existing identity connection to associate it. Example: aws_prod.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `plugin` (`string`, required): Steampipe plugin name, such as aws or github. Example: aws.
- `workspace_handle` (`string`, required): The handle of the workspace where the connection will be created / associated. Example: dev.
- `config` (`object`, optional): Plugin configuration as a JSON object, for a new connection. Example: {"regions": ["us-east-1"]}
- `parent_id` (`string`, optional): ID of the connection folder to create it in. Example: cf_cg7l1m5d4cq1rr6j1fi0.

Example input: `{"handle":"<handle>","identity_handle":"<identity_handle>","identity_type":"user","plugin":"<plugin>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_create`

Create Workspace · Write

Create a workspace for a Turbot Pipes user or org (an org can have up to 10).
Returns the new workspace with its handle and state.
Use this to add a workspace. Use turbotpipes_workspace_update to change one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `handle` (`string`, required): Workspace handle: lowercase letters, numbers and hyphens, unique for the identity. Example: dev.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `desired_state` (`string`, optional): Desired state: enabled or disabled. Example: enabled. One of: `enabled`, `disabled`.
- `instance_type` (`string`, optional): Database instance size: db1.shared, db1.small or db1.medium. Example: db1.shared. One of: `db1.shared`, `db1.small`, `db1.medium`.

Example input: `{"handle":"<handle>","identity_handle":"<identity_handle>","identity_type":"user"}`

### `turbotpipes_workspace_flowpipe_pipeline_run`

Run Flowpipe Pipeline · Write

Run a Flowpipe pipeline in a Turbot Pipes workspace.
Returns the command and the ID of the process that runs it.
Use this to start an automation. Use turbotpipes_workspace_process_get to follow it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `pipeline_name` (`string`, required): Identifier of the Flowpipe pipeline on which the command will be run. Example: mod.pipeline.notify_slack.
- `workspace_handle` (`string`, required): The handle of the workspace where the Flowpipe pipeline exists. Example: dev.
- `args` (`object`, optional): Pipeline parameters as a JSON object. Example: {"message": "Deploy finished"}

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","pipeline_name":"<pipeline_name>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_mod_install`

Install Workspace Mod · Write

Install a mod, such as a compliance or insights mod, into a Turbot Pipes workspace.
Returns the installed mod with its alias and state.
Use this to add dashboards and benchmarks. Use turbotpipes_workspace_mod_update to change its version.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `path` (`string`, required): Mod repository path. Example: github.com/turbot/steampipe-mod-aws-compliance.
- `workspace_handle` (`string`, required): The handle of the workspace where the mod will be installed. Example: dev.
- `branch` (`string`, optional): Git branch to install from. Example: main.
- `constraint` (`string`, optional): Version constraint, such as ^1.0 or latest. Example: ^1.0.
- `integration_handle` (`string`, optional): Handle of a GitHub or GitLab integration, for private mod repositories. Example: github_acme.
- `version` (`string`, optional): Exact version to install. Example: 1.2.0.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","path":"<path>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_mod_update`

Update Workspace Mod · Write

Change the version, constraint or branch of a mod in a Turbot Pipes workspace.
Returns the updated mod.
Use this to upgrade or pin a mod.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `mod_alias` (`string`, required): The mod alias or mod ID to update. Example: aws_compliance.
- `workspace_handle` (`string`, required): The handle of the workspace where the mod will be updated. Example: dev.
- `branch` (`string`, optional): Git branch. Example: main.
- `constraint` (`string`, optional): New version constraint. Example: ^2.0.
- `version` (`string`, optional): Exact version. Example: 2.0.1.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","mod_alias":"<mod_alias>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_mod_variable_set`

Set Workspace Mod Variable · Write

Create a setting for a mod variable in a Turbot Pipes workspace.
Returns the variable with its new setting.
Use this for a variable that has no setting yet. Use turbotpipes_workspace_mod_variable_update to change an existing setting.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `mod_alias` (`string`, required): The mod alias or mod ID for which the variable setting is to be created. Example: aws_compliance.
- `name` (`string`, required): Variable name. Example: common_dimensions.
- `setting` (`string`, required): Value for the variable, as JSON text: a string in quotes, a number, a list or an object. Example: ["account_id", "region"]
- `workspace_handle` (`string`, required): The handle of the workspace where the mod was installed. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","mod_alias":"<mod_alias>","name":"<name>","setting":"<setting>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_mod_variable_update`

Update Workspace Mod Variable · Write

Update the setting of a mod variable in a Turbot Pipes workspace.
Returns the variable with its new setting.
Use this to change a variable already set.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `mod_alias` (`string`, required): The mod alias or mod ID which contains the variable. Example: aws_compliance.
- `setting` (`string`, required): New value for the variable, as JSON text: a string in quotes, a number, a list or an object. Example: ["account_id", "region"]
- `variable_name` (`string`, required): The name of the variable for which setting is to be updated. Example: common_dimensions.
- `workspace_handle` (`string`, required): The handle of the workspace where the mod was installed. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","mod_alias":"<mod_alias>","setting":"<setting>","variable_name":"<variable_name>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_pipeline_create`

Create Workspace Pipeline · Write

Create a scheduled pipeline in a Turbot Pipes workspace that snapshots a dashboard or query on an interval, cron schedule or manually.
Returns the new pipeline with its ID.
Use this to schedule snapshots. Use turbotpipes_workspace_pipeline_run to run it now.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `args` (`object`, required): Arguments for the pipeline, such as the resource (dashboard name), inputs and snapshot tags. Example: {"resource": "aws_compliance.benchmark.cis_v300", "snapshot_tags": {"source": "pipes"}}
- `frequency` (`object`, required): When it runs: an object with type (interval, cron or manual) and, for interval or cron, a schedule such as daily or a cron expression. Example: {"type": "interval", "schedule": "daily"}
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `pipeline` (`string`, required): Pipeline to run: pipeline.snapshot_dashboard or pipeline.snapshot_query. Example: pipeline.snapshot_dashboard. One of: `pipeline.snapshot_dashboard`, `pipeline.snapshot_query`.
- `title` (`string`, required): Pipeline title. Example: Daily S3 compliance snapshot.
- `workspace_handle` (`string`, required): The handle of the workspace where we want to create the pipeline. Example: dev.
- `desired_state` (`string`, optional): Desired state: enabled or disabled. Example: enabled. One of: `enabled`, `disabled`.
- `tags` (`object`, optional): Tags as a JSON object. Example: {"team": "security"}

Example input: `{"args":{"message":"Deploy finished"},"frequency":{"type":"interval","schedule":"daily"},"identity_handle":"<identity_handle>","identity_type":"user","pipeline":"pipeline.snapshot_dashboard","title":"<title>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_pipeline_run`

Run Workspace Pipeline · Write

Run a scheduled pipeline of a Turbot Pipes workspace now.
Returns the command and the ID of the process that runs it.
Use this to take a snapshot on demand. Use turbotpipes_workspace_process_get to follow the run.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `pipeline_id` (`string`, required): Id of the pipeline on which the command will be run. Example: pipe_cg7l1m5d4cq1rr6j1fi0.
- `workspace_handle` (`string`, required): The handle of the workspace where the pipeline exists. Example: dev.
- `args` (`object`, optional): Arguments that override the pipeline's own for this run. Example: {}

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","pipeline_id":"<pipeline_id>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_pipeline_update`

Update Workspace Pipeline · Write

Update a scheduled pipeline in a Turbot Pipes workspace: title, arguments, schedule, state or tags.
Returns the updated pipeline.
Use this to pause, reschedule or change a pipeline.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `pipeline_id` (`string`, required): The id of the pipeline which needs to be updated. Example: pipe_cg7l1m5d4cq1rr6j1fi0.
- `workspace_handle` (`string`, required): The handle of the workspace where the pipeline exists. Example: dev.
- `args` (`object`, optional): New pipeline arguments. Example: {"resource": "aws_compliance.benchmark.cis_v300"}
- `desired_state` (`string`, optional): Desired state: enabled or disabled. Example: enabled. One of: `enabled`, `disabled`.
- `frequency` (`object`, optional): New schedule: an object with type (interval, cron or manual) and schedule. Example: {"type": "cron", "schedule": "0 6 * * 1"}
- `tags` (`object`, optional): Tags as a JSON object. Example: {"team": "security"}
- `title` (`string`, optional): New title. Example: Weekly S3 compliance snapshot.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","pipeline_id":"<pipeline_id>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_schema_attach`

Attach Workspace Schema · Write

Attach an identity-level connection, connection folder or aggregator as a schema in a Turbot Pipes workspace.
Returns the attached schema.
Use this to make an existing connection queryable in a workspace. Set one of connection_handle, connection_folder or aggregator_handle.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace where the schema will be attached. Example: dev.
- `aggregator_handle` (`string`, optional): Handle of an aggregator to attach. Example: aws_all.
- `connection_folder` (`string`, optional): ID of a connection folder to attach. Example: cf_cg7l1m5d4cq1rr6j1fi0.
- `connection_handle` (`string`, optional): Handle of the identity's connection to attach. Example: aws_prod.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_snapshot_update`

Update Workspace Snapshot · Write

Update the title, tags or visibility of a Turbot Pipes workspace snapshot.
Returns the updated snapshot.
Use this to share a snapshot with anyone with the link or rename it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `snapshot_id` (`string`, required): The handle of the snapshot to update. Example: snap_cg7l1m5d4cq1rr6j1fi0_4z9k8ugh8oz0ijexqv1t0xx3o.
- `workspace_handle` (`string`, required): The handle of the workspace that the snapshot belongs to. Example: dev.
- `tags` (`object`, optional): Tags as a JSON object of keys to values. Example: {"team": "security"}
- `title` (`string`, optional): New snapshot title. Example: Weekly S3 compliance.
- `visibility` (`string`, optional): Who can see it: workspace or anyone_with_link. Example: workspace. One of: `workspace`, `anyone_with_link`.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","snapshot_id":"<snapshot_id>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_update`

Update Workspace · Write

Update a Turbot Pipes workspace: rename it, change its instance type, state or search path prefix.
Returns the updated workspace.
Use this to change workspace settings. Use turbotpipes_workspace_command to reboot or upgrade it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace which needs to be updated. Example: dev.
- `desired_state` (`string`, optional): Desired state: enabled or disabled. Example: enabled. One of: `enabled`, `disabled`.
- `handle` (`string`, optional): New workspace handle. Example: dev-2.
- `instance_type` (`string`, optional): New database instance size: db1.shared, db1.small or db1.medium. Example: db1.small. One of: `db1.shared`, `db1.small`, `db1.medium`.
- `search_path_prefix` (`array`, optional): Schemas to put first in the Steampipe search path. Example: ["aws_prod", "aws_dev"]

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_connection_delete`

Delete Connection · Destructive

Delete a connection of a Turbot Pipes user or org; workspaces that use it lose its schema.
Returns the deleted connection.
Use this to remove credentials for good.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `connection_handle` (`string`, required): The handle of the connection that needs to be deleted. Example: aws_prod.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.

Example input: `{"connection_handle":"<connection_handle>","identity_handle":"<identity_handle>","identity_type":"user"}`

### `turbotpipes_workspace_connection_delete`

Remove Workspace Connection · Destructive

Remove a connection from a Turbot Pipes workspace.
Returns the removed association.
Use this to stop a workspace from using a connection.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `connection_handle` (`string`, required): The handle of the connection whose association needs to be deleted. Example: aws_prod.
- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): The handle of the workspace whose association needs to be deleted. Example: dev.

Example input: `{"connection_handle":"<connection_handle>","identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_delete`

Delete Workspace · Destructive

Delete a Turbot Pipes workspace and its database.
Returns the deleted workspace.
Use this only to remove a workspace for good.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `workspace_handle` (`string`, required): Provide the handle of the workspace which needs to be deleted. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_mod_uninstall`

Uninstall Workspace Mod · Destructive

Uninstall a mod from a Turbot Pipes workspace.
Returns the removed mod.
Use this to remove a mod's dashboards and benchmarks.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `mod_alias` (`string`, required): The mod alias or mod ID to delete. Example: aws_compliance.
- `workspace_handle` (`string`, required): The handle of the workspace where the mod was installed. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","mod_alias":"<mod_alias>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_mod_variable_delete`

Delete Workspace Mod Variable · Destructive

Delete the setting of a mod variable in a Turbot Pipes workspace, so the variable uses its default again.
Returns the deleted setting.
Use this to reset a variable.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `mod_alias` (`string`, required): The mod alias or mod ID which contains the variable. Example: aws_compliance.
- `variable_name` (`string`, required): The name of the variable to delete the setting for. Example: common_dimensions.
- `workspace_handle` (`string`, required): The handle of the workspace where the mod was installed. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","mod_alias":"<mod_alias>","variable_name":"<variable_name>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_pipeline_delete`

Delete Workspace Pipeline · Destructive

Delete a scheduled pipeline from a Turbot Pipes workspace.
Returns the deleted pipeline.
Use this to remove a schedule for good. Use turbotpipes_workspace_pipeline_update with desired_state disabled to pause it.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `pipeline_id` (`string`, required): Provide the id of the pipeline which needs to be deleted. Example: pipe_cg7l1m5d4cq1rr6j1fi0.
- `workspace_handle` (`string`, required): The handle of the workspace where the pipeline exists. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","pipeline_id":"<pipeline_id>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_schema_detach`

Detach Workspace Schema · Destructive

Detach a schema from a Turbot Pipes workspace; the connection itself is kept.
Returns the detached schema.
Use this to stop a workspace from querying a connection. Use turbotpipes_connection_delete to delete the connection.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `schema_name` (`string`, required): The name of the schema that will be detached. Example: aws_prod.
- `workspace_handle` (`string`, required): The handle of the workspace from which the schema will be detached. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","schema_name":"<schema_name>","workspace_handle":"<workspace_handle>"}`

### `turbotpipes_workspace_snapshot_delete`

Delete Workspace Snapshot · Destructive

Delete a snapshot from a Turbot Pipes workspace.
Returns the deleted snapshot.
Use this to remove a snapshot for good.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `identity_handle` (`string`, required): Handle of that user or org, as shown in Pipes URLs (pipes.turbot.com/org/<handle>). Use turbotpipes_actor_get for your user handle and turbotpipes_actor_orgs_list for org handles. Example: acme.
- `identity_type` (`string`, required): Whether the identity that owns the resource is a user (your personal identity) or an org. Example: org. One of: `user`, `org`.
- `snapshot_id` (`string`, required): The handle of the snapshot which needs to be deleted. Example: snap_cg7l1m5d4cq1rr6j1fi0_4z9k8ugh8oz0ijexqv1t0xx3o.
- `workspace_handle` (`string`, required): The handle of the workspace that the snapshot belongs to. Example: dev.

Example input: `{"identity_handle":"<identity_handle>","identity_type":"user","snapshot_id":"<snapshot_id>","workspace_handle":"<workspace_handle>"}`

## Related

Other Developer Tools connectors ([all 200](/agentkit/connectors/?category=developer-tools)):

- [GitHub](/agentkit/connectors/github/): Scalekit connector, OAuth, 217 tools
- [Datadog](/agentkit/connectors/datadog/): Scalekit connector, API key, 105 tools
- [Linear](/agentkit/connectors/linear/): Scalekit connector, OAuth, 64 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
