Skip to content

Commit f7469d9

Browse files
committed
addressing documentation gap with minimum permissions
1 parent c66ffd1 commit f7469d9

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

docs/cloud/features/05_admin_features/api/openapi.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ This document covers the ClickHouse Cloud API. For database API endpoints, pleas
3434
<br/>
3535
:::note
3636
Permissions align with ClickHouse Cloud [predefined roles](/cloud/security/console-roles). The developer role has read-only permissions for assigned services and the admin role has full read and write permissions.
37+
:::
38+
39+
:::tip Query API Endpoints
40+
To use API keys with [Query API Endpoints](/cloud/get-started/query-endpoints), set Organization Role to `Member` (minimum) and grant Service Role access to `Query Endpoints`.
3741
:::
3842

3943
<Image img={image_03} size="md" alt="Create API key form" border/>

docs/cloud/guides/SQL_console/query-endpoints.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,15 @@ The **Query API Endpoints** feature allows you to create an API endpoint directl
2424
## Pre-requisites {#quick-start-guide}
2525

2626
Before proceeding, ensure you have:
27-
- an API key
28-
- an Admin Console Role.
27+
- An API key with appropriate permissions
28+
- An Admin Console Role
2929

3030
You can follow this guide to [create an API key](/cloud/manage/openapi) if you don't yet have one.
3131

32+
:::note Minimum permissions
33+
To query an API endpoint, the API key needs `Member` organization role with `Query Endpoints` service access. The database role is configured when you create the endpoint.
34+
:::
35+
3236
<VerticalStepper headerLevel="h3">
3337

3438
### Create a saved query {#creating-a-saved-query}

0 commit comments

Comments
 (0)