How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Aiven Service:_ClickHouse API

The Service:_ClickHouse API from Aiven — 8 operation(s) for service:_clickhouse.

Aiven Service:_ClickHouse API is one of 34 APIs that Aiven publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Service:_ClickHouse. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 8 JSON Schemas.

This API exposes 11 operations across 8 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.aiven.io/v1.

11 operations 8 paths 15 schemas 2 DELETE5 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.aiven.io/v1
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Aiven Service:_ClickHouse API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (tokenAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 34 scopes.

  • tokenAuth — Header should be of the format authorization: aivenv1 . Tokens can be obtained from [your Aiven profile page](https://console.aiven.io/profile/auth)
  • oauth2 — OAuth2 security scheme

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Service:_ClickHouse 11
GET
/project/{project}/service/{service_name}/clickhouse/query
List active queries
ServiceClickHouseCurrentQueries 2 params → 200
POST
/project/{project}/service/{service_name}/clickhouse/query
Execute an SQL query
ServiceClickHouseQuery 2 params body → 200
POST
/project/{project}/service/{service_name}/clickhouse/db
Create a database
ServiceClickHouseDatabaseCreate 2 params body → 200
GET
/project/{project}/service/{service_name}/clickhouse/db
List all databases
ServiceClickHouseDatabaseList 2 params → 200
DELETE
/project/{project}/service/{service_name}/clickhouse/db/{database}
Delete a database
ServiceClickHouseDatabaseDelete 3 params → 200
PUT
/project/{project}/service/{service_name}/clickhouse/user/{user_uuid}/password
Reset a user's password
ServiceClickHousePasswordReset 3 params body → 200
GET
/project/{project}/service/{service_name}/clickhouse/query/stats
Return statistics on recent queries
ServiceClickHouseQueryStats 5 params → 200
GET
/project/{project}/service/{service_name}/clickhouse/tiered-storage/summary
Get the ClickHouse tiered storage summary
ServiceClickHouseTieredStorageSummary 2 params → 200
POST
/project/{project}/service/{service_name}/clickhouse/user
Create a ClickHouse user
ServiceClickHouseUserCreate 2 params body → 200
GET
/project/{project}/service/{service_name}/clickhouse/user
List all users
ServiceClickHouseUserList 2 params → 200
DELETE
/project/{project}/service/{service_name}/clickhouse/user/{user_uuid}
Delete a user
ServiceClickHouseUserDelete 3 params → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ServiceClickHouseTieredStorageSummaryResponse (7 properties), ServiceClickHouseQueryResponse (5 properties), ServiceClickHouseUserCreateResponse (3 properties), ServiceClickHouseQueryStatsResponse (3 properties). Each schema is shown below with its type and property counts.

ServiceClickHouseQueryRequestBody
object
ServiceClickHouseQueryRequestBody
2 properties 2 required
ServiceClickHouseDatabaseListResponse
object
ServiceClickHouseDatabaseListResponse
3 properties 1 required
ServiceClickHouseQueryResponse
object
ServiceClickHouseQueryResponse
5 properties 3 required
ServiceClickHouseDatabaseCreateResponse
object
ServiceClickHouseDatabaseCreateResponse
2 properties
ServiceClickHousePasswordResetRequestBody
object
ServiceClickHousePasswordResetRequestBody
1 property 1 required
ServiceClickHouseTieredStorageSummaryResponse
object
ServiceClickHouseTieredStorageSummaryResponse
7 properties 4 required
ServiceClickHouseUserCreateRequestBody
object
ServiceClickHouseUserCreateRequestBody
3 properties 1 required
ServiceClickHouseUserDeleteResponse
object
ServiceClickHouseUserDeleteResponse
2 properties
ServiceClickHouseCurrentQueriesResponse
object
ServiceClickHouseCurrentQueriesResponse
3 properties 1 required
ServiceClickHouseDatabaseDeleteResponse
object
ServiceClickHouseDatabaseDeleteResponse
2 properties
ServiceClickHouseDatabaseCreateRequestBody
object
ServiceClickHouseDatabaseCreateRequestBody
1 property 1 required
ServiceClickHouseQueryStatsResponse
object
ServiceClickHouseQueryStatsResponse
3 properties 1 required
ServiceClickHouseUserCreateResponse
object
ServiceClickHouseUserCreateResponse
3 properties 1 required
ServiceClickHousePasswordResetResponse
object
ServiceClickHousePasswordResetResponse
3 properties 1 required
ServiceClickHouseUserListResponse
object
ServiceClickHouseUserListResponse
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aiven-service-clickhouse-api-openapi.yml Raw ↑

Other APIs Aiven publishes across the network.

Aiven Account API
Aiven Application_Users API
Aiven Authentication_Methods API
Aiven Billing API
Aiven BillingGroup API
Aiven Cloud_platforms API
Aiven Custom_Cloud API
Aiven Domains API
Aiven Groups API
Aiven Organization_Vpc API
Aiven OrganizationBillingGroup API
Aiven OrganizationEmissions API
Where this information came from

This is an independent, third-party profile of Aiven Service:_ClickHouse API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.