<section id="common-setup-for-snowflake-rest-apis-tutorials">
<h1>Common setup for Snowflake REST APIs tutorials<a class="headerlink" href="#common-setup-for-snowflake-rest-apis-tutorials" title="Link to this heading" data-nosnippet="">¶</a></h1>

<section id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading" data-nosnippet="">¶</a></h2>
This topic provides instructions for the common setup required for all Snowflake REST APIs tutorials available in this documentation.
<aside class="newfeat sidebar">
Feature — Generally Available
The Snowflake REST APIs are supported in government regions, but some resources are currently not available in government regions.
</aside>
<section id="overview-of-the-sf-rest">
<h3>Overview of the Snowflake REST APIs<a class="headerlink" href="#overview-of-the-sf-rest" title="Link to this heading" data-nosnippet="">¶</a></h3>
Before starting your setup, take a look at the Snowflake REST APIs.
The Snowflake REST APIs supports the following resources through the corresponding APIs. The APIs support CREATE OR ALTER operations for applicable resources.
<ul class="simple">
<li>Working with accounts
<ul>
<li><a class="reference internal" href="../account/account-introduction">Accounts</a></li>
<li><a class="reference internal" href="../managed-account/managed-account-introduction">Managed accounts</a></li>
</ul>
</li>
<li>Working with users, roles, and privileges
<ul>
<li><a class="reference internal" href="../users/users-introduction">Users</a></li>
<li><a class="reference internal" href="../roles/roles-introduction">Roles</a></li>
<li><a class="reference internal" href="../database-role/database-role-introduction">Database roles</a></li>
<li><a class="reference internal" href="../grants/grants-introduction">Grants</a></li>
</ul>
</li>
<li>Managing virtual warehouses
<ul>
<li><a class="reference internal" href="../warehouses/warehouses-introduction">Warehouses</a></li>
</ul>
</li>
<li>Working with databases and schemas
<ul>
<li><a class="reference internal" href="../databases/db-introduction">Databases</a></li>
<li><a class="reference internal" href="../schemas/schemas-introduction">Schemas</a></li>
</ul>
</li>
<li>Managing tables and views
<ul>
<li><a class="reference internal" href="../tables/tables-introduction">Tables</a></li>
<li><a class="reference internal" href="../dynamic-tables/dynamic-tables-introduction">Dynamic tables</a></li>
<li><a class="reference internal" href="../event-table/event-table-introduction">Event tables</a></li>
<li><a class="reference internal" href="../view/view-introduction">Views</a></li>
</ul>
</li>
<li>Loading and unloading data
<ul>
<li><a class="reference internal" href="../stages/stages-introduction">Stages</a></li>
<li><a class="reference internal" href="../external-volume/external-volume-introduction">External volumes</a></li>
<li><a class="reference internal" href="../pipe/pipe-introduction">Pipes</a></li>
</ul>
</li>
<li>Managing notebooks
<ul>
<li><a class="reference internal" href="../notebook/notebook-introduction">Notebooks</a></li>
</ul>
</li>
<li>Working with Snowpark Container Services
<ul>
<li><a class="reference internal" href="../compute-pools/cp-introduction">Compute Pools</a></li>
<li><a class="reference internal" href="../image-repositories/images-introduction">Image Repositories</a></li>
<li><a class="reference internal" href="../services/services-introduction">Services</a></li>
</ul>
</li>
<li>Using functions and procedures
<ul>
<li><a class="reference internal" href="../functions/functions-introduction">Functions</a></li>
<li><a class="reference internal" href="../user-defined-function/user-defined-function-introduction">User-defined functions</a></li>
<li><a class="reference internal" href="../procedure/procedure-introduction">Procedures</a></li>
</ul>
</li>
<li>Managing security
<ul>
<li><a class="reference internal" href="../network-policy/network-policy-introduction">Network policies</a></li>
</ul>
</li>
<li>Managing alerts
<ul>
<li><a class="reference internal" href="../alert/alert-introduction">Alerts</a></li>
</ul>
</li>
<li>Leveraging AI/ML
<ul>
<li><a class="reference internal" href="../cortex-inference/cortex-inference-introduction">Cortex Inference</a></li>
<li><a class="reference internal" href="../cortex-search/cortex-search-introduction">Cortex Search Service</a></li>
</ul>
</li>
<li>Managing streams and tasks
<ul>
<li><a class="reference internal" href="../stream/stream-introduction">Streams</a></li>
<li><a class="reference internal" href="../tasks/tasks-introduction">Tasks</a></li>
</ul>
</li>
<li>Managing integrations
<ul>
<li><a class="reference internal" href="../catalog-integration/catalog-integration-introduction">Catalog Integration</a></li>
<li><a class="reference internal" href="../notification-integration/notification-integration-introduction">Notification</a></li>
</ul>
</li>
</ul>
For reference information about the APIs and their endpoints, see <a class="reference internal" href="../reference">Snowflake REST APIs reference</a>.
<div class="admonition tip">
Tip
If you prefer writing Python applications, you can use the Snowflake Python APIs to manage Snowflake objects. For more information, see <a class="reference internal" href="../../snowflake-python-api/snowflake-python-overview">Snowflake Python APIs: Managing Snowflake objects with Python</a>.
</div>
</section>
</section>
<section id="import-the-snowflake-rest-apis-collections">
<h2>Import the Snowflake REST APIs collections<a class="headerlink" href="#import-the-snowflake-rest-apis-collections" title="Link to this heading" data-nosnippet="">¶</a></h2>
This tutorial walks you through the process of importing the Snowflake REST APIs collections from Postman.
<ol class="arabic">
<li>Download the API collections from the <a class="reference external" href="https://github.com/snowflakedb/snowflake-rest-api-specs/tree/main/collections">Git repository</a> into a folder.
<figure class="align-default">
<img alt="../../../_images/api-collections-git.png" src="../../../_images/api-collections-git.png">
</figure>
</li>
<li>Open the Postman application, and create an account, if necessary.</li>
<li>In Postman, open the desired workspace.
<figure class="align-default">
<img alt="../../../_images/postman-workspace.png" src="../../../_images/postman-workspace.png">
</figure>
</li>
<li>Select Import.
<figure class="align-default">
<img alt="../../../_images/postman-import-workspace.png" src="../../../_images/postman-import-workspace.png">
</figure>
</li>
<li>Select folders.
<figure class="align-default">
<img alt="../../../_images/postman-download-collections.png" src="../../../_images/postman-download-collections.png">
</figure>
</li>
<li>In the dialog, select the folder where you extracted the collection, and select Open.
<figure class="align-default">
<img alt="../../../_images/postman-import-elements.png" src="../../../_images/postman-import-elements.png">
</figure>
</li>
<li>Verify that all of the items are selected, and select Import.
You should see the collections listed in the left panel, as shown:
<figure class="align-default">
<img alt="../../../_images/postman-verify-import.png" src="../../../_images/postman-verify-import.png">
</figure>
</li>
</ol>
</section>
<section id="specify-the-bearer-token-in-postman">
<h2>Specify the bearer token in Postman<a class="headerlink" href="#specify-the-bearer-token-in-postman" title="Link to this heading" data-nosnippet="">¶</a></h2>
REST requests require a JWT token in the request header to authenticate the request. If you don’t have a JWT token, see <a class="reference internal" href="../authentication.html#label-sfrest-api-jwt-token">Generate a JWT token</a>.
In Postman, you can copy the JWT token into the <code class="docutils literal notranslate">bearerToken</code> header property, as shown.
<figure class="align-default">
<img alt="../../../_images/postman-bearer-token.png" src="../../../_images/postman-bearer-token.png">
</figure>
<div class="admonition note">
Note
As mentioned in the tutorial <a class="reference internal" href="../tutorials-overview">prerequisites</a>, you must define an AUTHENTICATION POLICY. If you receive an error message similar to <code class="code docutils literal notranslate">{ "code": "390202", "message": "Authentication attempt rejected by the current authentication policy." }</code>, you can run the following SQL command to define a policy:
<div class="relative group text-sm"><div class="highlight-sqlsyntax notranslate"><div class="highlight"><pre>SHOW AUTHENTICATION POLICIES; alter AUTHENTICATION POLICY &lt;your authentication policy&gt; set AUTHENTICATION_METHODS = ('KEYPAIR', 'PASSWORD', 'OAUTH');
</pre></div>
</div><div data-codeblock-index="0" class="copybutton"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 384 512" class="copybutton-icon icon-copy"><path d="M192 0c-41.8 0-77.4 26.7-90.5 64H64C28.7 64 0 92.7 0 128V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V128c0-35.3-28.7-64-64-64H282.5C269.4 26.7 233.8 0 192 0zm0 64a32 32 0 1 1 0 64 32 32 0 1 1 0-64zM112 192H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 512" class="copybutton-icon icon-copied hidden"><path d="M470.6 105.4c12.5 12.5 12.5 32.8 0 45.3l-256 256c-12.5 12.5-32.8 12.5-45.3 0l-128-128c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0L192 338.7 425.4 105.4c12.5-12.5 32.8-12.5 45.3 0z"></path></svg>Copy</div></div>
</div>
</section>
<section id="set-environment-variables-in-the-postman-environment">
<h2>Set environment variables in the Postman environment<a class="headerlink" href="#set-environment-variables-in-the-postman-environment" title="Link to this heading" data-nosnippet="">¶</a></h2>
You can set environment variables in your Postman environment. You can then use these variables in Postman, in the form <code class="code nowrap docutils literal notranslate">{{variable_name}}</code>.
All endpoint URLs begin with a <code class="code nowrap docutils literal notranslate">baseURL</code>, which identifies your Snowflake account. The baseURL has the form: <code class="code nowrap docutils literal notranslate">&lt;account_locator&gt;.snowflakecomputing.com</code>, where <code class="code nowrap docutils literal notranslate">&lt;account_locator&gt;</code> is your Snowflake account name.
To set the <code class="code nowrap docutils literal notranslate">baseURL</code> variable, as well as any other variables, in Postman, enable each parameter and set its value, as shown:
<figure class="align-default">
<img alt="../../../_images/postman-env-vars.png" src="../../../_images/postman-env-vars.png">
</figure>
For each value you set, you must select Save to save the new value.
</section>
<section id="what-s-next">
<h2>What’s next?<a class="headerlink" href="#what-s-next" title="Link to this heading" data-nosnippet="">¶</a></h2>
Congratulations! In this tutorial, you learned the fundamentals for managing Snowflake database, schema, and table resources using the Snowflake REST APIs.
<section id="summary">
<h3>Summary<a class="headerlink" href="#summary" title="Link to this heading" data-nosnippet="">¶</a></h3>
Along the way, you completed the following steps:
<ul class="simple">
<li>Import Snowflake REST APIs collections.</li>
<li>Specify a bearer token in Postman.</li>
<li>Set environment variables in the Postman environment.</li>
</ul>
</section>
<section id="next-tutorial">
<h3>Next tutorial<a class="headerlink" href="#next-tutorial" title="Link to this heading" data-nosnippet="">¶</a></h3>
You can now proceed to <a class="reference internal" href="tutorial-1">Tutorial 1: Create and manage databases, schemas, and tables</a>, which shows you how to create and manage Snowflake databases, schemas, and tables.
</section>
</section>
</section>

This tutorial provides instructions for the common setup required for all Snowflake REST APIs tutorials.