turbot-pipes-workspaces

Turbot Pipes Workspaces - manage workspaces, members, schemas, snapshots, and queries

Server path: /turbot-pipes-workspaces | Type: Application | PCID required: Yes

Tools

Tool	Description
turbot_pipes_workspaces_org_workspace_command	Run org workspace command
turbot_pipes_workspaces_org_workspace_create	Create org workspace
turbot_pipes_workspaces_org_workspace_delete	Delete org workspace
turbot_pipes_workspaces_org_workspace_get	Get org workspace
turbot_pipes_workspaces_org_workspace_list	List org workspaces
turbot_pipes_workspaces_org_workspace_list_audit_logs	Org workspace audit logs
turbot_pipes_workspaces_org_workspace_member_create	Create Org Workspace Member
turbot_pipes_workspaces_org_workspace_member_delete	Delete Org Workspace Member
turbot_pipes_workspaces_org_workspace_member_get	Get Org Workspace Member
turbot_pipes_workspaces_org_workspace_member_list	List Organization Workspace Members
turbot_pipes_workspaces_org_workspace_member_update	Update Org Workspace Member
turbot_pipes_workspaces_org_workspace_post_query	Query org workspace
turbot_pipes_workspaces_org_workspace_process_command	Run org workspace process command
turbot_pipes_workspaces_org_workspace_process_get	Get org workspace process
turbot_pipes_workspaces_org_workspace_process_list	List org workspace processes
turbot_pipes_workspaces_org_workspace_process_log	List org workspace process logs
turbot_pipes_workspaces_org_workspace_schema_attach	Attach a schema to an org workspace
turbot_pipes_workspaces_org_workspace_schema_detach	Detach a schema from an org workspace
turbot_pipes_workspaces_org_workspace_schema_get	Get org workspace schema
turbot_pipes_workspaces_org_workspace_schema_get_table	Get org workspace schema table
turbot_pipes_workspaces_org_workspace_schema_list	List org workspace schemas
turbot_pipes_workspaces_org_workspace_schema_list_tables	List org workspace schema tables
turbot_pipes_workspaces_org_workspace_snapshot_create	Create org workspace snapshot
turbot_pipes_workspaces_org_workspace_snapshot_delete	Delete org workspace snapshot
turbot_pipes_workspaces_org_workspace_snapshot_get	Get org workspace snapshot
turbot_pipes_workspaces_org_workspace_snapshot_list	List org workspace snapshots
turbot_pipes_workspaces_org_workspace_snapshot_update	Update org workspace snapshot
turbot_pipes_workspaces_org_workspace_update	Update org workspace

---

turbot_pipes_workspaces_org_workspace_command

Run org workspace command

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org where we want to run the workspace command.
workspace_handle	string	Yes	—	The handle of the workspace where command will be executed.
command	string	Yes	—	The command value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org where we want to run the workspace command."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace where command will be executed."
    },
    "command": {
      "type": "string",
      "description": "The command value"
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "command"
  ]
}

---

turbot_pipes_workspaces_org_workspace_create

Create org workspace

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the organization where we want to create the workspace.
db_volume_size_bytes	integer	No	—	Db Volume Size Bytes
desired_state	string	No	—	paused is not yet supported for Workspace
handle	string	Yes	—	The handle value
instance_type	string	No	—	Instance Type

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the organization where we want to create the workspace."
    },
    "db_volume_size_bytes": {
      "type": "integer",
      "description": "Db Volume Size Bytes"
    },
    "desired_state": {
      "type": "string",
      "description": "paused is not yet supported for Workspace",
      "enum": [
        "enabled",
        "disabled"
      ]
    },
    "handle": {
      "type": "string",
      "description": "The handle value"
    },
    "instance_type": {
      "type": "string",
      "description": "Instance Type",
      "enum": [
        "db1.shared",
        "db1.small",
        "db1.medium"
      ]
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_delete

Delete org workspace

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the organization where the workspace exist.
workspace_handle	string	Yes	—	Provide the handle of the workspace which needs to be deleted.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the organization where the workspace exist."
    },
    "workspace_handle": {
      "type": "string",
      "description": "Provide the handle of the workspace which needs to be deleted."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_get

Get org workspace

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle for an organization where the workspace exist.
workspace_handle	string	Yes	—	The handle of the workspace whose detail needs to be fetched.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle for an organization where the workspace exist."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace whose detail needs to be fetched."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_list

List org workspaces

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the organization for which we want to list the workspace.
limit	integer	No	—	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.
next_token	string	No	—	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the organization for which we want to list the workspace."
    },
    "limit": {
      "type": "integer",
      "description": "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."
    },
    "next_token": {
      "type": "string",
      "description": "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."
    }
  },
  "required": [
    "PCID",
    "org_handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_list_audit_logs

Org workspace audit logs

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	Specify the org handle to get the audit logs.
workspace_handle	string	Yes	—	The handle of the workspace whose logs needs to be fetched.
limit	integer	No	—	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.
next_token	string	No	—	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "Specify the org handle to get the audit logs."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace whose logs needs to be fetched."
    },
    "limit": {
      "type": "integer",
      "description": "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."
    },
    "next_token": {
      "type": "string",
      "description": "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."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_member_create

Create Org Workspace Member

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	Specify the handle of the organization where the member need to be invited.
workspace_handle	string	Yes	—	Specify the handle of the workspace where the member need to be invited.
handle	string	Yes	—	The handle value
role	string	Yes	—	The role value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "Specify the handle of the organization where the member need to be invited."
    },
    "workspace_handle": {
      "type": "string",
      "description": "Specify the handle of the workspace where the member need to be invited."
    },
    "handle": {
      "type": "string",
      "description": "The handle value"
    },
    "role": {
      "type": "string",
      "description": "The role value"
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "handle",
    "role"
  ]
}

---

turbot_pipes_workspaces_org_workspace_member_delete

Delete Org Workspace Member

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	Specify the handle of the organization where the member need to be invited.
workspace_handle	string	Yes	—	Specify the handle of the workspace where the member need to be invited.
user_handle	string	Yes	—	Specify the handle of the user whose information you want to retrive.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "Specify the handle of the organization where the member need to be invited."
    },
    "workspace_handle": {
      "type": "string",
      "description": "Specify the handle of the workspace where the member need to be invited."
    },
    "user_handle": {
      "type": "string",
      "description": "Specify the handle of the user whose information you want to retrive."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "user_handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_member_get

Get Org Workspace Member

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	Specify the handle of the organization where the member need to be invited.
workspace_handle	string	Yes	—	Specify the handle of the workspace where the member need to be invited.
user_handle	string	Yes	—	Specify the handle of the user whose information you want to retrive.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "Specify the handle of the organization where the member need to be invited."
    },
    "workspace_handle": {
      "type": "string",
      "description": "Specify the handle of the workspace where the member need to be invited."
    },
    "user_handle": {
      "type": "string",
      "description": "Specify the handle of the user whose information you want to retrive."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "user_handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_member_list

List Organization Workspace Members

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	Specify the handle of the organization where the member need to be invited.
workspace_handle	string	Yes	—	Specify the handle of the workspace where the member need to be invited.
q	string	No	—	Optional free-text search to filter the org workspace members.
limit	integer	No	—	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.
next_token	string	No	—	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "Specify the handle of the organization where the member need to be invited."
    },
    "workspace_handle": {
      "type": "string",
      "description": "Specify the handle of the workspace where the member need to be invited."
    },
    "q": {
      "type": "string",
      "description": "Optional free-text search to filter the org workspace members."
    },
    "limit": {
      "type": "integer",
      "description": "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."
    },
    "next_token": {
      "type": "string",
      "description": "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."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_member_update

Update Org Workspace Member

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	Specify the handle of the organization where the member need to be invited.
workspace_handle	string	Yes	—	Specify the handle of the workspace where the member need to be invited.
user_handle	string	Yes	—	Specify the handle of the user whose information you want to retrive.
role	string	Yes	—	The role value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "Specify the handle of the organization where the member need to be invited."
    },
    "workspace_handle": {
      "type": "string",
      "description": "Specify the handle of the workspace where the member need to be invited."
    },
    "user_handle": {
      "type": "string",
      "description": "Specify the handle of the user whose information you want to retrive."
    },
    "role": {
      "type": "string",
      "description": "The role value"
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "user_handle",
    "role"
  ]
}

