Programmatic API access with Postman

[Edit this page](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/cloud/features/06_admin_features/api/postman.md)

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.

### Create an account[​](#create-an-account "Direct link to Create an account")

- Free accounts are available at <https://www.postman.com>.

### Create a workspace[​](#create-a-workspace "Direct link to Create a workspace")

- Name your workspace and set the visibility level.

### Create a collection[​](#create-a-collection "Direct link to Create a collection")

- Below "Explore" on the top left Menu click "Import":

- A modal will appear:

- Enter the API address: "<https://api.clickhouse.cloud/v1>" and press 'Enter':
- Select "Postman Collection" by clicking on the "Import" button:

### Interface with the ClickHouse Cloud API spec[​](#interface-with-the-clickhouse-cloud-api-spec "Direct link to Interface with the ClickHouse Cloud API spec")

- The "API spec for ClickHouse Cloud" will now appear within "Collections" (Left Navigation).

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

### Set authorization[​](#set-authorization "Direct link to Set authorization")

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

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

### Enable variables[​](#enable-variables "Direct link to Enable variables")

- [Variables](https://learning.postman.com/docs/sending-requests/variables/) enable the storage and reuse of values in Postman allowing for easier API testing.

#### Set the organization ID and Service ID[​](#set-the-organization-id-and-service-id "Direct link to Set the organization ID and Service ID")

- 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:

## Test the ClickHouse Cloud API functionalities[​](#test-the-clickhouse-cloud-api-functionalities "Direct link to Test the ClickHouse Cloud API functionalities")

### Test "GET list of available organizations"[​](#test-get-list-of-available-organizations "Direct link to Test \"GET list of available organizations\"")

- 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:

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

### Test "GET organizational details"[​](#test-get-organizational-details "Direct link to Test \"GET organizational details\"")

- Under the `organizationid` folder, navigate to "GET organizational details":
- In the middle frame menu under Params an `organizationid` is required.

- Edit this value with `orgid` in curly braces `{{orgid}}` (From setting this value earlier a menu will appear with the value):

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

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

### Test "GET service details"[​](#test-get-service-details "Direct link to Test \"GET service details\"")

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

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

- [Create an account](#create-an-account)- [Create a workspace](#create-a-workspace)- [Create a collection](#create-a-collection)- [Interface with the ClickHouse Cloud API spec](#interface-with-the-clickhouse-cloud-api-spec)- [Set authorization](#set-authorization)- [Enable variables](#enable-variables)- [Test the ClickHouse Cloud API functionalities](#test-the-clickhouse-cloud-api-functionalities)
              - [Test "GET list of available organizations"](#test-get-list-of-available-organizations)- [Test "GET organizational details"](#test-get-organizational-details)- [Test "GET service details"](#test-get-service-details)

Was this page helpful?