> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-8a08bda2.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Programmatic API access with Postman

> This guide will help you test the ClickHouse Cloud API using Postman

export const Image = ({img, alt, size}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

This guide will help you test the ClickHouse Cloud API using [Postman](https://www.postman.com/product/what-is-postman/).
The Postman Application is available for use within a web browser or can be downloaded to a desktop.

<h3 id="create-an-account">
  Create an account
</h3>

* Free accounts are available at [https://www.postman.com](https://www.postman.com).

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=f87bbc07a7a53d7f81245d389f05083b" size="md" alt="Postman site" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.png" />

<h3 id="create-a-workspace">
  Create a workspace
</h3>

* Name your workspace and set the visibility level.

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=a565e399f31f7be6f4e3ebe2cc63d05f" size="md" alt="Create workspace" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.png" />

<h3 id="create-a-collection">
  Create a collection
</h3>

* Below "Explore" on the top left Menu click "Import":

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=62bbc6c2963ab4981a6a7ebde190af12" size="md" alt="Explore > Import" border data-og-width="1317" width="1317" data-og-height="647" height="647" data-path="images/cloud/manage/postman/postman3.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=78b01778898a61e22945b4d81c1f3342 280w, https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=a75fc55c5c11bc0b02b855cec07a91de 560w, https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=ad4b1c9005f9416bd4b02f98557b79ff 840w, https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=1f5312b0d9499209f0208691f6e87ecf 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=0c76e775973f8ad4a3aa330b5d0674b4 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=6143aa4d13c7ebc489ecc9b0e921661a 2500w" />

* A modal will appear:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=ed8fd6862bd605b3b98e202d1a0f04c5" size="md" alt="API URL entry" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.png" />

* Enter the API address: "[https://api.clickhouse.cloud/v1](https://api.clickhouse.cloud/v1)" and press 'Enter':

* Select "Postman Collection" by clicking on the "Import" button:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=12d48afeb2ccf390e79d28ad5c833f3e" size="md" alt="Collection > Import" border data-og-width="666" width="666" data-og-height="253" height="253" data-path="images/cloud/manage/postman/postman6.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=613ab186b30075b0eb40605e3ac090d4 280w, https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=97c1a2742c9eace2aee6cb17830aab7b 560w, https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=b8e8613a7f286fb517530201fc69feed 840w, https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=031b69415f2fcbc64c6ae9e83d0fe45d 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=edf39b5c8a212bdd0e977f5472ac8ff5 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=47df5f8253a4c5e778e6b34a9865b837 2500w" />

<h3 id="interface-with-the-clickhouse-cloud-api-spec">
  Interface with the ClickHouse Cloud API spec
</h3>

* The "API spec for ClickHouse Cloud" will now appear within "Collections" (Left Navigation).

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=7b2bcf241aa77b47b3a6febe7d1dfccb" size="md" alt="Import your API" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.png" />

* Click on "API spec for ClickHouse Cloud." From the middle pain select the 'Authorization' tab:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=9a8e045b62f4a142d790a5cd985765de" size="md" alt="Import complete" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.png" />

<h3 id="set-authorization">
  Set authorization
</h3>

* Toggle the dropdown menu to select "Basic Auth":

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=e56e7bd4561b2b891f2b65eb7dbb371b" size="md" alt="Basic auth" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.png" />

* Enter the Username and Password received when you set up your ClickHouse Cloud API keys:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=aaf255dc816283f0fc71d1798edc5a7f" size="md" alt="credentials" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.png" />

<h3 id="enable-variables">
  Enable variables
</h3>

* [Variables](https://learning.postman.com/docs/sending-requests/variables/) enable the storage and reuse of values in Postman allowing for easier API testing.

<h4 id="set-the-organization-id-and-service-id">
  Set the organization ID and Service ID
</h4>

* Within the "Collection", click the "Variable" tab in the middle pane (The Base URL will have been set by the earlier API import):
* Below `baseURL` click the open field "Add new value", and Substitute your organization ID and service ID:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=d23300848e061d59c49b909a4439bfde" size="md" alt="Organization ID and Service ID" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.png" />

<h2 id="test-the-clickhouse-cloud-api-functionalities">
  Test the ClickHouse Cloud API functionalities
</h2>

<h3 id="test-get-list-of-available-organizations">
  Test "GET list of available organizations"
</h3>

* Under the "OpenAPI spec for ClickHouse Cloud", expand the folder > V1 > organizations
* Click "GET list of available organizations" and press the blue "Send" button on the right:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=4eaff512c5ed4e3ec86a0986cfcda8a7" size="md" alt="Test retrieval of organizations" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.png" />

* The returned results should deliver your organization details with "status": 200. (If you receive a "status" 400 with no organization information your configuration isn't correct).

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=111faeeeb1424108e7c5e5aaacdf7175" size="md" alt="Status" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.png" />

<h3 id="test-get-organizational-details">
  Test "GET organizational details"
</h3>

* Under the `organizationid` folder, navigate to "GET organizational details":
* In the middle frame menu under Params an `organizationid` is required.

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=2724fb458e5dea7ce1737376ed4f4e06" size="md" alt="Test retrieval of organization details" border width="1797" height="972" data-path="images/cloud/manage/postman/postman14.png" />

* Edit this value with `orgid` in curly braces `{{orgid}}` (From setting this value earlier a menu will appear with the value):

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=4ae5465c30d631c510a7cff61a693b6c" size="md" alt="Submit test" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.png" />

* After pressing the "Save" button, press the blue "Send" button at the top right of the screen.

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=8f1e937a3ce093c4ce3503790e7a18df" size="md" alt="Return value" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.png" />

* The returned results should deliver your organization details with "status": 200. (If you receive a "status" 400 with no organization information your configuration isn't correct).

<h3 id="test-get-service-details">
  Test "GET service details"
</h3>

* Click "GET service details"
* Edit the Values for `organizationid` and `serviceid` with `{{orgid}}` and `{{serviceid}}` respectively.
* Press "Save" and then the blue "Send" button on the right.

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-8a08bda2/Crkay9vSr-K_Gf1T/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=Crkay9vSr-K_Gf1T&q=85&s=f34211c47ed2b94f0d6811453d46679a" size="md" alt="List of services" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.png" />

* The returned results should deliver a list of your services and their details with "status": 200. (If you receive a "status" 400 with no services information your configuration isn't correct).