---

turbot_pipes_workspaces_org_workspace_post_query

Query org workspace

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org that the workspace belongs to.
workspace_handle	string	Yes	—	The handle of the workspace to query.
content_type	string	No	—	The required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown.
body	string	Yes	—	The sql query to perform against the org workspace.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org that the workspace belongs to."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace to query."
    },
    "content_type": {
      "type": "string",
      "description": "The required content type for the response. Defaults to application/json. Supported values are json, application/json, csv, text/csv, md and text/markdown."
    },
    "body": {
      "type": "string",
      "description": "The sql query to perform against the org workspace."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "body"
  ]
}

---

turbot_pipes_workspaces_org_workspace_process_command

Run org workspace process command

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org where we want to run the workspace process command.
workspace_handle	string	Yes	—	The handle of the workspace where the process command will be executed.
process_id	string	Yes	—	The id of the process where the command will be executed against.
command	string	Yes	—	The command value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org where we want to run the workspace process command."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace where the process command will be executed."
    },
    "process_id": {
      "type": "string",
      "description": "The id of the process where the command will be executed against."
    },
    "command": {
      "type": "string",
      "description": "The command value"
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "process_id",
    "command"
  ]
}

---

turbot_pipes_workspaces_org_workspace_process_get

Get org workspace process

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org where the workspace exist.
workspace_handle	string	Yes	—	The handle of the workspace whose process needs to be fetched.
process_id	string	Yes	—	The id of the process to be fetched.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org where the workspace exist."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace whose process needs to be fetched."
    },
    "process_id": {
      "type": "string",
      "description": "The id of the process to be fetched."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "process_id"
  ]
}

---

turbot_pipes_workspaces_org_workspace_process_list

List org workspace processes

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of an organization for which you want to list the processes.
workspace_handle	string	Yes	—	The handle of the workspace where you want to list the processes.
where	string	No	—	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.
limit	integer	No	—	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.
next_token	string	No	—	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of an organization for which you want to list the processes."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace where you want to list the processes."
    },
    "where": {
      "type": "string",
      "description": "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."
    },
    "limit": {
      "type": "integer",
      "description": "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."
    },
    "next_token": {
      "type": "string",
      "description": "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."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_process_log

List org workspace process logs

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org for which you want to list process logs.
workspace_handle	string	Yes	—	The handle of the workspace where you want to list the process logs.
process_id	string	Yes	—	The id of the process where you want to list the process logs.
log_file	string	Yes	—	The process logs file to be fetched.
content_type	string	Yes	—	The required content type of the process logs.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org for which you want to list process logs."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace where you want to list the process logs."
    },
    "process_id": {
      "type": "string",
      "description": "The id of the process where you want to list the process logs."
    },
    "log_file": {
      "type": "string",
      "description": "The process logs file to be fetched.",
      "enum": [
        "process"
      ]
    },
    "content_type": {
      "type": "string",
      "description": "The required content type of the process logs.",
      "enum": [
        "jsonl"
      ]
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "process_id",
    "log_file",
    "content_type"
  ]
}

---

turbot_pipes_workspaces_org_workspace_schema_attach

Attach a schema to an org workspace

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org that the workspace belongs to.
workspace_handle	string	Yes	—	The handle of the workspace where the schema will be attached.
aggregator_handle	string	No	—	Aggregator Handle
connection_folder	string	No	—	Connection Folder
connection_handle	string	No	—	Connection Handle

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org that the workspace belongs to."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace where the schema will be attached."
    },
    "aggregator_handle": {
      "type": "string",
      "description": "Aggregator Handle"
    },
    "connection_folder": {
      "type": "string",
      "description": "Connection Folder"
    },
    "connection_handle": {
      "type": "string",
      "description": "Connection Handle"
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_schema_detach

Detach a schema from an org workspace

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org that the workspace belongs to.
workspace_handle	string	Yes	—	The handle of the workspace from which the schema will be detached.
schema_name	string	Yes	—	The name of the schema that will be detached.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org that the workspace belongs to."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace from which the schema will be detached."
    },
    "schema_name": {
      "type": "string",
      "description": "The name of the schema that will be detached."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "schema_name"
  ]
}

---

turbot_pipes_workspaces_org_workspace_schema_get

Get org workspace schema

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org that the workspace belongs to.
workspace_handle	string	Yes	—	The handle of the workspace where the schema exists.
schema_name	string	Yes	—	The name of the schema whose detail needs to be fetched.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org that the workspace belongs to."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace where the schema exists."
    },
    "schema_name": {
      "type": "string",
      "description": "The name of the schema whose detail needs to be fetched."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "schema_name"
  ]
}

---

turbot_pipes_workspaces_org_workspace_schema_get_table

Get org workspace schema table

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org where the workspace belongs to.
workspace_handle	string	Yes	—	The handle of the workspace where the schema exists.
schema_name	string	Yes	—	The name of the schema to which the table belongs.
table_name	string	Yes	—	The name of the table whose detail needs to be fetched.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org where the workspace belongs to."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace where the schema exists."
    },
    "schema_name": {
      "type": "string",
      "description": "The name of the schema to which the table belongs."
    },
    "table_name": {
      "type": "string",
      "description": "The name of the table whose detail needs to be fetched."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "schema_name",
    "table_name"
  ]
}

---

turbot_pipes_workspaces_org_workspace_schema_list

List org workspace schemas

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org that the workspace belongs to.
workspace_handle	string	Yes	—	The handle of the workspace to get the schemas for.
limit	integer	No	—	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.
next_token	string	No	—	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org that the workspace belongs to."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace to get the schemas for."
    },
    "limit": {
      "type": "integer",
      "description": "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."
    },
    "next_token": {
      "type": "string",
      "description": "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."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_schema_list_tables

List org workspace schema tables

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org that the workspace belongs to.
workspace_handle	string	Yes	—	The handle of the workspace where the schema exists.
schema_name	string	Yes	—	The name of the schema whose detail needs to be fetched.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org that the workspace belongs to."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace where the schema exists."
    },
    "schema_name": {
      "type": "string",
      "description": "The name of the schema whose detail needs to be fetched."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "schema_name"
  ]
}

---

turbot_pipes_workspaces_org_workspace_snapshot_create

Create org workspace snapshot

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org to create the workspace snapshot for.
workspace_handle	string	Yes	—	The handle of the org workspace to create the snapshot for.
data	object	Yes	—	The data value
tags	object	No	—	The tags value
title	string	No	—	The title of the snapshot.
visibility	string	No	—	The visibility of the snapshot to create.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org to create the workspace snapshot for."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the org workspace to create the snapshot for."
    },
    "data": {
      "type": "object",
      "description": "The data value",
      "properties": {
        "end_time": {
          "type": "string",
          "description": "The time the dashboard execution ended."
        },
        "inputs": {
          "type": "object",
          "description": "Any inputs and their values used in this snapshot."
        },
        "layout": {
          "type": "object",
          "description": "The layout value"
        },
        "metadata": {
          "type": "object",
          "description": "Any additional metadata for this snapshot."
        },
        "panels": {
          "type": "object",
          "description": "The map of panels and their data for this snapshot."
        },
        "schema_version": {
          "type": "string",
          "description": "The schema version of this snapshot."
        },
        "start_time": {
          "type": "string",
          "description": "The time the dashboard execution started."
        },
        "variables": {
          "type": "object",
          "description": "Any mod variables in scope for this snapshot."
        }
      },
      "required": [
        "end_time",
        "layout",
        "panels",
        "schema_version",
        "start_time"
      ]
    },
    "tags": {
      "description": "The tags value"
    },
    "title": {
      "type": "string",
      "description": "The title of the snapshot."
    },
    "visibility": {
      "type": "string",
      "description": "The visibility of the snapshot to create.",
      "enum": [
        "workspace",
        "anyone_with_link"
      ]
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "data"
  ]
}

---

turbot_pipes_workspaces_org_workspace_snapshot_delete

