Update a Query API endpoint
Disclaimer: This beta endpoint is evolving; the API contract may change.
Updates a Query API endpoint.
PUT
Update a Query API endpoint
Beta
Disclaimer: This beta endpoint is evolving; the API contract may change.
Updates a Query API endpoint.
Updates a Query API endpoint.
Authorizations
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi
Path Parameters
ID of the requested organization.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$ID of the requested service.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$ID of the requested Query API endpoint.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$Body
application/json
Name of the Query API endpoint.
Minimum string length:
1Pattern:
\SSQL executed by the endpoint.
Maximum string length:
4194304Pattern:
\SDatabase used by the Query API endpoint.
Pattern:
\SAPI key IDs allowed to call the endpoint.
Minimum array length:
1Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$Database roles used by the endpoint.
Minimum array length:
1Minimum string length:
1Default query parameters.
Origins allowed by the endpoint CORS policy.
Response
The Query API endpoint was updated.
Last modified on September 14, 2026