> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-home-button.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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=77d3157a1cfe42f7e9b28c981a81935e" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=4131eaed5f5a1e2ddd3adcca933bb8da" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=44fbb20ba7036e2da71fc77c626795a1" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=b06045611848e39066fefd55d978f2a5 280w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=05e721ade1be264a4301a6be381ed1c3 560w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=669c4ff5117bb760981ecee813d4a490 840w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=18a3337f054e6dee7d55ad728cbd45ca 1100w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=86c34c1032b32abc61c597ac956e9e8b 1650w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=94e62964db90315641496541a4f62cf4 2500w" />

* A modal will appear:

<Image img="https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=5e16cfd929a754d87204fb811878001f" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=9d5ac92c7d0c15b4675913aebddc9fbc" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=42a2b0db5d51e1e314e0e66a3a019f47 280w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=5025d993d2303c81bdedeb1cfba17a34 560w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=153854c0e103ee8f0841167f5bcc8a1c 840w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=f30dbc5c2761b4f1c2a1dd23ac19017d 1100w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=eb24de1783e29f0e59f733450a3c1f48 1650w, https://mintcdn.com/private-7c7dfe99-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=ac6c8369b7caf9cfbfe71ed6a8ac3d75 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=f086508386a377720d146bcf8b9441b2" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=e1c17b85cc2b0ee664efb8d940ab041c" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=74da95f55efb73c8aa2d251da6c2f893" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=40fb93b899c532ed89e25e60d71ded6f" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=2286880fdfd03b7098021125a6236307" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=3b32e72c51d50157eedb7de366eac8cf" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=05c4e3e08c42c46ec3d18cae5f3fe03f" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=e0f4ff172530473943c3b56d7fb4d7fb" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=7ff48499b7cc734aa26a8bfd72a2a412" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=bfef37298052fce5568ae1081ce2417f" 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-home-button/q-fyjp7bh9TLY82A/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=q-fyjp7bh9TLY82A&q=85&s=7c72eb426205aced4a39c544e12f4805" 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).
