Snowflake
Connect to Snowflake Data Cloud for data warehousing, data lakes, data engineering, data science, and data sharing.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 327 actions:
| Action | Purpose | Parameters |
|---|---|---|
| cortex_analyst_api/post_api_v2_cortex_analyst_feedback | Send a user feedback of Cortex Analyst response | data: { . request_id (string) . positive (boolean) . feedback_message (string) } (object) required |
| cortex_analyst_api/post_api_v2_cortex_analyst_message | Send a data question to the Cortex Analyst | data: { . messages (array) . semantic_model_file (string) . semantic_model (string) . semantic_view (string) . semantic_models (array) . stream (boolean) . operation (string) . warehouse (string) . source (string) . experimental (string) } (object) required |
| cortex_analyst_api/post_api_v2_cortex_analyst_verified_query_suggestions | Generate VQ suggestions for a semantic model | data: { . warehouse (string) . mode (string) . semantic_model (object) . tables (array) . tds_source (array) . sql_source (object) . offset (integer) . limit (integer) . experimental (string) } (object) required |
| cortex_analyst_api/post_api_v2_cortex_analyst_fast_generation | Provides real-time suggestions for improving a given semantic model via a streaming response. | data: { . json_proto (object) } (object) required |
| cortex_analyst_api/post_api_v2_cortex_analyst_pre_selection | Retrieve relevant table information from input data for semantic model generation | data: { . tds_source (array) . warehouse (string) . sql_source (object) . tableau_input (object) . experimental (string) } (object) required |
| cortex_analyst_api/post_api_v2_cortex_analyst_filters_and_metrics_suggestions | Generate suggestions for filters, facts, and metrics on a semantic view/model. | data: { . semantic_model (object) . tables (array) . warehouse (string) . metrics_offset (integer) . metrics_limit (integer) . facts_offset (integer) . facts_limit (integer) . filters_offset (integer) . filters_limit (integer) . experimental (string) } (object) required |
| cortex_analyst_api/post_api_v2_cortex_analyst_agentic_optimizations | List all agentic optimization runs for a given base model | data: { . semantic_model (object) . experimental (string) } (object) required |
| cortex_analyst_api/get_api_v2_cortex_analyst_agentic_optimization | Get the status and state of a specified agentic optimization run | optimization_name (string) |
| cortex_analyst_api/get_api_v2_cortex_analyst_token | Internal endpoint to exchange a Cortex Analyst Oauth token | No parameters |
| cortex_chat_completions_api/post_api_v2_cortex_v1_chat_completions | Perform LLM text completion inference using Chat Completions API format. | data: { . key_0 (boolean) . key_1 (boolean) . key_2 (integer) . key_3 (number) } (object) required |
| cortex_embed_api/post_api_v2_cortex_inference_embed | Perform LLM embedding for input text, similar to the Snowflake Cortex EMBED_TEXT functions. For more details on available functions, see: - EMBED_TEXT_768https://docs.snowflake.com/en/sql-reference/functions/embed_text-snowflake-cortex - EMBED_TEXT_1024https://docs.snowflake.com/en/sql-reference/functions/embed_text_1024-snowflake-cortex | data: { . model (string) . text (array) . provisioned_throughput_id (string) } (object) required |
| cortex_inference_api/get_api_v2_cortex_models | Returns the LLMs available for the current session | data: { . models (array) } (object) required |
| cortex_inference_api/post_api_v2_cortex_inference_complete | Perform LLM text completion inference, similar to snowflake.cortex.Complete. | data: { . model (string) . messages (array) . anthropic (object) . openai (object) . temperature (number) . top_p (integer) . max_tokens (integer) . max_output_tokens (integer) . response_format (object) . guardrails (object) . tools (array) . tool_choice (object) . provisioned_throughput_id (string) . sf-ml-xp-inflight-prompt-action (string) . sf-ml-xp-inflight-prompt-client-id (string) . sf-ml-xp-inflight-prompt-public-key (string) . stream (boolean) } (object) required |
| cortex_messages_api/post_api_v2_cortex_v1_messages | Perform LLM text completion inference using Cortex Messages API format. | data: { . key_0 (string) . key_1 (integer) } (object) required |
| cortex_search_rest_api/get_api_v2_databases_database_schemas_schema_cortex_search_services_name | Fetch a Cortex Search Service. | No parameters |
| cortex_search_rest_api/delete_api_v2_databases_database_schemas_schema_cortex_search_services_name | Delete a cortex search service with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful. | ifExists (string) |
| cortex_search_rest_api/post_api_v2_databases_database_schemas_schema_cortex_search_services_by_service_name_query | Query a Cortex Search Service to get search results. | service_name (string) required data: { . query (string) . multi_index_query (object) . columns (array) . filter (object) . limit (integer) . scoring_config (object) . scoring_profile (string) . experimental (object) } (object) required |
| cortex_search_rest_api/post_api_v2_databases_database_schemas_schema_cortex_search_services_by_service_name_suggest | Suggest from a Cortex Search Service to get auto-complete or contextual suggestions | service_name (string) required data: { . query (string) . columns (array) . limit (integer) } (object) required |
| cortex_search_rest_api/post_api_v2_databases_database_schemas_schema_cortex_search_services_by_name_suspend | Suspends one or both of the indexing or serving targets of a cortex search service. | name (string) required ifExists (string) target (string) |
| cortex_search_rest_api/post_api_v2_databases_database_schemas_schema_cortex_search_services_by_name_resume | Resume the cortex search service | name (string) required ifExists (string) target (string) |
| cortex_search_rest_api/post_api_v2_databases_database_schemas_schema_cortex_search_services_by_name_feedback | Send user feedback for a Cortex Search result | name (string) required data: { . request_id (string) . positive (boolean) . feedback_message (string) } (object) required |
| cortex_search_rest_api/get_api_v2_databases_database_schemas_schema_cortex_search_services | Lists the cortex search services under the database and schema. | like (string) fromName (string) showLimit (string) |
| cortex_search_rest_api/post_api_v2_databases_database_schemas_schema_cortex_search_services | Create a cortex search service, with standard create modifiers as query parameters. See the Cortex Search Service component definition for what is required to be provided in the request body. | createMode (string) data: { . name (string) . search_column (string) . target_lag (object) . warehouse (string) . definition (string) . columns (array) . attribute_columns (array) . comment (string) . indexing_state (string) . serving_state (string) } (object) required |
| account_api/delete_api_v2_accounts_name | Deletes the specified account. If you enable the ifExists parameter, the operation succeeds even if the account does not exist. Otherwise, a 404 failure is returned if the account does not exist. if the drop is unsuccessful. | ifExists (string) gracePeriodInDays (string) |
| account_api/post_api_v2_accounts_by_name_undrop | Restores a dropped account that has not yet been permanently deleted a dropped account that is within its grace period. | name (string) required |
| account_api/get_api_v2_accounts | Lists the accessible accounts. | like (string) showLimit (string) history (string) |
| account_api/post_api_v2_accounts | Creates a account. You must provide the full account definition when creating a account. | data: { . name (string) . admin_name (string) . email (string) . edition (string) . region_group (string) . region (string) . comment (string) . admin_password (string) . admin_rsa_public_key (string) . admin_user_type (string) . first_name (string) . last_name (string) . must_change_password (boolean) . polaris (boolean) } (object) required |
| alert_api/get_api_v2_databases_database_schemas_schema_alerts_name | Fetch an alert | No parameters |
| alert_api/delete_api_v2_databases_database_schemas_schema_alerts_name | Delete an alert | ifExists (string) |
| alert_api/post_api_v2_databases_database_schemas_schema_alerts_by_name_clone | Create a new alert by cloning from the specified resource | name (string) required createMode (string) targetDatabase (string) targetSchema (string) data: { . name (string) . point_of_time (object) } (object) required |
| alert_api/post_api_v2_databases_database_schemas_schema_alerts_by_name_execute | Execute an alert | name (string) required |
| alert_api/get_api_v2_databases_database_schemas_schema_alerts | List alerts | like (string) startsWith (string) showLimit (string) fromName (string) |
| alert_api/post_api_v2_databases_database_schemas_schema_alerts | Create an alert | createMode (string) data: { . name (string) . schedule (object) . condition (string) . action (string) . comment (string) . warehouse (string) } (object) required |
| grant_api/delete_api_v2_grants_grantee_type_grantee_name_securable_type_securable_name_privileges_privilege_grant_option | Endpoint to indicate that the grant option for the privilege listed in the path should be revoked. | deleteMode (string) |
| grant_api/delete_api_v2_grants_grantee_type_grantee_name_securable_type_securable_name_privileges_privilege | Endpoint to indicate that the privilege listed in the path should be revoked. | deleteMode (string) |
| grant_api/post_api_v2_grants_grantee_type_grantee_name_securable_type_securable_name_privileges | Endpoint to indicate that the privileges listed in the request body should be granted. | data: { . privileges (array) . grant_option (boolean) . created_on (string) . grantee_type (string) . grantee_name (string) . securable_type (string) . securable_name (string) . granted_by_role_type (string) . granted_by_name (string) } (object) required |
| grant_api/delete_api_v2_grants_grantee_type_grantee_name_bulk_grant_type_securable_type_plural_scope_type_scope_name_privileges_privilege_grant_option | Endpoint to indicate that the grant option for the privilege listed on the group securable in the given scope should be revoked. | deleteMode (string) |
| grant_api/delete_api_v2_grants_grantee_type_grantee_name_bulk_grant_type_securable_type_plural_scope_type_scope_name_privileges_privilege | Endpoint to indicate that the privilege listed on the group securable in the given scope should be revoked. | deleteMode (string) |
| grant_api/post_api_v2_grants_grantee_type_grantee_name_bulk_grant_type_securable_type_plural_scope_type_scope_name_privileges | Endpoint to indicate that the privileges listed in the request body should be granted to all securables of this type in the given scope. | data: { . privileges (array) . grant_option (boolean) . created_on (string) . grantee_type (string) . grantee_name (string) . securable_type (string) . securable_name (string) . granted_by_role_type (string) . granted_by_name (string) } (object) required |
| grant_api/get_api_v2_grants_grantee_type_grantee_name | List the roles and privileges granted to the specified grantee using the output of SHOW GRANTS TO | showLimit (string) |
| managed_account_api/delete_api_v2_managed_accounts_name | Removes a managed account, including all objects created in the account, and immediately restricts access to the account. Currently used by data providers to create reader accounts for their consumers. For more details, see Manage reader accounts. | No parameters |
| managed_account_api/get_api_v2_managed_accounts | Lists the accessible managed accounts. | like (string) |
| managed_account_api/post_api_v2_managed_accounts | Creates a managed account. You must provide the full managed account definition when creating a managed account. | data: { . name (string) . admin_name (string) . admin_password (string) . account_type (string) . comment (string) } (object) required |
| network_policy_api/get_api_v2_network_policies_name | Fetch a network policy | No parameters |
| network_policy_api/delete_api_v2_network_policies_name | Delete a network policy | ifExists (string) |
| network_policy_api/get_api_v2_network_policies | List network policies | No parameters |
| network_policy_api/post_api_v2_network_policies | Create a network policy | createMode (string) data: { . name (string) . allowed_network_rule_list (array) . blocked_network_rule_list (array) . allowed_ip_list (array) . blocked_ip_list (array) . comment (string) } (object) required |
| network_rule_api/get_api_v2_databases_database_schemas_schema_network_rules_name | Fetch a network rule | No parameters |
| network_rule_api/delete_api_v2_databases_database_schemas_schema_network_rules_name | Delete a network rule | ifExists (string) |
| network_rule_api/get_api_v2_databases_database_schemas_schema_network_rules | List network rules | like (string) startsWith (string) showLimit (string) fromName (string) |
| network_rule_api/post_api_v2_databases_database_schemas_schema_network_rules | Create a network rule | createMode (string) data: { . type (string) . name (string) . mode (string) . value_list (array) . comment (string) } (object) required |
| password_policy_api/get_api_v2_databases_database_schemas_schema_password_policies_name | Fetch a password policy | No parameters |
| password_policy_api/delete_api_v2_databases_database_schemas_schema_password_policies_name | Delete a password policy | ifExists (string) |
| password_policy_api/post_api_v2_databases_database_schemas_schema_password_policies_by_name_rename | Rename a password policy with a new identifier | name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| password_policy_api/get_api_v2_databases_database_schemas_schema_password_policies | List password policies | like (string) startsWith (string) showLimit (string) |
| password_policy_api/post_api_v2_databases_database_schemas_schema_password_policies | Create a password policy | createMode (string) data: { . name (string) . comment (string) . password_min_length (integer) . password_max_length (integer) . password_min_upper_case_chars (integer) . password_min_lower_case_chars (integer) . password_min_numeric_chars (integer) . password_min_special_chars (integer) . password_min_age_days (integer) . password_max_age_days (integer) . password_max_retries (integer) . password_lockout_time_mins (integer) . password_history (integer) } (object) required |
| role_api/get_api_v2_roles_name_grants | List all grants to the role | showLimit (string) |
| role_api/post_api_v2_roles_name_grants | Grant privileges to the role | data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| role_api/post_api_v2_roles_name_grants_revoke | Revoke grants from the role | mode (string) data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| role_api/get_api_v2_roles_name_grants_of | List all grants of the role | showLimit (string) |
| role_api/get_api_v2_roles_name_grants_on | List all grants on the role | showLimit (string) |
| role_api/get_api_v2_roles_name_future_grants | List all future grants to the role | showLimit (string) |
| role_api/post_api_v2_roles_name_future_grants | Grant future privileges to the role | data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| role_api/post_api_v2_roles_name_future_grants_revoke | Revoke future grants from the role | mode (string) data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| role_api/delete_api_v2_roles_name | Delete a role | ifExists (string) |
| role_api/get_api_v2_roles | List roles | like (string) startsWith (string) showLimit (string) fromName (string) |
| role_api/post_api_v2_roles | Create a role | createMode (string) data: { . name (string) . comment (string) } (object) required |
| secret_api/get_api_v2_databases_database_schemas_schema_secrets_name | Fetch a secret | No parameters |
| secret_api/delete_api_v2_databases_database_schemas_schema_secrets_name | Delete a secret | ifExists (string) |
| secret_api/get_api_v2_databases_database_schemas_schema_secrets | List secrets | like (string) startsWith (string) showLimit (string) fromName (string) |
| secret_api/post_api_v2_databases_database_schemas_schema_secrets | Create a secret | createMode (string) data: { . type (string) . name (string) . comment (string) } (object) required |
| user_api/get_api_v2_users_name_grants | List all grants to the user | showLimit (string) |
| user_api/post_api_v2_users_name_grants | Grant a role to the user | data: { . securable_type (string) . securable (object) . containing_scope (object) . privileges (array) } (object) required |
| user_api/post_api_v2_users_name_grants_revoke | Revoke grants from the user | data: { . securable_type (string) . securable (object) . containing_scope (object) . privileges (array) } (object) required |
| user_api/get_api_v2_users_name | Fetch user information using the result of the DESCRIBE command | No parameters |
| user_api/delete_api_v2_users_name | Delete a user with the given name. | ifExists (string) |
| user_api/put_api_v2_users_name | Create a or alter an existing user. Even if the operation is just an alter, the full property set must be provided. Note that password is not currently altered by this operation but is supported for a newly-created object. | data: { . name (string) . password (string) . login_name (string) . display_name (string) . first_name (string) . middle_name (string) . last_name (string) . email (string) . must_change_password (boolean) . disabled (boolean) . days_to_expiry (integer) . mins_to_unlock (integer) . default_warehouse (string) . default_namespace (string) . default_role (string) . default_secondary_roles (string) . mins_to_bypass_mfa (integer) . rsa_public_key (string) . rsa_public_key_2 (string) . comment (string) . type (string) . enable_unredacted_query_syntax_error (boolean) . network_policy (string) } (object) required |
| user_api/post_api_v2_users | Create a user according to the parameters given | createMode (string) data: { . name (string) . password (string) . login_name (string) . display_name (string) . first_name (string) . middle_name (string) . last_name (string) . email (string) . must_change_password (boolean) . disabled (boolean) . days_to_expiry (integer) . mins_to_unlock (integer) . default_warehouse (string) . default_namespace (string) . default_role (string) . default_secondary_roles (string) . mins_to_bypass_mfa (integer) . rsa_public_key (string) . rsa_public_key_2 (string) . comment (string) . type (string) . enable_unredacted_query_syntax_error (boolean) . network_policy (string) } (object) required |
| user_api/get_api_v2_users | Lists the users in the system. | like (string) startsWith (string) showLimit (string) fromName (string) |
| database_api/post_api_v2_databases_by_name_from_share | Creates a database from a given share. | name (string) required createMode (string) share (string) |
| database_api/post_api_v2_databases_by_name_clone | Clones an existing database, with modifiers as query parameters. You must provide the full database definition when cloning an existing database. | name (string) required createMode (string) kind (string) data: { . name (string) . created_on (string) . kind (string) . is_default (boolean) . is_current (boolean) . origin (string) . owner (string) . comment (string) . options (string) . retention_time (integer) . dropped_on (string) . budget (string) . owner_role_type (string) . data_retention_time_in_days (integer) . default_ddl_collation (string) . log_level (string) . max_data_extension_time_in_days (integer) . suspend_task_after_num_failures (integer) . trace_level (string) . user_task_managed_initial_warehouse_size (string) . user_task_timeout_ms (integer) . serverless_task_min_statement_size (string) . serverless_task_max_statement_size (string) } (object) required |
| database_api/post_api_v2_databases_name_replication_enable | Promotes a local database to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary i.e. replica database. | ignore_edition_check (string) data: { . accounts (array) } (object) required |
| database_api/post_api_v2_databases_name_replication_disable | Disables replication for this primary database, meaning no replica of this database i.e. secondary database in another account can be refreshed. Any secondary databases remain linked to the primary database, but requests to refresh a secondary database are denied. | data: { . accounts (array) } (object) required |
| database_api/post_api_v2_databases_name_replication_refresh | Refreshes a secondary database from a snapshot of its primary database. A snapshot includes changes to the objects and data. If you call this endpoint while another refresh for the same replica database is running, it fails and returns an error. Snowflake ensures only one refresh is executed at any given time. | No parameters |
| database_api/post_api_v2_databases_name_failover_enable | Specifies a comma-separated list of accounts in your organization where a replica of this primary database can be promoted to serve as the primary database. | data: { . accounts (array) } (object) required |
| database_api/post_api_v2_databases_name_failover_disable | Disables failover for this primary database, meaning no replica of this database i.e. secondary database can be promoted to serve as the primary database. | data: { . accounts (array) } (object) required |
| database_api/post_api_v2_databases_name_failover_primary | Promotes the specified secondary replica database to serve as the primary database. When promoted, the database becomes writeable. At the same time, the previous primary database becomes a read-only secondary database. | No parameters |
| database_api/get_api_v2_databases_name | Fetches a database. | No parameters |
| database_api/put_api_v2_databases_name | Creates a new, or alters an existing, database. You must provide the full database definition even when altering an existing database. | data: { . name (string) . kind (string) . comment (string) . data_retention_time_in_days (integer) . default_ddl_collation (string) . log_level (string) . max_data_extension_time_in_days (integer) . suspend_task_after_num_failures (integer) . trace_level (string) . user_task_managed_initial_warehouse_size (string) . user_task_timeout_ms (integer) . serverless_task_min_statement_size (string) . serverless_task_max_statement_size (string) } (object) required |
| database_api/delete_api_v2_databases_name | Deletes the specified database. If you enable the ifExists parameter, the operation succeeds even if the database does not exist. Otherwise, a 404 failure is returned if the database does not exist. if the drop is unsuccessful. | ifExists (string) restrict (string) |
| database_api/post_api_v2_databases_by_name_undrop | Undrops database. | name (string) required |
| database_api/get_api_v2_databases | Lists the accessible databases. | like (string) startsWith (string) showLimit (string) fromName (string) history (string) |
| database_api/post_api_v2_databases | Creates a database, with modifiers as query parameters. You must provide the full database definition when creating a database. | createMode (string) kind (string) data: { . name (string) . kind (string) . comment (string) . data_retention_time_in_days (integer) . default_ddl_collation (string) . log_level (string) . max_data_extension_time_in_days (integer) . suspend_task_after_num_failures (integer) . trace_level (string) . user_task_managed_initial_warehouse_size (string) . user_task_timeout_ms (integer) . serverless_task_min_statement_size (string) . serverless_task_max_statement_size (string) } (object) required |
| database_api/post_api_v2_databases_from_share | Creates a database from a given share. | createMode (string) share (string) data: { . name (string) } (object) required |
| database_role_api/get_api_v2_databases_database_database_roles_name_grants | List all grants to the role | showLimit (string) |
| database_role_api/post_api_v2_databases_database_database_roles_name_grants | Grant privileges to the role | data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| database_role_api/post_api_v2_databases_database_database_roles_name_grants_revoke | Revoke grants from the role | mode (string) data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| database_role_api/get_api_v2_databases_database_database_roles_name_future_grants | List all future grants to the role | showLimit (string) |
| database_role_api/post_api_v2_databases_database_database_roles_name_future_grants | Grant future privileges to the role | data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| database_role_api/post_api_v2_databases_database_database_roles_name_future_grants_revoke | Revoke future grants from the role | mode (string) data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| database_role_api/delete_api_v2_databases_database_database_roles_name | Delete a database role | ifExists (string) |
| database_role_api/post_api_v2_databases_database_database_roles_by_name_clone | Create a new database role by cloning from the specified resource | name (string) required createMode (string) targetDatabase (string) data: { . name (string) } (object) required |
| database_role_api/get_api_v2_databases_database_database_roles | List database roles | showLimit (string) fromName (string) |
| database_role_api/post_api_v2_databases_database_database_roles | Create a database role | createMode (string) data: { . name (string) . comment (string) } (object) required |
| schema_api/post_api_v2_databases_database_schemas_by_name_clone | Clones an existing schema, with modifiers as query parameters. You must provide the full schema definition when cloning an existing schema. | name (string) required createMode (string) kind (string) targetDatabase (string) data: { . name (string) . created_on (string) . kind (string) . is_default (boolean) . is_current (boolean) . database_name (string) . owner (string) . comment (string) . options (string) . managed_access (boolean) . retention_time (integer) . dropped_on (string) . owner_role_type (string) . budget (string) . data_retention_time_in_days (integer) . default_ddl_collation (string) . log_level (string) . pipe_execution_paused (boolean) . max_data_extension_time_in_days (integer) . suspend_task_after_num_failures (integer) . trace_level (string) . user_task_managed_initial_warehouse_size (string) . user_task_timeout_ms (integer) . serverless_task_min_statement_size (string) . serverless_task_max_statement_size (string) } (object) required |
| schema_api/post_api_v2_databases_database_schemas_by_name_undrop | Undrops schema. | name (string) required |
| schema_api/get_api_v2_databases_database_schemas_name | Fetches a schema. | No parameters |
| schema_api/put_api_v2_databases_database_schemas_name | Creates a new, or alters an existing, schema. You must provide the full schema definition even when altering an existing schema. | kind (string) data: { . name (string) . kind (string) . comment (string) . managed_access (boolean) . data_retention_time_in_days (integer) . default_ddl_collation (string) . log_level (string) . pipe_execution_paused (boolean) . max_data_extension_time_in_days (integer) . suspend_task_after_num_failures (integer) . trace_level (string) . user_task_managed_initial_warehouse_size (string) . user_task_timeout_ms (integer) . serverless_task_min_statement_size (string) . serverless_task_max_statement_size (string) } (object) required |
| schema_api/delete_api_v2_databases_database_schemas_name | Deletes the specified schema. If you enable the ifExists parameter, the operation succeeds even if the schema does not exist. Otherwise, a 404 failure is returned if the schema does not exist. if the drop is unsuccessful. | ifExists (string) restrict (string) |
| schema_api/get_api_v2_databases_database_schemas | Lists the accessible schemas. | like (string) startsWith (string) showLimit (string) fromName (string) history (string) |
| schema_api/post_api_v2_databases_database_schemas | Creates a schema, with modifiers as query parameters. You must provide the full schema definition when creating a schema. | createMode (string) kind (string) data: { . name (string) . kind (string) . comment (string) . managed_access (boolean) . data_retention_time_in_days (integer) . default_ddl_collation (string) . log_level (string) . pipe_execution_paused (boolean) . max_data_extension_time_in_days (integer) . suspend_task_after_num_failures (integer) . trace_level (string) . user_task_managed_initial_warehouse_size (string) . user_task_timeout_ms (integer) . serverless_task_min_statement_size (string) . serverless_task_max_statement_size (string) } (object) required |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_as_select | Create a table as select. | name (string) required createMode (string) copyGrants (string) query (string) data: { . name (string) . kind (string) . cluster_by (array) . enable_schema_evolution (boolean) . change_tracking (boolean) . data_retention_time_in_days (integer) . max_data_extension_time_in_days (integer) . default_ddl_collation (string) . columns (array) . constraints (array) . comment (string) } (object) required |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_using_template | Create a table using template. | name (string) required createMode (string) copyGrants (string) query (string) |
| table_api/get_api_v2_databases_database_schemas_schema_tables_name | Fetch a Table using the describe command output. | No parameters |
| table_api/put_api_v2_databases_database_schemas_schema_tables_name | Create a or alter an existing table. Even if the operation is just an alter, the full property set must be provided. | data: { . name (string) . kind (string) . cluster_by (array) . enable_schema_evolution (boolean) . change_tracking (boolean) . data_retention_time_in_days (integer) . max_data_extension_time_in_days (integer) . default_ddl_collation (string) . columns (array) . constraints (array) . comment (string) } (object) required |
| table_api/delete_api_v2_databases_database_schemas_schema_tables_name | Delete a table with the given name. | ifExists (string) |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_clone | Create a new table by cloning from the specified resource | name (string) required createMode (string) copyGrants (string) targetDatabase (string) targetSchema (string) data: { . name (string) . kind (string) . cluster_by (array) . enable_schema_evolution (boolean) . change_tracking (boolean) . data_retention_time_in_days (integer) . max_data_extension_time_in_days (integer) . default_ddl_collation (string) . columns (array) . constraints (array) . comment (string) . created_on (string) . database_name (string) . schema_name (string) . rows (integer) . bytes (integer) . owner (string) . dropped_on (string) . automatic_clustering (boolean) . search_optimization (boolean) . search_optimization_progress (integer) . search_optimization_bytes (integer) . owner_role_type (string) . budget (string) . table_type (string) } (object) required |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_create_like | Create a new table like the specified resource, but empty | name (string) required createMode (string) copyGrants (string) newTableName (string) |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_create_like | Create a new table like the specified resource, but empty | name (string) required createMode (string) copyGrants (string) data: { . name (string) } (object) required |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_undrop | Undrop specified table | name (string) required |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_suspend_recluster | Suspend recluster of a table | name (string) required ifExists (string) |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_suspend_recluster | Suspend recluster of a table | name (string) required ifExists (string) |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_resume_recluster | Resume recluster of a table | name (string) required ifExists (string) |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_resume_recluster | Resume recluster of a table | name (string) required ifExists (string) |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_swapwith | Swap with another table | name (string) required ifExists (string) targetTableName (string) |
| table_api/post_api_v2_databases_database_schemas_schema_tables_by_name_swap_with | Swap with another table | name (string) required ifExists (string) targetName (string) targetDatabase (string) targetSchema (string) |
| table_api/get_api_v2_databases_database_schemas_schema_tables | Lists the tables under the database and schema. | like (string) startsWith (string) showLimit (string) fromName (string) history (string) deep (string) |
| table_api/post_api_v2_databases_database_schemas_schema_tables | Create a table. | createMode (string) copyGrants (string) data: { . name (string) . kind (string) . cluster_by (array) . enable_schema_evolution (boolean) . change_tracking (boolean) . data_retention_time_in_days (integer) . max_data_extension_time_in_days (integer) . default_ddl_collation (string) . columns (array) . constraints (array) . comment (string) } (object) required |
| table_api/post_api_v2_databases_database_schemas_schema_tables_as_select | Create a table as select. | createMode (string) copyGrants (string) query (string) data: { . name (string) . columns (array) . cluster_by (array) } (object) required |
| table_api/post_api_v2_databases_database_schemas_schema_tables_using_template | Create a table using template. | createMode (string) copyGrants (string) query (string) data: { . name (string) } (object) required |
| dynamic_table_api/get_api_v2_databases_database_schemas_schema_dynamic_tables_name | Fetch a Dynamic Table. | No parameters |
| dynamic_table_api/delete_api_v2_databases_database_schemas_schema_dynamic_tables_name | Delete a dynamic table with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful. | ifExists (string) |
| dynamic_table_api/post_api_v2_databases_database_schemas_schema_dynamic_tables_by_name_clone | Create a new dynamic table by cloning from the specified resource | name (string) required createMode (string) copyGrants (string) targetDatabase (string) targetSchema (string) data: { . name (string) . target_lag (object) . warehouse (string) . point_of_time (object) } (object) required |
| dynamic_table_api/post_api_v2_databases_database_schemas_schema_dynamic_tables_by_name_undrop | Undrop specified dynamic table | name (string) required |
| dynamic_table_api/post_api_v2_databases_database_schemas_schema_dynamic_tables_by_name_suspend | Suspend refreshes on the dynamic table | name (string) required ifExists (string) |
| dynamic_table_api/post_api_v2_databases_database_schemas_schema_dynamic_tables_by_name_resume | Resume refreshes on the dynamic table | name (string) required ifExists (string) |
| dynamic_table_api/post_api_v2_databases_database_schemas_schema_dynamic_tables_by_name_refresh | Specifies that the dynamic table should be manually refreshed | name (string) required ifExists (string) |
| dynamic_table_api/post_api_v2_databases_database_schemas_schema_dynamic_tables_by_name_suspend_recluster | Suspend recluster of a dynamic table | name (string) required ifExists (string) |
| dynamic_table_api/post_api_v2_databases_database_schemas_schema_dynamic_tables_by_name_resume_recluster | Resume recluster of a dynamic table | name (string) required ifExists (string) |
| dynamic_table_api/post_api_v2_databases_database_schemas_schema_dynamic_tables_by_name_swap_with | Swap with another dynamic table | name (string) required ifExists (string) targetName (string) targetDatabase (string) targetSchema (string) |
| dynamic_table_api/get_api_v2_databases_database_schemas_schema_dynamic_tables | Lists the dynamic tables under the database and schema. | like (string) startsWith (string) showLimit (string) fromName (string) deep (string) |
| dynamic_table_api/post_api_v2_databases_database_schemas_schema_dynamic_tables | Create a dynamic table, with standard create modifiers as query parameters. See the Dynamic Table component definition for what is required to be provided in the request body. | createMode (string) data: { . name (string) . target_lag (object) . warehouse (string) . query (string) . kind (string) . columns (array) . refresh_mode (string) . initialize (string) . cluster_by (array) . data_retention_time_in_days (integer) . max_data_extension_time_in_days (integer) . comment (string) } (object) required |
| event_table_api/get_api_v2_databases_database_schemas_schema_event_tables_name | Fetch an event table | No parameters |
| event_table_api/delete_api_v2_databases_database_schemas_schema_event_tables_name | Delete an event table | ifExists (string) |
| event_table_api/post_api_v2_databases_database_schemas_schema_event_tables_by_name_rename | Rename the event table | name (string) required ifExists (string) targetName (string) |
| event_table_api/get_api_v2_databases_database_schemas_schema_event_tables | List event tables | like (string) startsWith (string) showLimit (string) fromName (string) |
| event_table_api/post_api_v2_databases_database_schemas_schema_event_tables | Create an event table | createMode (string) copyGrants (string) data: { . name (string) . cluster_by (array) . data_retention_time_in_days (integer) . max_data_extension_time_in_days (integer) . change_tracking (boolean) . default_ddl_collation (string) . comment (string) } (object) required |
| iceberg_table_api/get_api_v2_databases_database_schemas_schema_iceberg_tables_name | Describe an iceberg table | No parameters |
| iceberg_table_api/delete_api_v2_databases_database_schemas_schema_iceberg_tables_name | Drop an iceberg table | ifExists (string) type (string) |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_by_name_resume_recluster | Resume recluster of an iceberg table iceberg tables managed by an external catalog do not allow clustering | name (string) required ifExists (string) |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_by_name_suspend_recluster | Suspend recluster of an iceberg table iceberg tables managed by an external catalog do not allow clustering | name (string) required ifExists (string) |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_by_name_refresh | Refreshes the metadata for an Apache Iceberg table that uses an external Iceberg catalog | name (string) required ifExists (string) data: { . metadata_file_relative_path (string) } (object) required |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_by_name_convert_to_managed | Convert unmanaged iceberg table to managed iceberg table | name (string) required ifExists (string) data: { . base_location (string) . storage_serialization_policy (string) } (object) required |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_by_name_undrop | Undrop an iceberg table | name (string) required |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_by_name_clone | Clone a snowflake managed iceberg table | name (string) required createMode (string) copyGrants (string) targetDatabase (string) targetSchema (string) data: { . name (string) . point_of_time (object) } (object) required |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_by_name_create_like | Creates a new table with the same column definitions as an existing table, but without copying data from the existing table. | name (string) required createMode (string) copyGrants (string) targetDatabase (string) targetSchema (string) data: { . name (string) . cluster_by (array) . external_volume (string) . base_location (string) . comment (string) } (object) required |
| iceberg_table_api/get_api_v2_databases_database_schemas_schema_iceberg_tables | Lists the Apache Iceberg™ tables for which you have access privileges. | like (string) startsWith (string) showLimit (string) fromName (string) deep (string) |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables | Create a snowflake managed iceberg table clone and undrop are separate subresources | createMode (string) copyGrants (string) data: { . name (string) . comment (string) . change_tracking (boolean) . max_data_extension_time_in_days (integer) . external_volume (string) . data_retention_time_in_days (integer) . catalog_sync (string) . catalog (string) . storage_serialization_policy (string) . catalog_table_name (string) . catalog_namespace (string) . cluster_by (array) . columns (array) . base_location (string) . replace_invalid_characters (boolean) . metadata_file_path (string) . constraints (array) } (object) required |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_as_select | Create a snowflake managed iceberg table as select | createMode (string) copyGrants (string) query (string) data: { . name (string) . columns (array) . external_volume (string) . cluster_by (array) . base_location (string) . comment (string) } (object) required |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_from_aws_glue_catalog | Create an unmanaged iceberg table from AWS Glue catalog | createMode (string) data: { . name (string) . catalog_table_name (string) . external_volume (string) . catalog_namespace (string) . replace_invalid_characters (boolean) . auto_refresh (boolean) . catalog (string) . comment (string) } (object) required |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_from_delta | Create an unmanaged iceberg table from Delta | createMode (string) data: { . name (string) . base_location (string) . external_volume (string) . replace_invalid_characters (boolean) . catalog (string) . comment (string) } (object) required |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_from_iceberg_files | Create an unmanaged iceberg table from Iceberg files | createMode (string) data: { . name (string) . metadata_file_path (string) . external_volume (string) . replace_invalid_characters (boolean) . catalog (string) . comment (string) } (object) required |
| iceberg_table_api/post_api_v2_databases_database_schemas_schema_iceberg_tables_from_iceberg_rest | Create an unmanaged iceberg table from Iceberg REST | createMode (string) data: { . name (string) . catalog_table_name (string) . external_volume (string) . catalog_namespace (string) . replace_invalid_characters (boolean) . auto_refresh (boolean) . catalog (string) . comment (string) } (object) required |
| view_api/get_api_v2_databases_database_schemas_schema_views_name | Fetch a view | No parameters |
| view_api/delete_api_v2_databases_database_schemas_schema_views_name | Delete a view | ifExists (string) |
| view_api/get_api_v2_databases_database_schemas_schema_views | List views | like (string) startsWith (string) showLimit (string) fromName (string) deep (string) |
| view_api/post_api_v2_databases_database_schemas_schema_views | Create a view | createMode (string) copyGrants (string) data: { . name (string) . columns (array) . query (string) . secure (boolean) . kind (string) . recursive (boolean) . comment (string) } (object) required |
| pipe_api/get_api_v2_databases_database_schemas_schema_pipes_name | Fetch a pipe | No parameters |
| pipe_api/delete_api_v2_databases_database_schemas_schema_pipes_name | Delete a pipe | ifExists (string) |
| pipe_api/post_api_v2_databases_database_schemas_schema_pipes_by_name_refresh | Refresh the pipe | name (string) required ifExists (string) prefix (string) modified_after (string) |
| pipe_api/get_api_v2_databases_database_schemas_schema_pipes | List pipes | like (string) |
| pipe_api/post_api_v2_databases_database_schemas_schema_pipes | Create a pipe | createMode (string) data (string) required |
| stage_api/post_api_v2_databases_database_schemas_schema_stages_name_files_by_file_path_presigned_url | Generate a presigned url and optionally encryption materials for uploading and downloading files. | filePath (string) required data: { . expiration_time (integer) } (object) required |
| stage_api/get_api_v2_databases_database_schemas_schema_stages_name_files | List files in the stage -- this is equivalent to LIST @stage. | pattern (string) |
| stage_api/get_api_v2_databases_database_schemas_schema_stages_name | Fetch a stage using the describe command output. | No parameters |
| stage_api/delete_api_v2_databases_database_schemas_schema_stages_name | Delete a stage with the stage name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful. | ifExists (string) |
| stage_api/get_api_v2_databases_database_schemas_schema_stages | Lists stages under the database and schema, with show options as query parameters. | like (string) |
| stage_api/post_api_v2_databases_database_schemas_schema_stages | Create a stage, with standard create modifiers as query parameters. See the Stage component definition for what is required to be provided in the request body. | createMode (string) data: { . name (string) } (object) required |
| stream_api/get_api_v2_databases_database_schemas_schema_streams_name | Fetch a stream | No parameters |
| stream_api/delete_api_v2_databases_database_schemas_schema_streams_name | Delete a stream | ifExists (string) |
| stream_api/post_api_v2_databases_database_schemas_schema_streams_by_name_clone | Clone a stream | name (string) required createMode (string) targetDatabase (string) targetSchema (string) copyGrants (string) data: { . name (string) . comment (string) } (object) required |
| stream_api/get_api_v2_databases_database_schemas_schema_streams | List streams | like (string) startsWith (string) showLimit (string) fromName (string) |
| stream_api/post_api_v2_databases_database_schemas_schema_streams | Create a stream | createMode (string) copyGrants (string) data: { . name (string) . stream_source (object) . comment (string) } (object) required |
| task_api/get_api_v2_databases_database_schemas_schema_tasks_name_dependents | This operation returns a list of the dependent tasks of the task with identifier name. | recursive (string) |
| task_api/get_api_v2_databases_database_schemas_schema_tasks_name_current_graphs | This function returns details for graph runs that are currently executing or are next scheduled to run within the next 8 days. | resultLimit (string) |
| task_api/get_api_v2_databases_database_schemas_schema_tasks_name_current_graphs | This function returns details for graph runs that are currently executing or are next scheduled to run within the next 8 days. | resultLimit (string) |
| task_api/get_api_v2_databases_database_schemas_schema_tasks_name_complete_graphs | This function returns details for graph runs that are completed. | resultLimit (string) errorOnly (string) |
| task_api/get_api_v2_databases_database_schemas_schema_tasks_name_complete_graphs | This function returns details for graph runs that are completed. | resultLimit (string) errorOnly (string) |
| task_api/get_api_v2_databases_database_schemas_schema_tasks_name | Fetch a task using the describe command output. | No parameters |
| task_api/put_api_v2_databases_database_schemas_schema_tasks_name | Create a or alter an existing task. Even if the operation is just an alter, the full property set must be provided. | data: { . name (string) . schedule (object) . comment (string) . config (object) . definition (string) . predecessors (array) . user_task_managed_initial_warehouse_size (string) . target_completion_interval (object) . serverless_task_min_statement_size (string) . serverless_task_max_statement_size (string) . user_task_timeout_ms (integer) . suspend_task_after_num_failures (integer) . condition (string) . allow_overlapping_execution (boolean) . error_integration (string) . created_on (string) . id (string) . owner (string) . owner_role_type (string) . state (string) . last_committed_on (string) . last_suspended_on (string) . database_name (string) . schema_name (string) } (object) required |
| task_api/delete_api_v2_databases_database_schemas_schema_tasks_name | Delete a task with the task name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful. | ifExists (string) |
| task_api/post_api_v2_databases_database_schemas_schema_tasks_by_name_execute | Execute a task -- this is equivalent to EXECUTE IMMEDIATE. | name (string) required asyncExec (string) retryLast (string) |
| task_api/post_api_v2_databases_database_schemas_schema_tasks_by_name_resume | Resumes a suspended task object. This is equivalento an ALTER TASK ... RESUME. | name (string) required |
| task_api/post_api_v2_databases_database_schemas_schema_tasks_by_name_suspend | Suspends a running task. This is equivalent to an ALTER TASK ... SUSPEND. | name (string) required |
| task_api/get_api_v2_databases_database_schemas_schema_tasks | Lists tasks under the database and schema, with show options as query parameters. | rootOnly (string) like (string) startsWith (string) showLimit (string) fromName (string) |
| task_api/post_api_v2_databases_database_schemas_schema_tasks | Create a task, with standard create modifiers as query parameters. See the Task component definition for what is required to be provided in the request body. | createMode (string) data: { . name (string) . warehouse (string) . schedule (object) . predecessors (array) . comment (string) . definition (string) } (object) required |
| function_api/get_api_v2_databases_database_schemas_schema_functions_name_with_args | Fetch a Function using the describe command output. | No parameters |
| function_api/delete_api_v2_databases_database_schemas_schema_functions_name_with_args | Delete a function with the given name and args. | ifExists (string) |
| function_api/post_api_v2_databases_database_schemas_schema_functions_by_name_execute | Execute a Function. | name (string) required data (array) required |
| function_api/get_api_v2_databases_database_schemas_schema_functions | Lists the user functions under the database and schema. | like (string) |
| function_api/post_api_v2_databases_database_schemas_schema_functions | Create a function. | createMode (string) data: { . name (string) . arguments (array) . function_type (string) . returns (string) . max_batch_rows (integer) . created_on (string) . signature (string) . language (string) . body (string) } (object) required |
| procedure_api/get_api_v2_databases_database_schemas_schema_procedures_name_with_args | Fetch a procedure | No parameters |
| procedure_api/delete_api_v2_databases_database_schemas_schema_procedures_name_with_args | Delete a procedure | ifExists (string) |
| procedure_api/post_api_v2_databases_database_schemas_schema_procedures_by_name_with_args_call | Call a procedure | nameWithArgs (string) required data: { . call_arguments (array) } (object) required |
| procedure_api/get_api_v2_databases_database_schemas_schema_procedures | List procedures | like (string) |
| procedure_api/post_api_v2_databases_database_schemas_schema_procedures | Create a procedure | createMode (string) copyGrants (string) data: { . name (string) . arguments (array) . return_type (object) . language_config (object) . execute_as (string) . is_secure (boolean) . comment (string) . body (string) } (object) required |
| user_defined_function_api/get_api_v2_databases_database_schemas_schema_user_defined_functions_name_with_args | Fetch a UDF | No parameters |
| user_defined_function_api/delete_api_v2_databases_database_schemas_schema_user_defined_functions_name_with_args | Delete a UDF | ifExists (string) |
| user_defined_function_api/post_api_v2_databases_database_schemas_schema_user_defined_functions_by_name_execute | Execute a UDF. | name (string) required data (array) required |
| user_defined_function_api/post_api_v2_databases_database_schemas_schema_user_defined_functions_by_name_with_args_rename | Rename a UDF | nameWithArgs (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| user_defined_function_api/post_api_v2_databases_database_schemas_schema_user_defined_functions | Create a UDF | createMode (string) copyGrants (string) data: { . name (string) . arguments (array) . return_type (object) . language_config (object) . is_temporary (boolean) . is_aggregate (boolean) . is_memoizable (boolean) . is_secure (boolean) . comment (string) . body (string) } (object) required |
| user_defined_function_api/get_api_v2_databases_database_schemas_schema_user_defined_functions | List UDFs | like (string) |
| sequence_api/get_api_v2_databases_database_schemas_schema_sequences_name | Fetch a sequence | No parameters |
| sequence_api/delete_api_v2_databases_database_schemas_schema_sequences_name | Delete a sequence | ifExists (string) |
| sequence_api/post_api_v2_databases_database_schemas_schema_sequences_by_name_clone | Create a new sequence by cloning from the specified resource | name (string) required createMode (string) targetDatabase (string) targetSchema (string) data: { . name (string) . start (integer) . increment (integer) . ordered (boolean) . comment (string) } (object) required |
| sequence_api/post_api_v2_databases_database_schemas_schema_sequences_by_name_rename | Rename a sequence with a new identifier | name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| sequence_api/get_api_v2_databases_database_schemas_schema_sequences | List sequences | like (string) |
| sequence_api/post_api_v2_databases_database_schemas_schema_sequences | Create a sequence | createMode (string) data: { . name (string) . start (integer) . increment (integer) . ordered (boolean) . comment (string) } (object) required |
| api_integration_api/get_api_v2_api_integrations_name | Fetch an API integration | No parameters |
| api_integration_api/put_api_v2_api_integrations_name | Create an or alter an existing API integration. Note that API_KEY is not currently altered by this operation and is supported for a newly-created object only. Unsetting API_BLOCKED_PREFIXES is also unsupported. | data: { . name (string) . api_hook (object) . api_allowed_prefixes (array) . enabled (boolean) . api_blocked_prefixes (array) . comment (string) } (object) required |
| api_integration_api/delete_api_v2_api_integrations_name | Delete an API integration | ifExists (string) |
| api_integration_api/get_api_v2_api_integrations | List API integrations | like (string) |
| api_integration_api/post_api_v2_api_integrations | Create an API integration | createMode (string) data: { . name (string) . api_hook (object) . api_allowed_prefixes (array) . enabled (boolean) . api_blocked_prefixes (array) . comment (string) } (object) required |
| catalog_integration_api/get_api_v2_catalog_integrations_name | Fetch a catalog integration. | No parameters |
| catalog_integration_api/delete_api_v2_catalog_integrations_name | Delete a catalog integration. | ifExists (string) |
| catalog_integration_api/get_api_v2_catalog_integrations | List catalog integrations. | like (string) |
| catalog_integration_api/post_api_v2_catalog_integrations | Create a catalog integration. | createMode (string) data: { . name (string) . catalog (object) . table_format (string) . enabled (boolean) . comment (string) } (object) required |
| notification_integration_api/get_api_v2_notification_integrations_name | Fetch a notification integration | No parameters |
| notification_integration_api/delete_api_v2_notification_integrations_name | Delete a notification integration | ifExists (string) |
| notification_integration_api/get_api_v2_notification_integrations | List notification integrations | like (string) |
| notification_integration_api/post_api_v2_notification_integrations | Create a notification integration | createMode (string) data: { . name (string) . notification_hook (object) . enabled (boolean) . comment (string) } (object) required |
| external_volume_api/get_api_v2_external_volumes_name | Fetch an external volume | No parameters |
| external_volume_api/delete_api_v2_external_volumes_name | Delete an external volume | ifExists (string) |
| external_volume_api/post_api_v2_external_volumes_by_name_undrop | Undrop an external volume | name (string) required |
| external_volume_api/get_api_v2_external_volumes | List external volumes | like (string) |
| external_volume_api/post_api_v2_external_volumes | Create an external volume | createMode (string) data: { . name (string) . storage_locations (array) . allow_writes (boolean) . comment (string) } (object) required |
| warehouse_api/get_api_v2_warehouses_name | Describes the warehouse, show information of the chosen warehouse. Equivalent to DESCRIBE WAREHOUSE in SQL. | No parameters |
| warehouse_api/delete_api_v2_warehouses_name | Removes the specified virtual warehouse from the system. Equivalent to DROP WAREHOUSE in SQL. | ifExists (string) |
| warehouse_api/put_api_v2_warehouses_name | Create a or alter an existing warehouse. Even if the operation is just an alter, the full property set must be provided. | data: { . name (string) . warehouse_type (string) . warehouse_size (string) . wait_for_completion (string) . max_cluster_count (integer) . min_cluster_count (integer) . scaling_policy (string) . auto_suspend (integer) . auto_resume (string) . initially_suspended (string) . resource_monitor (string) . comment (string) . enable_query_acceleration (string) . query_acceleration_max_scale_factor (integer) . max_concurrency_level (integer) . statement_queued_timeout_in_seconds (integer) . statement_timeout_in_seconds (integer) . type (string) . size (string) . warehouse_credit_limit (integer) . target_statement_size (string) } (object) required |
| warehouse_api/post_api_v2_warehouses_by_name_resume | Bring current warehouse to a usable ‘Running’ state by provisioning compute resources if current warehouse is suspended. | name (string) required ifExists (string) |
| warehouse_api/post_api_v2_warehouses_by_name_suspend | Remove all compute nodes from a warehouse and put the warehouse into a ‘Suspended’ state if current warehouse is not suspended. | name (string) required ifExists (string) |
| warehouse_api/post_api_v2_warehouses_by_name_rename | Specifies a new identifier for the warehouse; must be unique for current account. | name (string) required ifExists (string) data: { . name (string) . warehouse_type (string) . warehouse_size (string) . wait_for_completion (string) . max_cluster_count (integer) . min_cluster_count (integer) . scaling_policy (string) . auto_suspend (integer) . auto_resume (string) . initially_suspended (string) . resource_monitor (string) . comment (string) . enable_query_acceleration (string) . query_acceleration_max_scale_factor (integer) . max_concurrency_level (integer) . statement_queued_timeout_in_seconds (integer) . statement_timeout_in_seconds (integer) . type (string) . size (string) . warehouse_credit_limit (integer) . target_statement_size (string) } (object) required |
| warehouse_api/post_api_v2_warehouses_by_name_abort | Aborts all the queries currently running or queued on the warehouse. | name (string) required ifExists (string) |
| warehouse_api/post_api_v2_warehouses_by_name_use | Deprecated Specifies the active/current warehouse for the session. | name (string) required |
| warehouse_api/post_api_v2_warehouses_by_name_enable | Enable an adaptive warehouse and put the warehouse into a ‘enabled’ state, if the warehouse is not enabled. | name (string) required ifExists (string) |
| warehouse_api/post_api_v2_warehouses_by_name_disable | Disable an adaptive warehouse and put the warehouse into a ‘disabled’ state, if the warehouse is not disabled. | name (string) required ifExists (string) |
| warehouse_api/post_api_v2_warehouses | Create a virtual warehouse. Equivalent to CREATE WAREHOUSE in SQL. | createMode (string) data: { . name (string) . warehouse_type (string) . warehouse_size (string) . wait_for_completion (string) . max_cluster_count (integer) . min_cluster_count (integer) . scaling_policy (string) . auto_suspend (integer) . auto_resume (string) . initially_suspended (string) . resource_monitor (string) . comment (string) . enable_query_acceleration (string) . query_acceleration_max_scale_factor (integer) . max_concurrency_level (integer) . statement_queued_timeout_in_seconds (integer) . statement_timeout_in_seconds (integer) . type (string) . size (string) . warehouse_credit_limit (integer) . target_statement_size (string) } (object) required |
| warehouse_api/get_api_v2_warehouses | Show a list of warehouse filtered by pattern. Equivalent to SHOW WAREHOUSE in SQL. | like (string) |
| compute_pools_api/get_api_v2_compute_pools_name | Fetches a named compute pool. You can get the name of the compute pool from the /api/v2/compute-pools GET request. | No parameters |
| compute_pools_api/put_api_v2_compute_pools_name | Create a or alter an existing compute pool. Even if the operation is just an alter, the full property set must be provided. | data: { . name (string) . warehouse (string) . min_nodes (integer) . max_nodes (integer) . instance_family (string) . auto_resume (boolean) . comment (string) . state (string) . num_services (integer) . num_jobs (integer) . auto_suspend_secs (integer) . active_nodes (integer) . idle_nodes (integer) . target_nodes (integer) . created_on (string) . updated_on (string) . resumed_on (string) . owner (string) . is_exclusive (boolean) . application (string) . budget (string) . error_code (string) . status_message (string) . desired_nodes (integer) . desired_nodes_expire_after (string) . placement_group (string) } (object) required |
| compute_pools_api/delete_api_v2_compute_pools_name | Deletes a compute pool with the given name. If you enable the ifExists parameter, the operation succeeds even if the object does not exist. Otherwise, a 404 failure is returned if the object does not exist. | ifExists (string) |
| compute_pools_api/post_api_v2_compute_pools_by_name_resume | Resume a compute pool, if suspended. If the specified compute pool is already running, this will cause a 400 Bad Request error. | name (string) required |
| compute_pools_api/post_api_v2_compute_pools_by_name_suspend | Suspend a compute pool, if active. If the specified compute pool is already suspended, no action is taken. | name (string) required |
| compute_pools_api/post_api_v2_compute_pools_by_name_stopallservices | Stops all services in the compute pool. Deprecated - use :stop-all-services instead. | name (string) required |
| compute_pools_api/post_api_v2_compute_pools_by_name_stop_all_services | Stops all services in the compute pool. | name (string) required |
| compute_pools_api/get_api_v2_compute_pools_instance_families | Lists all available instance families that can be used when creating compute pools. | No parameters |
| compute_pools_api/get_api_v2_compute_pools | Lists the compute pools under the account. | like (string) startsWith (string) showLimit (string) |
| compute_pools_api/post_api_v2_compute_pools | Creates a compute pool, with standard create modifiers as query parameters. See the Compute Pool component definition for what is required to be provided in the request body. | createMode (string) initiallySuspended (string) data: { . name (string) . warehouse (string) . min_nodes (integer) . max_nodes (integer) . instance_family (string) . auto_resume (boolean) . comment (string) . state (string) . num_services (integer) . num_jobs (integer) . auto_suspend_secs (integer) . active_nodes (integer) . idle_nodes (integer) . target_nodes (integer) . created_on (string) . updated_on (string) . resumed_on (string) . owner (string) . is_exclusive (boolean) . application (string) . budget (string) . error_code (string) . status_message (string) . desired_nodes (integer) . desired_nodes_expire_after (string) . placement_group (string) } (object) required |
| notebook_api/get_api_v2_databases_database_schemas_schema_notebooks_name | Fetch a notebook | No parameters |
| notebook_api/delete_api_v2_databases_database_schemas_schema_notebooks_name | Delete a notebook | ifExists (string) |
| notebook_api/post_api_v2_databases_database_schemas_schema_notebooks_by_name_execute | Execute a Notebook | name (string) required asyncExec (string) |
| notebook_api/post_api_v2_databases_database_schemas_schema_notebooks_by_name_rename | Changes the name of the notebook to new name. The new identifier must be unique for the schema. | name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| notebook_api/post_api_v2_databases_database_schemas_schema_notebooks_by_name_add_live_version | Adds a LIVE version to the notebook | name (string) required fromLast (string) comment (string) |
| notebook_api/post_api_v2_databases_database_schemas_schema_notebooks_by_name_commit | If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository | name (string) required version (string) comment (string) |
| notebook_api/get_api_v2_databases_database_schemas_schema_notebooks | List notebooks | like (string) startsWith (string) showLimit (string) fromName (string) |
| notebook_api/post_api_v2_databases_database_schemas_schema_notebooks | Create a notebook | createMode (string) data: { . name (string) . version (string) . fromLocation (string) . main_file (string) . comment (string) . default_version (string) . query_warehouse (string) . title (string) . runtime_name (string) . compute_pool (string) . import_urls (array) . external_access_integrations (array) . idle_auto_shutdown_time_seconds (integer) . default_version_details (object) . last_version_details (object) } (object) required |
| services_api/get_api_v2_databases_database_schemas_schema_services_name_logs | Fetch the logs for a given service. | instanceId (string) containerName (string) numLines (string) |
| services_api/get_api_v2_databases_database_schemas_schema_services_name_status | Fetch the status for a given service. Deprecated - use listServiceContainers instead. | timeout (string) |
| services_api/get_api_v2_databases_database_schemas_schema_services_name_containers | List all the containers of the service | No parameters |
| services_api/get_api_v2_databases_database_schemas_schema_services_name_instances | List all the instances of the service | No parameters |
| services_api/get_api_v2_databases_database_schemas_schema_services_name_roles | List all the service roles of the service | No parameters |
| services_api/get_api_v2_databases_database_schemas_schema_services_name_endpoints | Lists the endpoints in a Snowpark Container Services service or a job service. | No parameters |
| services_api/get_api_v2_databases_database_schemas_schema_services_name | Fetch a service. | No parameters |
| services_api/put_api_v2_databases_database_schemas_schema_services_name | Create a or alter an existing service. Even if the operation is just an alter, the full property set must be provided. | data: { . name (string) . compute_pool (string) . spec (object) . min_ready_instances (integer) . min_instances (integer) . max_instances (integer) . database_name (string) . schema_name (string) . owner (string) . is_job (boolean) } (object) required |
| services_api/delete_api_v2_databases_database_schemas_schema_services_name | Delete a service with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful. | ifExists (string) |
| services_api/get_api_v2_databases_database_schemas_schema_services_service_roles_name_grants_of | List all the grants of the service role | No parameters |
| services_api/get_api_v2_databases_database_schemas_schema_services_service_roles_name_grants | List all the grants given to the service role | No parameters |
| services_api/post_api_v2_databases_database_schemas_schema_services_by_name_resume | Resume a service. | name (string) required ifExists (string) |
| services_api/post_api_v2_databases_database_schemas_schema_services_by_name_suspend | Suspend a service. | name (string) required ifExists (string) |
| services_api/get_api_v2_databases_database_schemas_schema_services | Lists the services under the database and schema. | like (string) startsWith (string) showLimit (string) fromName (string) |
| services_api/post_api_v2_databases_database_schemas_schema_services | Create a service, with standard create modifiers as query parameters. See the Service component definition for what is required to be provided in the request body. | createMode (string) data: { . name (string) . compute_pool (string) . spec (object) . min_ready_instances (integer) . min_instances (integer) . max_instances (integer) . database_name (string) . schema_name (string) . owner (string) . is_job (boolean) } (object) required |
| services_api/post_api_v2_databases_database_schemas_schema_services_execute_job | Create and execute a job service. See the JobService component definition for what is required to be provided in the request body. | data: { . name (string) . compute_pool (string) . spec (object) } (object) required |
| streamlit_api/get_api_v2_databases_database_schemas_schema_streamlits_name | Fetch detailed information about a specific Streamlit by name, including metadata, configuration, and version details. | No parameters |
| streamlit_api/delete_api_v2_databases_database_schemas_schema_streamlits_name | Delete a Streamlit. The Streamlit can be restored using undrop within the retention period. | ifExists (string) |
| streamlit_api/post_api_v2_databases_database_schemas_schema_streamlits_by_name_undrop | Restore a previously deleted Streamlit within the retention period. | name (string) required |
| streamlit_api/post_api_v2_databases_database_schemas_schema_streamlits_by_name_rename | Rename a Streamlit to a new name, optionally in a different database or schema. | name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| streamlit_api/post_api_v2_databases_database_schemas_schema_streamlits_by_name_add_live_version | Add a live version to the Streamlit, making a specific version active for users. | name (string) required fromLast (string) data: { . version (object) } (object) required |
| streamlit_api/post_api_v2_databases_database_schemas_schema_streamlits_by_name_commit | If a Git connection is set up, commit the LIVE version of the Streamlit to the Git repository. | name (string) required data: { . version (object) } (object) required |
| streamlit_api/post_api_v2_databases_database_schemas_schema_streamlits_by_name_add_version | Add a new version to the Streamlit by copying files from a specified stage location. | name (string) required data: { . source_location (string) . version (object) } (object) required |
| streamlit_api/post_api_v2_databases_database_schemas_schema_streamlits_by_name_add_version_from_git | Add a new version to the Streamlit using a Git reference URI. The URI can point to either a tag or a commit. | name (string) required data: { . version (object) . git_ref (string) } (object) required |
| streamlit_api/post_api_v2_databases_database_schemas_schema_streamlits_by_name_abort | Abort the live version of the Streamlit, discarding uncommitted changes if a Git connection is configured. | name (string) required |
| streamlit_api/post_api_v2_databases_database_schemas_schema_streamlits_by_name_pull | Pull the latest changes from the Git repository for a Streamlit with Git integration. | name (string) required |
| streamlit_api/post_api_v2_databases_database_schemas_schema_streamlits_by_name_push | Push committed changes from the Streamlit back to its connected Git repository. | name (string) required data: { . auth_type (string) } (object) required |
| streamlit_api/get_api_v2_databases_database_schemas_schema_streamlits | List Streamlits in a schema. Supports filtering with pattern matching. | like (string) startsWith (string) showLimit (string) fromName (string) |
| streamlit_api/post_api_v2_databases_database_schemas_schema_streamlits | Create a new Streamlit application, or replace an existing one. Supports CREATE, CREATE OR REPLACE, and CREATE IF NOT EXISTS modes. | createMode (string) data: { . name (string) . comment (string) . imports (array) . external_access_integrations (array) . title (string) . main_file (string) . query_warehouse (string) . default_version (string) . default_version_details (object) . last_version_details (object) . source_location (string) } (object) required |
| spark_connect_api/post_api_v2_spark_connect_execute_plan | Executes a request that contains the query and returns a stream of ExecutePlanResponse. | data (object) required |
| spark_connect_api/post_api_v2_spark_connect_analyze_plan | Analyzes a query and return a AnalyzeResponse containing metadata about the query. | data (object) required |
| spark_connect_api/post_api_v2_spark_connect_config | Update or fetch the configurations and returns a ConfigResponse containing the result. | data (object) required |
| spark_connect_api/post_api_v2_spark_connect_add_artifacts | Add artifacts to the session and returns a AddArtifactsResponse containing metadata about the added artifacts. | data (object) required |
| spark_connect_api/post_api_v2_spark_connect_artifact_status | Check statuses of artifacts in the session and returns them in a ArtifactStatusesResponse | data (object) required |
| spark_connect_api/post_api_v2_spark_connect_interrupt | Interrupts running executions | data (object) required |
| spark_connect_api/post_api_v2_spark_connect_reattach_execute | Reattach to an existing re-attachable execution. | data (object) required |
| spark_connect_api/post_api_v2_spark_connect_release_execute | Release an re-attachable execution, or parts thereof. | data (object) required |
| spark_connect_api/post_api_v2_spark_connect_pull_request | Get the next Spark request. | data (object) required |
| spark_connect_api/post_api_v2_spark_connect_push_response | Executes a request from sproc that contains the Spark response. | data (object) required |
| artifact_repository_api/get_api_v2_databases_database_schemas_schema_artifact_repositories_name | Fetch an artifact repository | No parameters |
| artifact_repository_api/delete_api_v2_databases_database_schemas_schema_artifact_repositories_name | Delete an artifact repository | ifExists (string) |
| artifact_repository_api/put_api_v2_databases_database_schemas_schema_artifact_repositories_name | Create or update an artifact repository | data: { . name (string) . type (string) . api_integration (string) . comment (string) } (object) required |
| artifact_repository_api/post_api_v2_databases_database_schemas_schema_artifact_repositories_by_name_rename | Changes the name of an artifact repository | name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| artifact_repository_api/get_api_v2_databases_database_schemas_schema_artifact_repositories | List artifact repositories | like (string) startsWith (string) showLimit (string) fromName (string) |
| artifact_repository_api/post_api_v2_databases_database_schemas_schema_artifact_repositories | Create an artifact repository | createMode (string) data: { . name (string) . type (string) . api_integration (string) . comment (string) } (object) required |
| image_repository_api/get_api_v2_databases_database_schemas_schema_image_repositories_name_images | List images in the given image repository. | No parameters |
| image_repository_api/get_api_v2_databases_database_schemas_schema_image_repositories_name | Fetches a named image repository in a specified database and schema. | No parameters |
| image_repository_api/delete_api_v2_databases_database_schemas_schema_image_repositories_name | Deletes an image repository with the given name. If you enable the ifExists query parameter, the operation succeeds even if the object does not exist. Otherwise, a 404 failure is returned if the object does not exist. | ifExists (string) |
| image_repository_api/get_api_v2_databases_database_schemas_schema_image_repositories | Lists the image repositories under a specified database and schema. | like (string) |
| image_repository_api/post_api_v2_databases_database_schemas_schema_image_repositories | Creates an image repository in the specified database, schema, and create mode. The createMode query parameter specifies what action to take based on whether the repository already exists. See the ImageRepository component definition for what is required to be provided in the request body. | createMode (string) data (object) required |
| result_api/get_api_v2_results_result_handler | Get result status or the result when it is ready. | page (string) |
| sql_api/post_api_v2_statements_statement_handle_cancel | Cancels the execution of the statement with the specified statement handle. | requestId (string) |
| sql_api/get_api_v2_statements_statement_handle | Checks the status of the execution of the statement with the specified statement handle. If the statement was executed successfully, the operation returns the requested partition of the result set. | requestId (string) partition (string) |
| sql_api/post_api_v2_statements | Submits one or more statements for execution. You can specify that the statement should be executed asynchronously. | requestId (string) async (string) nullable (string) data: { . statement (string) . timeout (integer) . database (string) . schema (string) . warehouse (string) . bindings (object) } (object) required |
| tag_api/get_api_v2_databases_database_schemas_schema_tags_name | Fetch a tag | No parameters |
| tag_api/delete_api_v2_databases_database_schemas_schema_tags_name | Delete a tag | ifExists (string) |
| tag_api/put_api_v2_databases_database_schemas_schema_tags_name | Create or update a tag | data: { . name (string) . allowed_values (array) . propagate (string) . on_conflict (string) . comment (string) } (object) required |
| tag_api/post_api_v2_databases_database_schemas_schema_tags_by_name_undrop | Undrop a tag | name (string) required |
| tag_api/post_api_v2_databases_database_schemas_schema_tags_by_name_rename | Rename a tag with a new identifier | name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| tag_api/get_api_v2_databases_database_schemas_schema_tags | List tags | like (string) |
| tag_api/post_api_v2_databases_database_schemas_schema_tags | Create a tag | createMode (string) data: { . name (string) . allowed_values (array) . propagate (string) . on_conflict (string) . comment (string) } (object) required |