> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-c8329da0.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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman1.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=65d256810e670208add0334718b2eade" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman2.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=446caace67dccacb4d28b28e516d418d" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=004a2241b310b1ec8fa9722844949305" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=280&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=6ef56d6da15b1d3da7d219fe642a27f2 280w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=560&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=c40832cbbf445839ab1c9e584ac805ca 560w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=840&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=b8193a35bc84753e9f7220ba0e842905 840w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=1100&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=4755e1bf325457625aa3be6fd1f09df2 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=1650&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=299dd63e76da7e1dc8e2b3f8194d4ee8 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman3.png?w=2500&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=63e44a478821e436e583620728c3d0c7 2500w" />

* A modal will appear:

<Image img="https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman4.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=0bafe43b4e9d219f8fb615668b117495" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=9dc63d6d676d83f1c1137f5f8dbf7c21" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=280&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=897e27bbaa7f4e4ba4a42ee807a5d3f3 280w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=560&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=627d57d47e4e5aa4f2c08b00c1bc0577 560w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=840&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=d1b20e7204e21134a3d3604c61588498 840w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=1100&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=428ef7604312c40554dcce14a7980f6a 1100w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=1650&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=6f98637ef222eb53466e5cc343b0f6b7 1650w, https://mintcdn.com/private-7c7dfe99-mintlify-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman6.png?w=2500&fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=425e628b214ef48995804e431fd01ed9 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman7.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=1147b1757b75c08e52e6248a48b94efd" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman8.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=266b15b57b7799d1387f4db90322890b" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman9.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=0131d169045256ca4e9bbab96de833fb" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman10.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=139a0032880a770a7f39903c3af784ed" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman11.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=56a9bc674828b6d7731dfb450744a5e8" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman12.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=fd89d9ae629cd14ea78b68b919f0dd65" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman13.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=58e1885423c6f781bbdf85fe2272a5f9" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman14.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=8a236769bc9f1a30fafc8b1463bb4bff" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman15.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=5c14fbfecae5fc900026be98f6bee10f" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman16.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=064ff0dc0b16529dc64aca5bff2c6c89" 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-c8329da0/uoY3m44caxU__xgc/images/cloud/manage/postman/postman17.png?fit=max&auto=format&n=uoY3m44caxU__xgc&q=85&s=d784c5cd4dbc5555b06e981dc47774b6" 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).