Delete org workspace snapshot

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org that the workspace snapshot belongs to.
workspace_handle	string	Yes	—	The handle of the org workspace that the snapshot belongs to.
snapshot_id	string	Yes	—	The handle of the snapshot which needs to be deleted.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org that the workspace snapshot belongs to."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the org workspace that the snapshot belongs to."
    },
    "snapshot_id": {
      "type": "string",
      "description": "The handle of the snapshot which needs to be deleted."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "snapshot_id"
  ]
}

---

turbot_pipes_workspaces_org_workspace_snapshot_get

Get org workspace snapshot

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org that the workspace snapshot belongs to.
workspace_handle	string	Yes	—	The handle of the org workspace that the snapshot belongs to.
snapshot_id	string	Yes	—	The handle of the snapshot whose detail needs to be fetched.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org that the workspace snapshot belongs to."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the org workspace that the snapshot belongs to."
    },
    "snapshot_id": {
      "type": "string",
      "description": "The handle of the snapshot whose detail needs to be fetched."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "snapshot_id"
  ]
}

---

turbot_pipes_workspaces_org_workspace_snapshot_list

List org workspace snapshots

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org to list the workspace snapshots for.
workspace_handle	string	Yes	—	The handle of the org workspace to list snapshots for.
where	string	No	—	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.
limit	integer	No	—	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.
next_token	string	No	—	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org to list the workspace snapshots for."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the org workspace to list snapshots for."
    },
    "where": {
      "type": "string",
      "description": "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."
    },
    "limit": {
      "type": "integer",
      "description": "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."
    },
    "next_token": {
      "type": "string",
      "description": "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."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle"
  ]
}

---

turbot_pipes_workspaces_org_workspace_snapshot_update

Update org workspace snapshot

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the org that the workspace snapshot belongs to.
workspace_handle	string	Yes	—	The handle of the org workspace that the snapshot belongs to.
snapshot_id	string	Yes	—	The handle of the snapshot to update.
tags	object	No	—	The tags value
title	string	No	—	The updated title for the snapshot.
visibility	string	No	—	The updated visibility for the snapshot.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the org that the workspace snapshot belongs to."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the org workspace that the snapshot belongs to."
    },
    "snapshot_id": {
      "type": "string",
      "description": "The handle of the snapshot to update."
    },
    "tags": {
      "description": "The tags value"
    },
    "title": {
      "type": "string",
      "description": "The updated title for the snapshot."
    },
    "visibility": {
      "type": "string",
      "description": "The updated visibility for the snapshot.",
      "enum": [
        "workspace",
        "anyone_with_link"
      ]
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle",
    "snapshot_id"
  ]
}

---

turbot_pipes_workspaces_org_workspace_update

Update org workspace

Parameters:

Parameter	Type	Required	Default	Description
org_handle	string	Yes	—	The handle of the organization where the workspace exist.
workspace_handle	string	Yes	—	The handle of the workspace which needs to be updated.
db_volume_size_bytes	integer	No	—	Db Volume Size Bytes
desired_state	string	No	—	paused is not yet supported for Workspace
handle	string	No	—	The handle value
instance_type	string	No	—	the updated instance type of the workspace
search_path_prefix	string[]	No	—	Optionally update the search path prefix for the Steampipe DB.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "org_handle": {
      "type": "string",
      "description": "The handle of the organization where the workspace exist."
    },
    "workspace_handle": {
      "type": "string",
      "description": "The handle of the workspace which needs to be updated."
    },
    "db_volume_size_bytes": {
      "type": "integer",
      "description": "Db Volume Size Bytes"
    },
    "desired_state": {
      "type": "string",
      "description": "paused is not yet supported for Workspace",
      "enum": [
        "enabled",
        "disabled"
      ]
    },
    "handle": {
      "type": "string",
      "description": "The handle value"
    },
    "instance_type": {
      "type": "string",
      "description": "the updated instance type of the workspace",
      "enum": [
        "db1.shared",
        "db1.small",
        "db1.medium"
      ]
    },
    "search_path_prefix": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optionally update the search path prefix for the Steampipe DB."
    }
  },
  "required": [
    "PCID",
    "org_handle",
    "workspace_handle"
  ]
}