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 374 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_analyst_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| 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_chat_completions_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| 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_embed_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| 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_inference_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| 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_messages_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| cortex_search_rest_api/get_api_v2_databases_by_database_schemas_by_schema_cortex_search_services_by_name | Fetch a Cortex Search Service. | database (string) required schema (string) required name (string) required |
| cortex_search_rest_api/delete_api_v2_databases_by_database_schemas_by_schema_cortex_search_services_by_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. | database (string) required schema (string) required name (string) required ifExists (string) |
| cortex_search_rest_api/post_api_v2_databases_by_database_schemas_by_schema_cortex_search_services_by_service_name_query | Query a Cortex Search Service to get search results. | database (string) required schema (string) required 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_by_database_schemas_by_schema_cortex_search_services_by_service_name_suggest | Suggest from a Cortex Search Service to get auto-complete or contextual suggestions | database (string) required schema (string) required service_name (string) required data: { . query (string) . columns (array) . limit (integer) } (object) required |
| cortex_search_rest_api/post_api_v2_databases_by_database_schemas_by_schema_cortex_search_services_by_name_suspend | Suspends one or both of the indexing or serving targets of a cortex search service. | database (string) required schema (string) required name (string) required ifExists (string) target (string) |
| cortex_search_rest_api/post_api_v2_databases_by_database_schemas_by_schema_cortex_search_services_by_name_resume | Resume the cortex search service | database (string) required schema (string) required name (string) required ifExists (string) target (string) |
| cortex_search_rest_api/post_api_v2_databases_by_database_schemas_by_schema_cortex_search_services_by_name_feedback | Send user feedback for a Cortex Search result | database (string) required schema (string) required name (string) required data: { . request_id (string) . positive (boolean) . feedback_message (string) } (object) required |
| cortex_search_rest_api/get_api_v2_databases_by_database_schemas_by_schema_cortex_search_services | Lists the cortex search services under the database and schema. | database (string) required schema (string) required like (string) fromName (string) showLimit (string) |
| cortex_search_rest_api/post_api_v2_databases_by_database_schemas_by_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. | database (string) required schema (string) required 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 |
| cortex_search_rest_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| account_api/delete_api_v2_accounts_by_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. | name (string) required 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 |
| account_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| alert_api/get_api_v2_databases_by_database_schemas_by_schema_alerts_by_name | Fetch an alert | database (string) required schema (string) required name (string) required |
| alert_api/delete_api_v2_databases_by_database_schemas_by_schema_alerts_by_name | Delete an alert | database (string) required schema (string) required name (string) required ifExists (string) |
| alert_api/post_api_v2_databases_by_database_schemas_by_schema_alerts_by_name_clone | Create a new alert by cloning from the specified resource | database (string) required schema (string) required name (string) required createMode (string) targetDatabase (string) targetSchema (string) data: { . name (string) . point_of_time (object) } (object) required |
| alert_api/post_api_v2_databases_by_database_schemas_by_schema_alerts_by_name_execute | Execute an alert | database (string) required schema (string) required name (string) required |
| alert_api/get_api_v2_databases_by_database_schemas_by_schema_alerts | List alerts | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) |
| alert_api/post_api_v2_databases_by_database_schemas_by_schema_alerts | Create an alert | database (string) required schema (string) required createMode (string) data: { . name (string) . schedule (object) . condition (string) . action (string) . comment (string) . warehouse (string) } (object) required |
| alert_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| grant_api/delete_api_v2_grants_by_grantee_type_by_grantee_name_by_securable_type_by_securable_name_privileges_by_privilege_grant_option | Endpoint to indicate that the grant option for the privilege listed in the path should be revoked. | granteeType (string) required granteeName (string) required securableType (string) required securableName (string) required privilege (string) required deleteMode (string) |
| grant_api/delete_api_v2_grants_by_grantee_type_by_grantee_name_by_securable_type_by_securable_name_privileges_by_privilege | Endpoint to indicate that the privilege listed in the path should be revoked. | granteeType (string) required granteeName (string) required securableType (string) required securableName (string) required privilege (string) required deleteMode (string) |
| grant_api/post_api_v2_grants_by_grantee_type_by_grantee_name_by_securable_type_by_securable_name_privileges | Endpoint to indicate that the privileges listed in the request body should be granted. | granteeType (string) required granteeName (string) required securableType (string) required securableName (string) required 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_by_grantee_type_by_grantee_name_by_bulk_grant_type_by_securable_type_plural_by_scope_type_by_scope_name_privileges_by_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. | granteeType (string) required granteeName (string) required bulkGrantType (string) required securableTypePlural (string) required scopeType (string) required scopeName (string) required privilege (string) required deleteMode (string) |
| grant_api/delete_api_v2_grants_by_grantee_type_by_grantee_name_by_bulk_grant_type_by_securable_type_plural_by_scope_type_by_scope_name_privileges_by_privilege | Endpoint to indicate that the privilege listed on the group securable in the given scope should be revoked. | granteeType (string) required granteeName (string) required bulkGrantType (string) required securableTypePlural (string) required scopeType (string) required scopeName (string) required privilege (string) required deleteMode (string) |
| grant_api/post_api_v2_grants_by_grantee_type_by_grantee_name_by_bulk_grant_type_by_securable_type_plural_by_scope_type_by_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. | granteeType (string) required granteeName (string) required bulkGrantType (string) required securableTypePlural (string) required scopeType (string) required scopeName (string) required 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_by_grantee_type_by_grantee_name | List the roles and privileges granted to the specified grantee using the output of SHOW GRANTS TO | granteeType (string) required granteeName (string) required showLimit (string) |
| grant_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| managed_account_api/delete_api_v2_managed_accounts_by_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. | name (string) required |
| 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 |
| managed_account_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| network_policy_api/get_api_v2_network_policies_by_name | Fetch a network policy | name (string) required |
| network_policy_api/delete_api_v2_network_policies_by_name | Delete a network policy | name (string) required 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_policy_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| network_rule_api/get_api_v2_databases_by_database_schemas_by_schema_network_rules_by_name | Fetch a network rule | database (string) required schema (string) required name (string) required |
| network_rule_api/delete_api_v2_databases_by_database_schemas_by_schema_network_rules_by_name | Delete a network rule | database (string) required schema (string) required name (string) required ifExists (string) |
| network_rule_api/get_api_v2_databases_by_database_schemas_by_schema_network_rules | List network rules | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) |
| network_rule_api/post_api_v2_databases_by_database_schemas_by_schema_network_rules | Create a network rule | database (string) required schema (string) required createMode (string) data: { . type (string) . name (string) . mode (string) . value_list (array) . comment (string) } (object) required |
| network_rule_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| password_policy_api/get_api_v2_databases_by_database_schemas_by_schema_password_policies_by_name | Fetch a password policy | database (string) required schema (string) required name (string) required |
| password_policy_api/delete_api_v2_databases_by_database_schemas_by_schema_password_policies_by_name | Delete a password policy | database (string) required schema (string) required name (string) required ifExists (string) |
| password_policy_api/post_api_v2_databases_by_database_schemas_by_schema_password_policies_by_name_rename | Rename a password policy with a new identifier | database (string) required schema (string) required name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| password_policy_api/get_api_v2_databases_by_database_schemas_by_schema_password_policies | List password policies | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) |
| password_policy_api/post_api_v2_databases_by_database_schemas_by_schema_password_policies | Create a password policy | database (string) required schema (string) required 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 |
| password_policy_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| role_api/get_api_v2_roles_by_name_grants | List all grants to the role | name (string) required showLimit (string) |
| role_api/post_api_v2_roles_by_name_grants | Grant privileges to the role | name (string) required data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| role_api/post_api_v2_roles_by_name_grants_revoke | Revoke grants from the role | name (string) required mode (string) data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| role_api/get_api_v2_roles_by_name_grants_of | List all grants of the role | name (string) required showLimit (string) |
| role_api/get_api_v2_roles_by_name_grants_on | List all grants on the role | name (string) required showLimit (string) |
| role_api/get_api_v2_roles_by_name_future_grants | List all future grants to the role | name (string) required showLimit (string) |
| role_api/post_api_v2_roles_by_name_future_grants | Grant future privileges to the role | name (string) required data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| role_api/post_api_v2_roles_by_name_future_grants_revoke | Revoke future grants from the role | name (string) required mode (string) data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| role_api/delete_api_v2_roles_by_name | Delete a role | name (string) required 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 |
| role_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| secret_api/get_api_v2_databases_by_database_schemas_by_schema_secrets_by_name | Fetch a secret | database (string) required schema (string) required name (string) required |
| secret_api/delete_api_v2_databases_by_database_schemas_by_schema_secrets_by_name | Delete a secret | database (string) required schema (string) required name (string) required ifExists (string) |
| secret_api/get_api_v2_databases_by_database_schemas_by_schema_secrets | List secrets | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) |
| secret_api/post_api_v2_databases_by_database_schemas_by_schema_secrets | Create a secret | database (string) required schema (string) required createMode (string) data: { . type (string) . name (string) . comment (string) } (object) required |
| secret_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| user_api/get_api_v2_users_by_name_grants | List all grants to the user | name (string) required showLimit (string) |
| user_api/post_api_v2_users_by_name_grants | Grant a role to the user | name (string) required data: { . securable_type (string) . securable (object) . containing_scope (object) . privileges (array) } (object) required |
| user_api/post_api_v2_users_by_name_grants_revoke | Revoke grants from the user | name (string) required data: { . securable_type (string) . securable (object) . containing_scope (object) . privileges (array) } (object) required |
| user_api/get_api_v2_users_by_name | Fetch user information using the result of the DESCRIBE command | name (string) required |
| user_api/delete_api_v2_users_by_name | Delete a user with the given name. | name (string) required ifExists (string) |
| user_api/put_api_v2_users_by_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. | name (string) required 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) |
| user_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| 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_by_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. | name (string) required ignore_edition_check (string) data: { . accounts (array) } (object) required |
| database_api/post_api_v2_databases_by_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. | name (string) required data: { . accounts (array) } (object) required |
| database_api/post_api_v2_databases_by_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. | name (string) required |
| database_api/post_api_v2_databases_by_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. | name (string) required data: { . accounts (array) } (object) required |
| database_api/post_api_v2_databases_by_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. | name (string) required data: { . accounts (array) } (object) required |
| database_api/post_api_v2_databases_by_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. | name (string) required |
| database_api/get_api_v2_databases_by_name | Fetches a database. | name (string) required |
| database_api/put_api_v2_databases_by_name | Creates a new, or alters an existing, database. You must provide the full database definition even when altering an existing database. | name (string) required 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_by_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. | name (string) required 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_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| database_role_api/get_api_v2_databases_by_database_database_roles_by_name_grants | List all grants to the role | database (string) required name (string) required showLimit (string) |
| database_role_api/post_api_v2_databases_by_database_database_roles_by_name_grants | Grant privileges to the role | database (string) required name (string) required data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| database_role_api/post_api_v2_databases_by_database_database_roles_by_name_grants_revoke | Revoke grants from the role | database (string) required name (string) required 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_by_database_database_roles_by_name_future_grants | List all future grants to the role | database (string) required name (string) required showLimit (string) |
| database_role_api/post_api_v2_databases_by_database_database_roles_by_name_future_grants | Grant future privileges to the role | database (string) required name (string) required data: { . securable_type (string) . securable (object) . containing_scope (object) . grant_option (boolean) . privileges (array) } (object) required |
| database_role_api/post_api_v2_databases_by_database_database_roles_by_name_future_grants_revoke | Revoke future grants from the role | database (string) required name (string) required 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_by_database_database_roles_by_name | Delete a database role | database (string) required name (string) required ifExists (string) |
| database_role_api/post_api_v2_databases_by_database_database_roles_by_name_clone | Create a new database role by cloning from the specified resource | database (string) required name (string) required createMode (string) targetDatabase (string) data: { . name (string) } (object) required |
| database_role_api/get_api_v2_databases_by_database_database_roles | List database roles | database (string) required showLimit (string) fromName (string) |
| database_role_api/post_api_v2_databases_by_database_database_roles | Create a database role | database (string) required createMode (string) data: { . name (string) . comment (string) } (object) required |
| database_role_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| schema_api/post_api_v2_databases_by_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. | database (string) required 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_by_database_schemas_by_name_undrop | Undrops schema. | database (string) required name (string) required |
| schema_api/get_api_v2_databases_by_database_schemas_by_name | Fetches a schema. | database (string) required name (string) required |
| schema_api/put_api_v2_databases_by_database_schemas_by_name | Creates a new, or alters an existing, schema. You must provide the full schema definition even when altering an existing schema. | database (string) required name (string) required 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_by_database_schemas_by_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. | database (string) required name (string) required ifExists (string) restrict (string) |
| schema_api/get_api_v2_databases_by_database_schemas | Lists the accessible schemas. | database (string) required like (string) startsWith (string) showLimit (string) fromName (string) history (string) |
| schema_api/post_api_v2_databases_by_database_schemas | Creates a schema, with modifiers as query parameters. You must provide the full schema definition when creating a schema. | database (string) required 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 |
| schema_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables_by_name_as_select | Create a table as select. | database (string) required schema (string) required 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_by_database_schemas_by_schema_tables_by_name_using_template | Create a table using template. | database (string) required schema (string) required name (string) required createMode (string) copyGrants (string) query (string) |
| table_api/get_api_v2_databases_by_database_schemas_by_schema_tables_by_name | Fetch a Table using the describe command output. | database (string) required schema (string) required name (string) required |
| table_api/put_api_v2_databases_by_database_schemas_by_schema_tables_by_name | Create a or alter an existing table. Even if the operation is just an alter, the full property set must be provided. | database (string) required schema (string) required name (string) required 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_by_database_schemas_by_schema_tables_by_name | Delete a table with the given name. | database (string) required schema (string) required name (string) required ifExists (string) |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables_by_name_clone | Create a new table by cloning from the specified resource | database (string) required schema (string) required 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_by_database_schemas_by_schema_tables_by_name_create_like | Create a new table like the specified resource, but empty | database (string) required schema (string) required name (string) required createMode (string) copyGrants (string) newTableName (string) |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables_by_name_create_like | Create a new table like the specified resource, but empty | database (string) required schema (string) required name (string) required createMode (string) copyGrants (string) data: { . name (string) } (object) required |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables_by_name_undrop | Undrop specified table | database (string) required schema (string) required name (string) required |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables_by_name_suspend_recluster | Suspend recluster of a table | database (string) required schema (string) required name (string) required ifExists (string) |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables_by_name_suspend_recluster | Suspend recluster of a table | database (string) required schema (string) required name (string) required ifExists (string) |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables_by_name_resume_recluster | Resume recluster of a table | database (string) required schema (string) required name (string) required ifExists (string) |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables_by_name_resume_recluster | Resume recluster of a table | database (string) required schema (string) required name (string) required ifExists (string) |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables_by_name_swapwith | Swap with another table | database (string) required schema (string) required name (string) required ifExists (string) targetTableName (string) |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables_by_name_swap_with | Swap with another table | database (string) required schema (string) required name (string) required ifExists (string) targetName (string) targetDatabase (string) targetSchema (string) |
| table_api/get_api_v2_databases_by_database_schemas_by_schema_tables | Lists the tables under the database and schema. | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) history (string) deep (string) |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables | Create a table. | database (string) required schema (string) required 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_by_database_schemas_by_schema_tables_as_select | Create a table as select. | database (string) required schema (string) required createMode (string) copyGrants (string) query (string) data: { . name (string) . columns (array) . cluster_by (array) } (object) required |
| table_api/post_api_v2_databases_by_database_schemas_by_schema_tables_using_template | Create a table using template. | database (string) required schema (string) required createMode (string) copyGrants (string) query (string) data: { . name (string) } (object) required |
| table_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| dynamic_table_api/get_api_v2_databases_by_database_schemas_by_schema_dynamic_tables_by_name | Fetch a Dynamic Table. | database (string) required schema (string) required name (string) required |
| dynamic_table_api/delete_api_v2_databases_by_database_schemas_by_schema_dynamic_tables_by_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. | database (string) required schema (string) required name (string) required ifExists (string) |
| dynamic_table_api/post_api_v2_databases_by_database_schemas_by_schema_dynamic_tables_by_name_clone | Create a new dynamic table by cloning from the specified resource | database (string) required schema (string) required 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_by_database_schemas_by_schema_dynamic_tables_by_name_undrop | Undrop specified dynamic table | database (string) required schema (string) required name (string) required |
| dynamic_table_api/post_api_v2_databases_by_database_schemas_by_schema_dynamic_tables_by_name_suspend | Suspend refreshes on the dynamic table | database (string) required schema (string) required name (string) required ifExists (string) |
| dynamic_table_api/post_api_v2_databases_by_database_schemas_by_schema_dynamic_tables_by_name_resume | Resume refreshes on the dynamic table | database (string) required schema (string) required name (string) required ifExists (string) |
| dynamic_table_api/post_api_v2_databases_by_database_schemas_by_schema_dynamic_tables_by_name_refresh | Specifies that the dynamic table should be manually refreshed | database (string) required schema (string) required name (string) required ifExists (string) |
| dynamic_table_api/post_api_v2_databases_by_database_schemas_by_schema_dynamic_tables_by_name_suspend_recluster | Suspend recluster of a dynamic table | database (string) required schema (string) required name (string) required ifExists (string) |
| dynamic_table_api/post_api_v2_databases_by_database_schemas_by_schema_dynamic_tables_by_name_resume_recluster | Resume recluster of a dynamic table | database (string) required schema (string) required name (string) required ifExists (string) |
| dynamic_table_api/post_api_v2_databases_by_database_schemas_by_schema_dynamic_tables_by_name_swap_with | Swap with another dynamic table | database (string) required schema (string) required name (string) required ifExists (string) targetName (string) targetDatabase (string) targetSchema (string) |
| dynamic_table_api/get_api_v2_databases_by_database_schemas_by_schema_dynamic_tables | Lists the dynamic tables under the database and schema. | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) deep (string) |
| dynamic_table_api/post_api_v2_databases_by_database_schemas_by_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. | database (string) required schema (string) required 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 |
| dynamic_table_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| event_table_api/get_api_v2_databases_by_database_schemas_by_schema_event_tables_by_name | Fetch an event table | database (string) required schema (string) required name (string) required |
| event_table_api/delete_api_v2_databases_by_database_schemas_by_schema_event_tables_by_name | Delete an event table | database (string) required schema (string) required name (string) required ifExists (string) |
| event_table_api/post_api_v2_databases_by_database_schemas_by_schema_event_tables_by_name_rename | Rename the event table | database (string) required schema (string) required name (string) required ifExists (string) targetName (string) |
| event_table_api/get_api_v2_databases_by_database_schemas_by_schema_event_tables | List event tables | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) |
| event_table_api/post_api_v2_databases_by_database_schemas_by_schema_event_tables | Create an event table | database (string) required schema (string) required 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 |
| event_table_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| iceberg_table_api/get_api_v2_databases_by_database_schemas_by_schema_iceberg_tables_by_name | Describe an iceberg table | database (string) required schema (string) required name (string) required |
| iceberg_table_api/delete_api_v2_databases_by_database_schemas_by_schema_iceberg_tables_by_name | Drop an iceberg table | database (string) required schema (string) required name (string) required ifExists (string) type (string) |
| iceberg_table_api/post_api_v2_databases_by_database_schemas_by_schema_iceberg_tables_by_name_resume_recluster | Resume recluster of an iceberg table iceberg tables managed by an external catalog do not allow clustering | database (string) required schema (string) required name (string) required ifExists (string) |
| iceberg_table_api/post_api_v2_databases_by_database_schemas_by_schema_iceberg_tables_by_name_suspend_recluster | Suspend recluster of an iceberg table iceberg tables managed by an external catalog do not allow clustering | database (string) required schema (string) required name (string) required ifExists (string) |
| iceberg_table_api/post_api_v2_databases_by_database_schemas_by_schema_iceberg_tables_by_name_refresh | Refreshes the metadata for an Apache Iceberg table that uses an external Iceberg catalog | database (string) required schema (string) required name (string) required ifExists (string) data: { . metadata_file_relative_path (string) } (object) required |
| iceberg_table_api/post_api_v2_databases_by_database_schemas_by_schema_iceberg_tables_by_name_convert_to_managed | Convert unmanaged iceberg table to managed iceberg table | database (string) required schema (string) required name (string) required ifExists (string) data: { . base_location (string) . storage_serialization_policy (string) } (object) required |
| iceberg_table_api/post_api_v2_databases_by_database_schemas_by_schema_iceberg_tables_by_name_undrop | Undrop an iceberg table | database (string) required schema (string) required name (string) required |
| iceberg_table_api/post_api_v2_databases_by_database_schemas_by_schema_iceberg_tables_by_name_clone | Clone a snowflake managed iceberg table | database (string) required schema (string) required 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_by_database_schemas_by_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. | database (string) required schema (string) required 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_by_database_schemas_by_schema_iceberg_tables | Lists the Apache Iceberg™ tables for which you have access privileges. | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) deep (string) |
| iceberg_table_api/post_api_v2_databases_by_database_schemas_by_schema_iceberg_tables | Create a snowflake managed iceberg table clone and undrop are separate subresources | database (string) required schema (string) required 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_by_database_schemas_by_schema_iceberg_tables_as_select | Create a snowflake managed iceberg table as select | database (string) required schema (string) required 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_by_database_schemas_by_schema_iceberg_tables_from_aws_glue_catalog | Create an unmanaged iceberg table from AWS Glue catalog | database (string) required schema (string) required 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_by_database_schemas_by_schema_iceberg_tables_from_delta | Create an unmanaged iceberg table from Delta | database (string) required schema (string) required 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_by_database_schemas_by_schema_iceberg_tables_from_iceberg_files | Create an unmanaged iceberg table from Iceberg files | database (string) required schema (string) required 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_by_database_schemas_by_schema_iceberg_tables_from_iceberg_rest | Create an unmanaged iceberg table from Iceberg REST | database (string) required schema (string) required 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/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| view_api/get_api_v2_databases_by_database_schemas_by_schema_views_by_name | Fetch a view | database (string) required schema (string) required name (string) required |
| view_api/delete_api_v2_databases_by_database_schemas_by_schema_views_by_name | Delete a view | database (string) required schema (string) required name (string) required ifExists (string) |
| view_api/get_api_v2_databases_by_database_schemas_by_schema_views | List views | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) deep (string) |
| view_api/post_api_v2_databases_by_database_schemas_by_schema_views | Create a view | database (string) required schema (string) required createMode (string) copyGrants (string) data: { . name (string) . columns (array) . query (string) . secure (boolean) . kind (string) . recursive (boolean) . comment (string) } (object) required |
| view_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| pipe_api/get_api_v2_databases_by_database_schemas_by_schema_pipes_by_name | Fetch a pipe | database (string) required schema (string) required name (string) required |
| pipe_api/delete_api_v2_databases_by_database_schemas_by_schema_pipes_by_name | Delete a pipe | database (string) required schema (string) required name (string) required ifExists (string) |
| pipe_api/post_api_v2_databases_by_database_schemas_by_schema_pipes_by_name_refresh | Refresh the pipe | database (string) required schema (string) required name (string) required ifExists (string) prefix (string) modified_after (string) |
| pipe_api/get_api_v2_databases_by_database_schemas_by_schema_pipes | List pipes | database (string) required schema (string) required like (string) |
| pipe_api/post_api_v2_databases_by_database_schemas_by_schema_pipes | Create a pipe | database (string) required schema (string) required createMode (string) data (string) required |
| pipe_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| stage_api/post_api_v2_databases_by_database_schemas_by_schema_stages_by_name_files_by_file_path_presigned_url | Generate a presigned url and optionally encryption materials for uploading and downloading files. | database (string) required schema (string) required name (string) required filePath (string) required data: { . expiration_time (integer) } (object) required |
| stage_api/get_api_v2_databases_by_database_schemas_by_schema_stages_by_name_files | List files in the stage -- this is equivalent to LIST @stage. | database (string) required schema (string) required name (string) required pattern (string) |
| stage_api/get_api_v2_databases_by_database_schemas_by_schema_stages_by_name | Fetch a stage using the describe command output. | database (string) required schema (string) required name (string) required |
| stage_api/delete_api_v2_databases_by_database_schemas_by_schema_stages_by_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. | database (string) required schema (string) required name (string) required ifExists (string) |
| stage_api/get_api_v2_databases_by_database_schemas_by_schema_stages | Lists stages under the database and schema, with show options as query parameters. | database (string) required schema (string) required like (string) |
| stage_api/post_api_v2_databases_by_database_schemas_by_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. | database (string) required schema (string) required createMode (string) data: { . name (string) } (object) required |
| stage_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| stream_api/get_api_v2_databases_by_database_schemas_by_schema_streams_by_name | Fetch a stream | database (string) required schema (string) required name (string) required |
| stream_api/delete_api_v2_databases_by_database_schemas_by_schema_streams_by_name | Delete a stream | database (string) required schema (string) required name (string) required ifExists (string) |
| stream_api/post_api_v2_databases_by_database_schemas_by_schema_streams_by_name_clone | Clone a stream | database (string) required schema (string) required name (string) required createMode (string) targetDatabase (string) targetSchema (string) copyGrants (string) data: { . name (string) . comment (string) } (object) required |
| stream_api/get_api_v2_databases_by_database_schemas_by_schema_streams | List streams | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) |
| stream_api/post_api_v2_databases_by_database_schemas_by_schema_streams | Create a stream | database (string) required schema (string) required createMode (string) copyGrants (string) data: { . name (string) . stream_source (object) . comment (string) } (object) required |
| stream_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| task_api/get_api_v2_databases_by_database_schemas_by_schema_tasks_by_name_dependents | This operation returns a list of the dependent tasks of the task with identifier name. | database (string) required schema (string) required name (string) required recursive (string) |
| task_api/get_api_v2_databases_by_database_schemas_by_schema_tasks_by_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. | database (string) required schema (string) required name (string) required resultLimit (string) |
| task_api/get_api_v2_databases_by_database_schemas_by_schema_tasks_by_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. | database (string) required schema (string) required name (string) required resultLimit (string) |
| task_api/get_api_v2_databases_by_database_schemas_by_schema_tasks_by_name_complete_graphs | This function returns details for graph runs that are completed. | database (string) required schema (string) required name (string) required resultLimit (string) errorOnly (string) |
| task_api/get_api_v2_databases_by_database_schemas_by_schema_tasks_by_name_complete_graphs | This function returns details for graph runs that are completed. | database (string) required schema (string) required name (string) required resultLimit (string) errorOnly (string) |
| task_api/get_api_v2_databases_by_database_schemas_by_schema_tasks_by_name | Fetch a task using the describe command output. | database (string) required schema (string) required name (string) required |
| task_api/put_api_v2_databases_by_database_schemas_by_schema_tasks_by_name | Create a or alter an existing task. Even if the operation is just an alter, the full property set must be provided. | database (string) required schema (string) required name (string) required 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_by_database_schemas_by_schema_tasks_by_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. | database (string) required schema (string) required name (string) required ifExists (string) |
| task_api/post_api_v2_databases_by_database_schemas_by_schema_tasks_by_name_execute | Execute a task -- this is equivalent to EXECUTE IMMEDIATE. | database (string) required schema (string) required name (string) required asyncExec (string) retryLast (string) |
| task_api/post_api_v2_databases_by_database_schemas_by_schema_tasks_by_name_resume | Resumes a suspended task object. This is equivalento an ALTER TASK ... RESUME. | database (string) required schema (string) required name (string) required |
| task_api/post_api_v2_databases_by_database_schemas_by_schema_tasks_by_name_suspend | Suspends a running task. This is equivalent to an ALTER TASK ... SUSPEND. | database (string) required schema (string) required name (string) required |
| task_api/get_api_v2_databases_by_database_schemas_by_schema_tasks | Lists tasks under the database and schema, with show options as query parameters. | database (string) required schema (string) required rootOnly (string) like (string) startsWith (string) showLimit (string) fromName (string) |
| task_api/post_api_v2_databases_by_database_schemas_by_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. | database (string) required schema (string) required createMode (string) data: { . name (string) . warehouse (string) . schedule (object) . predecessors (array) . comment (string) . definition (string) } (object) required |
| task_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| function_api/get_api_v2_databases_by_database_schemas_by_schema_functions_by_name_with_args | Fetch a Function using the describe command output. | database (string) required schema (string) required nameWithArgs (string) required |
| function_api/delete_api_v2_databases_by_database_schemas_by_schema_functions_by_name_with_args | Delete a function with the given name and args. | database (string) required schema (string) required nameWithArgs (string) required ifExists (string) |
| function_api/post_api_v2_databases_by_database_schemas_by_schema_functions_by_name_execute | Execute a Function. | database (string) required schema (string) required name (string) required data (array) required |
| function_api/get_api_v2_databases_by_database_schemas_by_schema_functions | Lists the user functions under the database and schema. | database (string) required schema (string) required like (string) |
| function_api/post_api_v2_databases_by_database_schemas_by_schema_functions | Create a function. | database (string) required schema (string) required 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 |
| function_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| procedure_api/get_api_v2_databases_by_database_schemas_by_schema_procedures_by_name_with_args | Fetch a procedure | database (string) required schema (string) required nameWithArgs (string) required |
| procedure_api/delete_api_v2_databases_by_database_schemas_by_schema_procedures_by_name_with_args | Delete a procedure | database (string) required schema (string) required nameWithArgs (string) required ifExists (string) |
| procedure_api/post_api_v2_databases_by_database_schemas_by_schema_procedures_by_name_with_args_call | Call a procedure | database (string) required schema (string) required nameWithArgs (string) required data: { . call_arguments (array) } (object) required |
| procedure_api/get_api_v2_databases_by_database_schemas_by_schema_procedures | List procedures | database (string) required schema (string) required like (string) |
| procedure_api/post_api_v2_databases_by_database_schemas_by_schema_procedures | Create a procedure | database (string) required schema (string) required 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 |
| procedure_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| user_defined_function_api/get_api_v2_databases_by_database_schemas_by_schema_user_defined_functions_by_name_with_args | Fetch a UDF | database (string) required schema (string) required nameWithArgs (string) required |
| user_defined_function_api/delete_api_v2_databases_by_database_schemas_by_schema_user_defined_functions_by_name_with_args | Delete a UDF | database (string) required schema (string) required nameWithArgs (string) required ifExists (string) |
| user_defined_function_api/post_api_v2_databases_by_database_schemas_by_schema_user_defined_functions_by_name_execute | Execute a UDF. | database (string) required schema (string) required name (string) required data (array) required |
| user_defined_function_api/post_api_v2_databases_by_database_schemas_by_schema_user_defined_functions_by_name_with_args_rename | Rename a UDF | database (string) required schema (string) required nameWithArgs (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| user_defined_function_api/post_api_v2_databases_by_database_schemas_by_schema_user_defined_functions | Create a UDF | database (string) required schema (string) required 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_by_database_schemas_by_schema_user_defined_functions | List UDFs | database (string) required schema (string) required like (string) |
| user_defined_function_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| sequence_api/get_api_v2_databases_by_database_schemas_by_schema_sequences_by_name | Fetch a sequence | database (string) required schema (string) required name (string) required |
| sequence_api/delete_api_v2_databases_by_database_schemas_by_schema_sequences_by_name | Delete a sequence | database (string) required schema (string) required name (string) required ifExists (string) |
| sequence_api/post_api_v2_databases_by_database_schemas_by_schema_sequences_by_name_clone | Create a new sequence by cloning from the specified resource | database (string) required schema (string) required 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_by_database_schemas_by_schema_sequences_by_name_rename | Rename a sequence with a new identifier | database (string) required schema (string) required name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| sequence_api/get_api_v2_databases_by_database_schemas_by_schema_sequences | List sequences | database (string) required schema (string) required like (string) |
| sequence_api/post_api_v2_databases_by_database_schemas_by_schema_sequences | Create a sequence | database (string) required schema (string) required createMode (string) data: { . name (string) . start (integer) . increment (integer) . ordered (boolean) . comment (string) } (object) required |
| sequence_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| api_integration_api/get_api_v2_api_integrations_by_name | Fetch an API integration | name (string) required |
| api_integration_api/put_api_v2_api_integrations_by_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. | name (string) required 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_by_name | Delete an API integration | name (string) required 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 |
| api_integration_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| catalog_integration_api/get_api_v2_catalog_integrations_by_name | Fetch a catalog integration. | name (string) required |
| catalog_integration_api/delete_api_v2_catalog_integrations_by_name | Delete a catalog integration. | name (string) required 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 |
| catalog_integration_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| notification_integration_api/get_api_v2_notification_integrations_by_name | Fetch a notification integration | name (string) required |
| notification_integration_api/delete_api_v2_notification_integrations_by_name | Delete a notification integration | name (string) required 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 |
| notification_integration_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| external_volume_api/get_api_v2_external_volumes_by_name | Fetch an external volume | name (string) required |
| external_volume_api/delete_api_v2_external_volumes_by_name | Delete an external volume | name (string) required 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 |
| external_volume_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| warehouse_api/get_api_v2_warehouses_by_name | Describes the warehouse, show information of the chosen warehouse. Equivalent to DESCRIBE WAREHOUSE in SQL. | name (string) required |
| warehouse_api/delete_api_v2_warehouses_by_name | Removes the specified virtual warehouse from the system. Equivalent to DROP WAREHOUSE in SQL. | name (string) required ifExists (string) |
| warehouse_api/put_api_v2_warehouses_by_name | Create a or alter an existing warehouse. Even if the operation is just an alter, the full property set must be provided. | name (string) required 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) |
| warehouse_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| compute_pools_api/get_api_v2_compute_pools_by_name | Fetches a named compute pool. You can get the name of the compute pool from the /api/v2/compute-pools GET request. | name (string) required |
| compute_pools_api/put_api_v2_compute_pools_by_name | Create a or alter an existing compute pool. Even if the operation is just an alter, the full property set must be provided. | name (string) required 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_by_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. | name (string) required 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 |
| compute_pools_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| notebook_api/get_api_v2_databases_by_database_schemas_by_schema_notebooks_by_name | Fetch a notebook | database (string) required schema (string) required name (string) required |
| notebook_api/delete_api_v2_databases_by_database_schemas_by_schema_notebooks_by_name | Delete a notebook | database (string) required schema (string) required name (string) required ifExists (string) |
| notebook_api/post_api_v2_databases_by_database_schemas_by_schema_notebooks_by_name_execute | Execute a Notebook | database (string) required schema (string) required name (string) required asyncExec (string) |
| notebook_api/post_api_v2_databases_by_database_schemas_by_schema_notebooks_by_name_rename | Changes the name of the notebook to new name. The new identifier must be unique for the schema. | database (string) required schema (string) required name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| notebook_api/post_api_v2_databases_by_database_schemas_by_schema_notebooks_by_name_add_live_version | Adds a LIVE version to the notebook | database (string) required schema (string) required name (string) required fromLast (string) comment (string) |
| notebook_api/post_api_v2_databases_by_database_schemas_by_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 | database (string) required schema (string) required name (string) required version (string) comment (string) |
| notebook_api/get_api_v2_databases_by_database_schemas_by_schema_notebooks | List notebooks | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) |
| notebook_api/post_api_v2_databases_by_database_schemas_by_schema_notebooks | Create a notebook | database (string) required schema (string) required 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 |
| notebook_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| services_api/get_api_v2_databases_by_database_schemas_by_schema_services_by_name_logs | Fetch the logs for a given service. | database (string) required schema (string) required name (string) required instanceId (string) containerName (string) numLines (string) |
| services_api/get_api_v2_databases_by_database_schemas_by_schema_services_by_name_status | Fetch the status for a given service. Deprecated - use listServiceContainers instead. | database (string) required schema (string) required name (string) required timeout (string) |
| services_api/get_api_v2_databases_by_database_schemas_by_schema_services_by_name_containers | List all the containers of the service | database (string) required schema (string) required name (string) required |
| services_api/get_api_v2_databases_by_database_schemas_by_schema_services_by_name_instances | List all the instances of the service | database (string) required schema (string) required name (string) required |
| services_api/get_api_v2_databases_by_database_schemas_by_schema_services_by_name_roles | List all the service roles of the service | database (string) required schema (string) required name (string) required |
| services_api/get_api_v2_databases_by_database_schemas_by_schema_services_by_name_endpoints | Lists the endpoints in a Snowpark Container Services service or a job service. | database (string) required schema (string) required name (string) required |
| services_api/get_api_v2_databases_by_database_schemas_by_schema_services_by_name | Fetch a service. | database (string) required schema (string) required name (string) required |
| services_api/put_api_v2_databases_by_database_schemas_by_schema_services_by_name | Create a or alter an existing service. Even if the operation is just an alter, the full property set must be provided. | database (string) required schema (string) required name (string) required 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_by_database_schemas_by_schema_services_by_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. | database (string) required schema (string) required name (string) required ifExists (string) |
| services_api/get_api_v2_databases_by_database_schemas_by_schema_services_by_service_roles_by_name_grants_of | List all the grants of the service role | database (string) required schema (string) required service (string) required name (string) required |
| services_api/get_api_v2_databases_by_database_schemas_by_schema_services_by_service_roles_by_name_grants | List all the grants given to the service role | database (string) required schema (string) required service (string) required name (string) required |
| services_api/post_api_v2_databases_by_database_schemas_by_schema_services_by_name_resume | Resume a service. | database (string) required schema (string) required name (string) required ifExists (string) |
| services_api/post_api_v2_databases_by_database_schemas_by_schema_services_by_name_suspend | Suspend a service. | database (string) required schema (string) required name (string) required ifExists (string) |
| services_api/get_api_v2_databases_by_database_schemas_by_schema_services | Lists the services under the database and schema. | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) |
| services_api/post_api_v2_databases_by_database_schemas_by_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. | database (string) required schema (string) required 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_by_database_schemas_by_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. | database (string) required schema (string) required data: { . name (string) . compute_pool (string) . spec (object) } (object) required |
| services_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| streamlit_api/get_api_v2_databases_by_database_schemas_by_schema_streamlits_by_name | Fetch detailed information about a specific Streamlit by name, including metadata, configuration, and version details. | database (string) required schema (string) required name (string) required |
| streamlit_api/delete_api_v2_databases_by_database_schemas_by_schema_streamlits_by_name | Delete a Streamlit. The Streamlit can be restored using undrop within the retention period. | database (string) required schema (string) required name (string) required ifExists (string) |
| streamlit_api/post_api_v2_databases_by_database_schemas_by_schema_streamlits_by_name_undrop | Restore a previously deleted Streamlit within the retention period. | database (string) required schema (string) required name (string) required |
| streamlit_api/post_api_v2_databases_by_database_schemas_by_schema_streamlits_by_name_rename | Rename a Streamlit to a new name, optionally in a different database or schema. | database (string) required schema (string) required name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| streamlit_api/post_api_v2_databases_by_database_schemas_by_schema_streamlits_by_name_add_live_version | Add a live version to the Streamlit, making a specific version active for users. | database (string) required schema (string) required name (string) required fromLast (string) data: { . version (object) } (object) required |
| streamlit_api/post_api_v2_databases_by_database_schemas_by_schema_streamlits_by_name_commit | If a Git connection is set up, commit the LIVE version of the Streamlit to the Git repository. | database (string) required schema (string) required name (string) required data: { . version (object) } (object) required |
| streamlit_api/post_api_v2_databases_by_database_schemas_by_schema_streamlits_by_name_add_version | Add a new version to the Streamlit by copying files from a specified stage location. | database (string) required schema (string) required name (string) required data: { . source_location (string) . version (object) } (object) required |
| streamlit_api/post_api_v2_databases_by_database_schemas_by_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. | database (string) required schema (string) required name (string) required data: { . version (object) . git_ref (string) } (object) required |
| streamlit_api/post_api_v2_databases_by_database_schemas_by_schema_streamlits_by_name_abort | Abort the live version of the Streamlit, discarding uncommitted changes if a Git connection is configured. | database (string) required schema (string) required name (string) required |
| streamlit_api/post_api_v2_databases_by_database_schemas_by_schema_streamlits_by_name_pull | Pull the latest changes from the Git repository for a Streamlit with Git integration. | database (string) required schema (string) required name (string) required |
| streamlit_api/post_api_v2_databases_by_database_schemas_by_schema_streamlits_by_name_push | Push committed changes from the Streamlit back to its connected Git repository. | database (string) required schema (string) required name (string) required data: { . auth_type (string) } (object) required |
| streamlit_api/get_api_v2_databases_by_database_schemas_by_schema_streamlits | List Streamlits in a schema. Supports filtering with pattern matching. | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) |
| streamlit_api/post_api_v2_databases_by_database_schemas_by_schema_streamlits | Create a new Streamlit application, or replace an existing one. Supports CREATE, CREATE OR REPLACE, and CREATE IF NOT EXISTS modes. | database (string) required schema (string) required 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 |
| streamlit_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| 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 |
| spark_connect_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| artifact_repository_api/get_api_v2_databases_by_database_schemas_by_schema_artifact_repositories_by_name | Fetch an artifact repository | database (string) required schema (string) required name (string) required |
| artifact_repository_api/delete_api_v2_databases_by_database_schemas_by_schema_artifact_repositories_by_name | Delete an artifact repository | database (string) required schema (string) required name (string) required ifExists (string) |
| artifact_repository_api/put_api_v2_databases_by_database_schemas_by_schema_artifact_repositories_by_name | Create or update an artifact repository | database (string) required schema (string) required name (string) required data: { . name (string) . type (string) . api_integration (string) . comment (string) } (object) required |
| artifact_repository_api/post_api_v2_databases_by_database_schemas_by_schema_artifact_repositories_by_name_rename | Changes the name of an artifact repository | database (string) required schema (string) required name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| artifact_repository_api/get_api_v2_databases_by_database_schemas_by_schema_artifact_repositories | List artifact repositories | database (string) required schema (string) required like (string) startsWith (string) showLimit (string) fromName (string) |
| artifact_repository_api/post_api_v2_databases_by_database_schemas_by_schema_artifact_repositories | Create an artifact repository | database (string) required schema (string) required createMode (string) data: { . name (string) . type (string) . api_integration (string) . comment (string) } (object) required |
| artifact_repository_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| image_repository_api/get_api_v2_databases_by_database_schemas_by_schema_image_repositories_by_name_images | List images in the given image repository. | database (string) required schema (string) required name (string) required |
| image_repository_api/get_api_v2_databases_by_database_schemas_by_schema_image_repositories_by_name | Fetches a named image repository in a specified database and schema. | database (string) required schema (string) required name (string) required |
| image_repository_api/delete_api_v2_databases_by_database_schemas_by_schema_image_repositories_by_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. | database (string) required schema (string) required name (string) required ifExists (string) |
| image_repository_api/get_api_v2_databases_by_database_schemas_by_schema_image_repositories | Lists the image repositories under a specified database and schema. | database (string) required schema (string) required like (string) |
| image_repository_api/post_api_v2_databases_by_database_schemas_by_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. | database (string) required schema (string) required createMode (string) data (object) required |
| image_repository_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| result_api/get_api_v2_results_by_result_handler | Get result status or the result when it is ready. | result_handler (string) required page (string) |
| result_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| sql_api/post_api_v2_statements_by_statement_handle_cancel | Cancels the execution of the statement with the specified statement handle. | statementHandle (string) required requestId (string) |
| sql_api/get_api_v2_statements_by_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. | statementHandle (string) required 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 |
| sql_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| tag_api/get_api_v2_databases_by_database_schemas_by_schema_tags_by_name | Fetch a tag | database (string) required schema (string) required name (string) required |
| tag_api/delete_api_v2_databases_by_database_schemas_by_schema_tags_by_name | Delete a tag | database (string) required schema (string) required name (string) required ifExists (string) |
| tag_api/put_api_v2_databases_by_database_schemas_by_schema_tags_by_name | Create or update a tag | database (string) required schema (string) required name (string) required data: { . name (string) . allowed_values (array) . propagate (string) . on_conflict (string) . comment (string) } (object) required |
| tag_api/post_api_v2_databases_by_database_schemas_by_schema_tags_by_name_undrop | Undrop a tag | database (string) required schema (string) required name (string) required |
| tag_api/post_api_v2_databases_by_database_schemas_by_schema_tags_by_name_rename | Rename a tag with a new identifier | database (string) required schema (string) required name (string) required ifExists (string) targetDatabase (string) targetSchema (string) targetName (string) |
| tag_api/get_api_v2_databases_by_database_schemas_by_schema_tags | List tags | database (string) required schema (string) required like (string) |
| tag_api/post_api_v2_databases_by_database_schemas_by_schema_tags | Create a tag | database (string) required schema (string) required createMode (string) data: { . name (string) . allowed_values (array) . propagate (string) . on_conflict (string) . comment (string) } (object) required |
| tag_api/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |