Skip to main content

Cyware Orchestrate

Snowflake

App Vendor: Snowflake

App Category: DevOps, Datalake and Analytics

Connector Version: 1.0.0

API Version: v2

Note

This app is currently released as a beta version.

About App

The Snowflake SQL API is a rest API that enables security teams to execute SQL queries and manage data in a Snowflake database.

The Snowflake app is configured with Orchestrate to perform the following actions:

Action Name

Description

Cancel Statement Execution 

This action cancels the execution of a statement on Snowflake.

Execute Statement 

This action executes a statement on Snowflake.

Get Statement Status 

This action retrieves the status of a specific statement on Snowflake.

Configuration Parameters

The following configuration parameters are required for the Snowflake app to communicate with the Snowflake enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Base URL 

Enter the base URL to access Snowflake.

Text

Required

API Token 

Enter the API token to authenticate with Snowflake.

Password

Required

User Agent 

Enter the user agent.

Text

Required

JWT 

Choose true to pass JWT token for authentication.

Boolean

Optional

Default value:

false

Verify 

Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection.

Boolean

Optional

By default, verification is enabled.

Timeout 

Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with Snowflake.

Integer

Optional

Allowed Range:

15-120

Default value:

15

Action: Cancel Statement Execution

This action cancels the execution of a statement on Snowflake.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Statement ID 

Enter the ID of a statement to cancel its execution.

Example:

536fad38-b564-4dc5-9892-a4543504df6c

Text

Required

You can retrieve this using the action Execute Statement.

Action: Execute Statement

This action executes a statement on Snowflake.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Payload 

Enter the payload in JSON format. 

Example: 

{"statement":"select * from t where c1=?","timeout":60,"database":"testdb","schema":"testschema","warehouse":"testwh","role":"testrole","bindings":{"1":{"type":"fixed","value":"123"}}}

Key Value

Required

Allowed keys:

statement, timeout, database, schema, warehouse, role, bindings, parameters

Action: Get Statement Status

This action retrieves the status of a specific statement on Snowflake.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Statement ID 

Enter the ID of the statement to retrieve the execution status.

Example:

536fad38-b564-4dc5-9892-a4543504df6c

Text

Required

You can retrieve this using the action Execute Statement.