> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-revert-149-feat-homepage-below-hero.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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=68c1ee770a532be60c7501643fbd3543" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=a2a77ec90ee794c510df23e4a7b6c65d" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=c0960e79f12784fdeb8a528fbb11a0f1" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=b2bb9c2c44ac8eaa5e66ab7ed495102f 280w, https://mintcdn.com/private-7c7dfe99-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=85617dbcb1c07149a18ab2b8cf08dee5 560w, https://mintcdn.com/private-7c7dfe99-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=dc145f1124768b2408c8aec91370bb48 840w, https://mintcdn.com/private-7c7dfe99-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=f7702a5cb7151f1ca6506657732f7c83 1100w, https://mintcdn.com/private-7c7dfe99-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=98663fb27e5b9675f097146bd08ef667 1650w, https://mintcdn.com/private-7c7dfe99-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=005c00fb5872275a6e20f2a4c42a7d04 2500w" />

* A modal will appear:

<Image img="https://mintcdn.com/private-7c7dfe99-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=94fefe0d0df769fe514b8c267d389259" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=f63dd877dd98d6e31c27c42c44efa490" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=39f740e656f57b974f86a53cee4898aa 280w, https://mintcdn.com/private-7c7dfe99-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=1cd9306110cb20a3e6039ead1d46ae97 560w, https://mintcdn.com/private-7c7dfe99-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=d35b8c1d20d4681ea92f08be0658d924 840w, https://mintcdn.com/private-7c7dfe99-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=abe942b91a904ee1d084196aeb81834f 1100w, https://mintcdn.com/private-7c7dfe99-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=759eaae7e8458b072f3a8a604e8da205 1650w, https://mintcdn.com/private-7c7dfe99-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=f44ed637cef8c424e4d7ee560e326896 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=e3929d256cde9688d12b25a9cd2069c9" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=457841af0becd0d86d26c992bee745e8" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=4eba41787f49854ecef52d3db4b10569" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=1d654cda8e3b3f04b61475b32b18d77c" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=b2096097008525f92df27bd9ea2bc6a6" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=363b9cd11f2f23989edae2e925e3f02c" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=7c8c4e793ee834358f9ef2861ac8f564" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=e157f60d5c0a14e405812c15bcf4747e" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=31e7a39989285b10fb4f297730fc134e" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=92f3655ee6fed6d571419a472d355fd4" 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-revert-149-feat-homepage-below-hero/lLMR1-wvVctNtJka/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=lLMR1-wvVctNtJka&q=85&s=2034b10804d9491c40945d699ea373a6" 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).
