> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/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 = "lg", background}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  const backgroundColor = background === "white" ? "white" : background === "black" ? "rgb(31 31 28)" : undefined;
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} style={{
    backgroundColor
  }} />
      </Frame>
    </div>;
};

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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=59508fae391eb40fb756da88e4032a9e" size="md" alt="Postman site" border width="1621" height="1011" data-path="images/cloud/manage/postman/postman1.webp" />

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

* Name your workspace and set the visibility level.

<Image img="https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=112347769f74f2563d07b0a99061cbd5" size="md" alt="Create workspace" border width="784" height="760" data-path="images/cloud/manage/postman/postman2.webp" />

<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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=1a576f9f10f3ee038bcb0f5c06a50bc2" 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.webp" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=d854b7c9a82cf6cd49e836dd32966890 280w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=d98a75bd864a0e7a71e6d2634bff4b7a 560w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=dd6e86cadde7a4faac270b1501f2e187 840w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=e64f6320cb9a825875ce94e552f7dae1 1100w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=71f54f26d8fba7721f5990f5f46c8e1b 1650w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=d8a2a7004b43d9f63aade8d9f1e9f6d5 2500w" />

* A modal will appear:

<Image img="https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=6f9e34f97280f9515da3676a5f65ea4c" size="md" alt="API URL entry" border width="659" height="471" data-path="images/cloud/manage/postman/postman4.webp" />

* 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=8fe55b5ba2b222670095ab0122d408ab" 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.webp" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=f12850997a5c6e76056cf7ce4897e7d4 280w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=be1c7738a41de9c0b1f8fa62e4cb2e6e 560w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=ea2c1039a4e245566376d3ddf20ad60b 840w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=448f167cc43a46532059afb6cfaab45e 1100w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=12a420a9e97f1095cb15e52bf9838393 1650w, https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=50208f625ca3aac230da9101d978176c 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=8c0f73f0ff6a24c698ccf22e4b6514de" size="md" alt="Import your API" border width="949" height="446" data-path="images/cloud/manage/postman/postman7.webp" />

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

<Image img="https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=d74102fc0b5a837eb6385629a6d492a0" size="md" alt="Import complete" border width="872" height="420" data-path="images/cloud/manage/postman/postman8.webp" />

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

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

<Image img="https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=592e15688e4f26177aeb15c9015a95a6" size="md" alt="Basic auth" border width="789" height="620" data-path="images/cloud/manage/postman/postman9.webp" />

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

<Image img="https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=348536953f0b43d0714e3890e33fc04a" size="md" alt="credentials" border width="951" height="700" data-path="images/cloud/manage/postman/postman10.webp" />

<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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=e119d6b68387b6f95d890fdbbdcb3954" size="md" alt="Organization ID and Service ID" border width="1057" height="558" data-path="images/cloud/manage/postman/postman11.webp" />

<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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=36cae3b48811b1def044251605a8db12" size="md" alt="Test retrieval of organizations" border width="1797" height="972" data-path="images/cloud/manage/postman/postman12.webp" />

* 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=c558c3ed61fa7b982f2ca1396872c3f5" size="md" alt="Status" border width="1797" height="972" data-path="images/cloud/manage/postman/postman13.webp" />

<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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=98494b844580046b28fb3597c000f39a" size="md" alt="Test retrieval of organization details" border width="1797" height="972" data-path="images/cloud/manage/postman/postman14.webp" />

* 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=0144e4613b6b4a98b4cd397c3ad3abe8" size="md" alt="Submit test" border width="1797" height="972" data-path="images/cloud/manage/postman/postman15.webp" />

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

<Image img="https://mintcdn.com/private-7c7dfe99/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=ece5268a49ab8bffc287b70b835579f3" size="md" alt="Return value" border width="1797" height="972" data-path="images/cloud/manage/postman/postman16.webp" />

* 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/96hCVnfqPOLWGWdD/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=96hCVnfqPOLWGWdD&q=85&s=da0680d69e598e90bed0e362dc83ae27" size="md" alt="List of services" border width="1537" height="867" data-path="images/cloud/manage/postman/postman17.webp" />

* 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).
