You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cloud/manage/openapi.md
+15-8Lines changed: 15 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,32 +4,39 @@ slug: /cloud/manage/openapi
4
4
title: Managing API Keys
5
5
---
6
6
7
-
ClickHouse Cloud provides an API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services.
7
+
import image_01 from '@site/static/images/cloud/manage/openapi1.png';
8
+
import image_02 from '@site/static/images/cloud/manage/openapi2.png';
9
+
import image_03 from '@site/static/images/cloud/manage/openapi3.png';
10
+
import image_04 from '@site/static/images/cloud/manage/openapi4.png';
11
+
import image_05 from '@site/static/images/cloud/manage/openapi5.png';
8
12
9
13
# Managing API Keys
10
14
15
+
ClickHouse Cloud provides an API utilizing OpenAPI that allows you to programmatically manage your account and aspects of your services.
16
+
11
17
:::note
12
18
This document covers the ClickHouse Cloud API. For database API endpoints, please see [Cloud Endpoints API](//cloud/get-started/query-endpoints.md)
13
19
:::
14
20
15
21
1. You can use the **API Keys** tab on the left menu to create and manage your API keys.
16
22
17
-

23
+
<imgsrc={image_01}width="50%"/>
18
24
19
25
2. The **API Keys** page will initially display a prompt to create your first API key as shown below. After your first key is created, you can create new keys using the `New API Key` button that appears in the top right corner.
20
26
21
-

27
+
<imgsrc={image_02}width="100%"/>
22
28
23
29
3. To create an API key, specify the key name, permissions for the key, and expiration time, then click `Generate API Key`.
30
+
<br/>
24
31
:::note
25
32
Permissions align with ClickHouse Cloud [predefined roles](/cloud/security/cloud-access-management#predefined-roles). The developer role has read-only permissions and the admin role has full read and write permissions.
26
33
:::
27
34
28
-

29
-
35
+
<imgsrc={image_03}width="100%"/>
36
+
30
37
4. The next screen will display your Key ID and Key secret. Copy these values and put them somewhere safe, such as a vault. The values will not be displayed after you leave this screen.
31
38
32
-

39
+
<imgsrc={image_04}width="100%"/>
33
40
34
41
5. The ClickHouse Cloud API uses [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) to verify the validity of your API keys. Here is an example of how to use your API keys to send requests to the ClickHouse Cloud API using `curl`:
6. Returning to the **API Keys** page, you will see the key name, last four characters of the Key ID, permissions, status, expiration date, and creator. You are able to edit the key name, permissions, and expiration from this screen. Keys may also be disabled or deleted form this screen.
44
-
51
+
<br/>
45
52
:::note
46
53
Deleting an API key is a permanent action. Any services using the key will immediately lose access to ClickHouse Cloud.
0 commit comments