> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-revert-104359-revert-104251-parquet-single.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 = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman1.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=a83e85bab1c9478ae60b28debee354b2" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman2.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=05d9395d9bbd3f2e46bd83afd7102caa" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=86ce94530dc6d7cb5da51ce1b51114d5" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=280&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=7b18c9b2a26eca9dcbdd780ac11882d4 280w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=560&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=142cb6eb42e69d071edf36fa467c1f4f 560w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=840&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=6c58fb4c3beef4015530c82557d66ba2 840w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=1100&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=d81c9c9658a3ba004379eb80de219b2b 1100w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=1650&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=b7209dadddebba5f4fbacf92266bb066 1650w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman3.webp?w=2500&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=beb45a440573031b4f91ba9746648379 2500w" />

* A modal will appear:

<Image img="https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman4.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=a102d3495baea7db3f8415851922adfc" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=5aeb544cb6e4aa206e259235fcf1d3ec" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=280&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=a4444e0c3ce8d64cde3e77e0b2563077 280w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=560&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=ba03723432e19d2e321faea706d00392 560w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=840&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=c79b13133b70b7f780f60628611d1dc1 840w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=1100&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=4a8d03af4463b1963d82f03665b025a9 1100w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=1650&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=62c56593e6ab60f29d99629c3a938868 1650w, https://mintcdn.com/private-7c7dfe99-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman6.webp?w=2500&fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=bf96c32c57a46060627d6a1085742b8f 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-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman7.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=106b05bb49433c944fc7c2f599eceefc" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman8.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=5bc05781c5b4efba03b70765b874ccfd" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman9.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=44ec6fbe17b3f31cd4b6dc0671fe2ae9" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman10.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=4d4483bd24291db81680101b27085e8e" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman11.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=91355d46e8fac8d57c0d617e657ec3a9" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman12.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=96ff4d7ea740cc25ce4fb31256e43f29" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman13.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=949424cb663899a2c913b1b5b621acf4" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman14.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=358d1e8b53819a44ea9a5b35aedd3300" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman15.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=11b67ee3957f28aa2cd605bc4f13e951" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman16.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=97d42e302acf56c88ba8b5eaeb197659" 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-revert-104359-revert-104251-parquet-single/Py9QrBolpS4H74Ee/images/cloud/manage/postman/postman17.webp?fit=max&auto=format&n=Py9QrBolpS4H74Ee&q=85&s=73c2790abde9d00ddfb5904c02c1aa53" 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).
