> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-3a82795f.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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=06616d3b273b52421a789c25ae5622fb" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=664be6cf52eabbbe8222c3bd71f567ee" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=0e7b6bb29c67c1000b475d21fdcedb21" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=6d6246c887b3ccaddbeb55d586dae805 280w, https://mintcdn.com/private-7c7dfe99-mintlify-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=2eff5d936a41ef51acdf00d9db1f2eee 560w, https://mintcdn.com/private-7c7dfe99-mintlify-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=4b92901819a01affd44e25a8400309ec 840w, https://mintcdn.com/private-7c7dfe99-mintlify-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=9bddbb6105aad8637ab715d49e1e8017 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=13c3356331005f9b4a8e577c31959414 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=007d535ea0e10a535f7c12561e85016b 2500w" />

* A modal will appear:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=c0d42156b4cc419769cb495567e4ed27" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=230664a91cba9cbd1705419a1b005816" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=ddf7581a014ce1445cbde9522483e686 280w, https://mintcdn.com/private-7c7dfe99-mintlify-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=b806590453edda8ccf43eb7ae96c8b33 560w, https://mintcdn.com/private-7c7dfe99-mintlify-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=78409e3cb231411c4a67563260ff642e 840w, https://mintcdn.com/private-7c7dfe99-mintlify-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=a960ef92df6e64fb7ea87df0af539ff7 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=37e087da4bb11c97387bc7cc256b84a0 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=61ef91578b23895db415be70b1e531ae 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=df92fe39371df63a49b6f3e07b512e17" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=8b0631f919b1f20ffde100824c4f0e4e" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=837c88b958c7ef6d2a2c635aefaea826" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=7f4341a1f23b5b776f74661954a13bdf" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=f4db88452688a0b9c1fb9bffc54eaf0f" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=1ca5c851502b0c1134b0f3ea11736133" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=cb84713523035dd7a5a5038f242e6b27" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=d2dc107754dab6b4ade1cc28d53ac22b" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=b18bc9163a66c0d4c7b82adac5c52a40" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=7e5278ba40e49f26704b432e1e978e25" 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-3a82795f/hIzR76_l6U8-lQLM/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=hIzR76_l6U8-lQLM&q=85&s=d8ef008a3af306aaa122234dd741df49" 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).
