Skip to main content
GET
Get list of keys
Returns a list of keys in the organization, ordered by creation date, oldest first. Results are capped at limit (default and maximum 250) per page. Every response carries limit, totalCount and nextCursor; pass nextCursor as the cursor query parameter to fetch the next page, repeating until it is null.

Permission

The API key must have the control-plane:organization:view-api-keys permission.

التفويضات

Authorization
string
header
مطلوب

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

معلمات المسار

organizationId
string<uuid>
مطلوب

ID of the requested organization.

معلمات الاستعلام

limit
integer
افتراضي:250

Maximum number of results to return.

النطاق المطلوب: 1 <= x <= 250
cursor
string

Opaque cursor from a previous response's nextCursor, marking where to resume the list.

الاستجابة

Successful response

status
number

HTTP status code.

مثال:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object[]
limit
integer

Maximum number of results returned in this page.

totalCount
integer

Total number of results across all pages.

nextCursor
string | null

Cursor for the next page, to be sent as the cursor query parameter. Null on the last page.

آخر تعديل في ١٨ سبتمبر ٢٠٢٦