Skip to content

addressing documentation gap with minimum permissions #4718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 7, 2025
+10 −2
Merged

addressing documentation gap with minimum permissions #4718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/cloud/features/05_admin_features/api/openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ This document covers the ClickHouse Cloud API. For database API endpoints, pleas
<br/>
:::note
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.
:::

:::tip Query API Endpoints
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`.
:::

<Image img={image_03} size="md" alt="Create API key form" border/>
Expand Down
8 changes: 6 additions & 2 deletions docs/cloud/guides/SQL_console/query-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,15 @@ The **Query API Endpoints** feature allows you to create an API endpoint directl
## Pre-requisites {#quick-start-guide}

Before proceeding, ensure you have:
- an API key
- an Admin Console Role.
- An API key with appropriate permissions
- An Admin Console Role

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

:::note Minimum permissions
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.
:::

<VerticalStepper headerLevel="h3">

### Create a saved query {#creating-a-saved-query}
Expand Down