data
ClickHouse Cloud Lua API for KosmoKrator Agents
Agent-facing Lua documentation and function reference for the ClickHouse Cloud KosmoKrator integration.Lua Namespace
Agents call this integration through app.integrations.clickhouse_cloud.*.
Use lua_read_doc("integrations.clickhouse-cloud") inside KosmoKrator to discover the same reference at runtime.
Call Lua from the Headless CLI
Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic
ClickHouse Cloud workflow without starting an interactive agent session.
kosmo integrations:lua --eval 'dump(app.integrations.clickhouse_cloud.get_list_available_organizations({}))' --json kosmo integrations:lua --eval 'print(docs.read("clickhouse-cloud"))' --json
kosmo integrations:lua --eval 'print(docs.read("clickhouse-cloud.get_list_available_organizations"))' --json Workflow file
Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.
local clickhouse_cloud = app.integrations.clickhouse_cloud
local result = clickhouse_cloud.get_list_available_organizations({})
dump(result) kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json integrations:lua exposes app.integrations.clickhouse_cloud, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.clickhouse_cloud.default.* or app.integrations.clickhouse_cloud.work.* when you configured named credential accounts.
MCP-only Lua
If the script only needs configured MCP servers and does not need ClickHouse Cloud, use the narrower mcp:lua command.
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json Agent-Facing Lua Docs
This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.
ClickHouse Cloud Lua API
Generated from the official ClickHouse Cloud OpenAPI document at https://api.clickhouse.cloud/v1. The namespace is app.integrations["clickhouse-cloud"].
This package exposes 96 endpoint-specific tools: 43 read tools and 53 write tools. Use a ClickHouse Cloud API key ID and key secret; the integration sends them with HTTP Basic authentication.
Usage
local organizations = app.integrations["clickhouse-cloud"].organization_get_list({})
local service = app.integrations["clickhouse-cloud"].instance_get({
organization_id = "00000000-0000-0000-0000-000000000000",
service_id = "11111111-1111-1111-1111-111111111111"
})
Request Bodies
Tools that create, update, patch, or delete resources may accept a body table. The table is passed as the JSON body exactly as expected by the ClickHouse Cloud OpenAPI schema. Path and query arguments use snake_case names, while the service maps them back to the official API names.
Example Tools
| clickhouse_cloud_organization_get_list | read | GET /v1/organizations |
| clickhouse_cloud_organization_get | read | GET /v1/organizations/{organizationId} |
| clickhouse_cloud_organization_update | write | PATCH /v1/organizations/{organizationId} |
| clickhouse_cloud_organization_prometheus_get | read | GET /v1/organizations/{organizationId}/prometheus |
| clickhouse_cloud_organization_roles_get_list | read | GET /v1/organizations/{organizationId}/roles |
| clickhouse_cloud_organization_role_post | write | POST /v1/organizations/{organizationId}/roles |
| clickhouse_cloud_organization_role_get | read | GET /v1/organizations/{organizationId}/roles/{roleId} |
| clickhouse_cloud_organization_role_patch | write | PATCH /v1/organizations/{organizationId}/roles/{roleId} |
| clickhouse_cloud_organization_role_delete | write | DELETE /v1/organizations/{organizationId}/roles/{roleId} |
| clickhouse_cloud_instance_get_list | read | GET /v1/organizations/{organizationId}/services |
| clickhouse_cloud_instance_create | write | POST /v1/organizations/{organizationId}/services |
| clickhouse_cloud_instance_get | read | GET /v1/organizations/{organizationId}/services/{serviceId} |
| clickhouse_cloud_instance_update | write | PATCH /v1/organizations/{organizationId}/services/{serviceId} |
| clickhouse_cloud_instance_delete | write | DELETE /v1/organizations/{organizationId}/services/{serviceId} |
| clickhouse_cloud_instance_private_endpoint_config_get | read | GET /v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig |
| clickhouse_cloud_instance_query_endpoint_get | read | GET /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint |
Notes
- The base URL defaults to
https://api.clickhouse.cloud. - Some endpoints are marked beta in ClickHouse Cloud’s API documentation; their tool descriptions retain the official endpoint summary.
- Returned data is the parsed JSON response from ClickHouse Cloud, preserving the upstream
status,requestId, andresultshape where present.
Raw agent markdown
# ClickHouse Cloud Lua API
Generated from the official ClickHouse Cloud OpenAPI document at `https://api.clickhouse.cloud/v1`. The namespace is `app.integrations["clickhouse-cloud"]`.
This package exposes 96 endpoint-specific tools: 43 read tools and 53 write tools. Use a ClickHouse Cloud API key ID and key secret; the integration sends them with HTTP Basic authentication.
## Usage
```lua
local organizations = app.integrations["clickhouse-cloud"].organization_get_list({})
local service = app.integrations["clickhouse-cloud"].instance_get({
organization_id = "00000000-0000-0000-0000-000000000000",
service_id = "11111111-1111-1111-1111-111111111111"
})
```
## Request Bodies
Tools that create, update, patch, or delete resources may accept a `body` table. The table is passed as the JSON body exactly as expected by the ClickHouse Cloud OpenAPI schema. Path and query arguments use snake_case names, while the service maps them back to the official API names.
## Example Tools
| `clickhouse_cloud_organization_get_list` | read | GET `/v1/organizations` |
| `clickhouse_cloud_organization_get` | read | GET `/v1/organizations/{organizationId}` |
| `clickhouse_cloud_organization_update` | write | PATCH `/v1/organizations/{organizationId}` |
| `clickhouse_cloud_organization_prometheus_get` | read | GET `/v1/organizations/{organizationId}/prometheus` |
| `clickhouse_cloud_organization_roles_get_list` | read | GET `/v1/organizations/{organizationId}/roles` |
| `clickhouse_cloud_organization_role_post` | write | POST `/v1/organizations/{organizationId}/roles` |
| `clickhouse_cloud_organization_role_get` | read | GET `/v1/organizations/{organizationId}/roles/{roleId}` |
| `clickhouse_cloud_organization_role_patch` | write | PATCH `/v1/organizations/{organizationId}/roles/{roleId}` |
| `clickhouse_cloud_organization_role_delete` | write | DELETE `/v1/organizations/{organizationId}/roles/{roleId}` |
| `clickhouse_cloud_instance_get_list` | read | GET `/v1/organizations/{organizationId}/services` |
| `clickhouse_cloud_instance_create` | write | POST `/v1/organizations/{organizationId}/services` |
| `clickhouse_cloud_instance_get` | read | GET `/v1/organizations/{organizationId}/services/{serviceId}` |
| `clickhouse_cloud_instance_update` | write | PATCH `/v1/organizations/{organizationId}/services/{serviceId}` |
| `clickhouse_cloud_instance_delete` | write | DELETE `/v1/organizations/{organizationId}/services/{serviceId}` |
| `clickhouse_cloud_instance_private_endpoint_config_get` | read | GET `/v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig` |
| `clickhouse_cloud_instance_query_endpoint_get` | read | GET `/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint` |
## Notes
- The base URL defaults to `https://api.clickhouse.cloud`.
- Some endpoints are marked beta in ClickHouse Cloud's API documentation; their tool descriptions retain the official endpoint summary.
- Returned data is the parsed JSON response from ClickHouse Cloud, preserving the upstream `status`, `requestId`, and `result` shape where present. local result = app.integrations.clickhouse_cloud.get_list_available_organizations({})
print(result) Functions
get_list_available_organizations Read
Get list of available organizations Official ClickHouse Cloud endpoint: GET /v1/organizations Returns a list with a single organization associated with the API key in the request.
- Lua path
app.integrations.clickhouse_cloud.get_list_available_organizations- Full name
clickhouse-cloud.clickhouse_cloud_organization_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_organization_details Read
Get organization details Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId} Returns details of a single organization. In order to get the details, the auth key must belong to the organization.
- Lua path
app.integrations.clickhouse_cloud.get_organization_details- Full name
clickhouse-cloud.clickhouse_cloud_organization_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_organization_details Write
Update organization details Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId} Updates organization fields. Requires ADMIN auth key role.
- Lua path
app.integrations.clickhouse_cloud.update_organization_details- Full name
clickhouse-cloud.clickhouse_cloud_organization_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_organization_metrics Read
Get organization metrics Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/prometheus Returns prometheus metrics for all services in an organization.
- Lua path
app.integrations.clickhouse_cloud.get_organization_metrics- Full name
clickhouse-cloud.clickhouse_cloud_organization_prometheus_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_all_available_roles_organization Read
List all available roles for an organization Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/roles Returns all available roles (system + custom) for an organization.
- Lua path
app.integrations.clickhouse_cloud.list_all_available_roles_organization- Full name
clickhouse-cloud.clickhouse_cloud_organization_roles_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_new_role Write
Create a new role Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/roles Creates a new custom role for an organization with specified policies and actors.
- Lua path
app.integrations.clickhouse_cloud.create_new_role- Full name
clickhouse-cloud.clickhouse_cloud_organization_role_post
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_role_details Read
Get role details Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/roles/{roleId} Returns details for a specific role.
- Lua path
app.integrations.clickhouse_cloud.get_role_details- Full name
clickhouse-cloud.clickhouse_cloud_organization_role_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_role Write
Update a role Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/roles/{roleId} Updates an existing custom role. System roles cannot be updated. All fields are optional - only provided fields will be updated.
- Lua path
app.integrations.clickhouse_cloud.update_role- Full name
clickhouse-cloud.clickhouse_cloud_organization_role_patch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_role Write
Delete a role Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/roles/{roleId} Deletes an existing custom role. System roles cannot be deleted. This operation will remove the role and all its associated policies.
- Lua path
app.integrations.clickhouse_cloud.delete_role- Full name
clickhouse-cloud.clickhouse_cloud_organization_role_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_organization_services Read
List of organization services Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services Returns a list of all services in the organization.
- Lua path
app.integrations.clickhouse_cloud.list_organization_services- Full name
clickhouse-cloud.clickhouse_cloud_instance_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_new_service Write
Create new service Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/services Creates a new service in the organization, and returns the current service state and a password to access the service. The service is st
- Lua path
app.integrations.clickhouse_cloud.create_new_service- Full name
clickhouse-cloud.clickhouse_cloud_instance_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_service_details Read
Get service details Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId} Returns a service that belongs to the organization
- Lua path
app.integrations.clickhouse_cloud.get_service_details- Full name
clickhouse-cloud.clickhouse_cloud_instance_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_service_basic_details Write
Update service basic details Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId} Updates basic service details like service name or IP access list.
- Lua path
app.integrations.clickhouse_cloud.update_service_basic_details- Full name
clickhouse-cloud.clickhouse_cloud_instance_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_service Write
Delete service Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/services/{serviceId} Deletes the service. The service must be in stopped state and is deleted asynchronously after this method call.
- Lua path
app.integrations.clickhouse_cloud.delete_service- Full name
clickhouse-cloud.clickhouse_cloud_instance_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_private_endpoint_configuration Read
Get private endpoint configuration Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig Information required to set up a private endpoint
- Lua path
app.integrations.clickhouse_cloud.get_private_endpoint_configuration- Full name
clickhouse-cloud.clickhouse_cloud_instance_private_endpoint_config_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_service_query_endpoint_given_instance Read
Get the service query endpoint for a given instance Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint Get the configuration for the service query endpoint that allows execut
- Lua path
app.integrations.clickhouse_cloud.get_service_query_endpoint_given_instance- Full name
clickhouse-cloud.clickhouse_cloud_instance_query_endpoint_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
upsert_service_query_endpoint_given_instance Write
Upsert the service query endpoint for a given instance Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint Create the service query endpoint that allows executing queries via
- Lua path
app.integrations.clickhouse_cloud.upsert_service_query_endpoint_given_instance- Full name
clickhouse-cloud.clickhouse_cloud_instance_query_endpoint_upsert
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_service_query_endpoint_given_instance Write
Delete the service query endpoint for a given instance Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint Removes the service query endpoint.
- Lua path
app.integrations.clickhouse_cloud.delete_service_query_endpoint_given_instance- Full name
clickhouse-cloud.clickhouse_cloud_instance_query_endpoint_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_service_state Write
Update service state Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId}/state Starts or stop service
- Lua path
app.integrations.clickhouse_cloud.update_service_state- Full name
clickhouse-cloud.clickhouse_cloud_instance_state_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_service_auto_scaling_settings Write
Update service auto scaling settings Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId}/scaling Updates minimum and maximum total memory limits and idle mode scaling behavior for the service. T
- Lua path
app.integrations.clickhouse_cloud.update_service_auto_scaling_settings- Full name
clickhouse-cloud.clickhouse_cloud_instance_scaling_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_service_auto_scaling_settings Write
Update service auto scaling settings Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId}/replicaScaling Updates minimum and maximum memory limits per replica and idle mode scaling behavior for t
- Lua path
app.integrations.clickhouse_cloud.update_service_auto_scaling_settings- Full name
clickhouse-cloud.clickhouse_cloud_instance_replica_scaling_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_service_password Write
Update service password Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId}/password Sets a new password for the service
- Lua path
app.integrations.clickhouse_cloud.update_service_password- Full name
clickhouse-cloud.clickhouse_cloud_instance_password_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_private_endpoint Write
Create a private endpoint Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/services/{serviceId}/privateEndpoint Create a new private endpoint. The private endpoint will be associated with this service and organiza
- Lua path
app.integrations.clickhouse_cloud.create_private_endpoint- Full name
clickhouse-cloud.clickhouse_cloud_instance_private_endpoint_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_service_metrics Read
Get service metrics Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/prometheus Returns prometheus metrics for a service.
- Lua path
app.integrations.clickhouse_cloud.get_service_metrics- Full name
clickhouse-cloud.clickhouse_cloud_instance_prometheus_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_settings Read
List ClickHouse settings Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the configured
- Lua path
app.integrations.clickhouse_cloud.list_settings- Full name
clickhouse-cloud.clickhouse_cloud_service_clickhouse_settings_list_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_settings Write
Update ClickHouse settings Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings **Disclaimer:** This beta endpoint is evolving; the API contract may change. Updates one or more
- Lua path
app.integrations.clickhouse_cloud.update_settings- Full name
clickhouse-cloud.clickhouse_cloud_service_clickhouse_settings_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_settings_schema Read
Get ClickHouse settings schema Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/schema **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns th
- Lua path
app.integrations.clickhouse_cloud.get_settings_schema- Full name
clickhouse-cloud.clickhouse_cloud_service_clickhouse_settings_schema_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_setting Read
Get ClickHouse setting Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickhouseSettings/{settingName} **Disclaimer:** This beta endpoint is evolving; the API contract may change. Returns the
- Lua path
app.integrations.clickhouse_cloud.get_setting- Full name
clickhouse-cloud.clickhouse_cloud_service_clickhouse_setting_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_service_backups Read
List of service backups Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/backups Returns a list of all backups for the service. The most recent backups comes first in the list.
- Lua path
app.integrations.clickhouse_cloud.list_service_backups- Full name
clickhouse-cloud.clickhouse_cloud_backup_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_backup_details Read
Get backup details Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId} Returns a single backup info.
- Lua path
app.integrations.clickhouse_cloud.get_backup_details- Full name
clickhouse-cloud.clickhouse_cloud_backup_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_service_backup_configuration Read
Get service backup configuration Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration Returns the service backup configuration.
- Lua path
app.integrations.clickhouse_cloud.get_service_backup_configuration- Full name
clickhouse-cloud.clickhouse_cloud_backup_configuration_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_service_backup_configuration Write
Update service backup configuration Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration Updates service backup configuration. Requires ADMIN auth key role. Setting the proper
- Lua path
app.integrations.clickhouse_cloud.update_service_backup_configuration- Full name
clickhouse-cloud.clickhouse_cloud_backup_configuration_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_service_backup_bucket Read
Get service backup bucket Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/backupBucket **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future.
- Lua path
app.integrations.clickhouse_cloud.get_service_backup_bucket- Full name
clickhouse-cloud.clickhouse_cloud_backup_bucket_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_service_backup_bucket Write
Create service backup bucket Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/services/{serviceId}/backupBucket **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the fut
- Lua path
app.integrations.clickhouse_cloud.create_service_backup_bucket- Full name
clickhouse-cloud.clickhouse_cloud_backup_bucket_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_service_backup_bucket Write
Update service backup bucket Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId}/backupBucket **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the fu
- Lua path
app.integrations.clickhouse_cloud.update_service_backup_bucket- Full name
clickhouse-cloud.clickhouse_cloud_backup_bucket_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_service_backup_bucket Write
Delete service backup bucket Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/services/{serviceId}/backupBucket **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the f
- Lua path
app.integrations.clickhouse_cloud.delete_service_backup_bucket- Full name
clickhouse-cloud.clickhouse_cloud_backup_bucket_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_list_all_keys Read
Get list of all keys Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/keys Returns a list of all keys in the organization.
- Lua path
app.integrations.clickhouse_cloud.get_list_all_keys- Full name
clickhouse-cloud.clickhouse_cloud_openapi_key_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_key Write
Create key Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/keys Creates new API key.
- Lua path
app.integrations.clickhouse_cloud.create_key- Full name
clickhouse-cloud.clickhouse_cloud_openapi_key_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_key_details Read
Get key details Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/keys/{keyId} Returns a single key details.
- Lua path
app.integrations.clickhouse_cloud.get_key_details- Full name
clickhouse-cloud.clickhouse_cloud_openapi_key_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_key Write
Update key Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/keys/{keyId} Updates API key properties.
- Lua path
app.integrations.clickhouse_cloud.update_key- Full name
clickhouse-cloud.clickhouse_cloud_openapi_key_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_key Write
Delete key Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/keys/{keyId} Deletes API key. Only a key not used to authenticate the active request can be deleted.
- Lua path
app.integrations.clickhouse_cloud.delete_key- Full name
clickhouse-cloud.clickhouse_cloud_openapi_key_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_organization_members Read
List organization members Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/members Returns a list of all members in the organization.
- Lua path
app.integrations.clickhouse_cloud.list_organization_members- Full name
clickhouse-cloud.clickhouse_cloud_member_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_member_details Read
Get member details Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/members/{userId} Returns a single organization member details.
- Lua path
app.integrations.clickhouse_cloud.get_member_details- Full name
clickhouse-cloud.clickhouse_cloud_member_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_organization_member Write
Update organization member Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/members/{userId} Updates organization member role.
- Lua path
app.integrations.clickhouse_cloud.update_organization_member- Full name
clickhouse-cloud.clickhouse_cloud_member_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_organization_member Write
Remove an organization member Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/members/{userId} Removes a user from the organization
- Lua path
app.integrations.clickhouse_cloud.remove_organization_member- Full name
clickhouse-cloud.clickhouse_cloud_member_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_all_invitations Read
List all invitations Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/invitations Returns list of all organization invitations.
- Lua path
app.integrations.clickhouse_cloud.list_all_invitations- Full name
clickhouse-cloud.clickhouse_cloud_invitation_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_invitation Write
Create an invitation Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/invitations Creates organization invitation.
- Lua path
app.integrations.clickhouse_cloud.create_invitation- Full name
clickhouse-cloud.clickhouse_cloud_invitation_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_invitation_details Read
Get invitation details Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/invitations/{invitationId} Returns details for a single organization invitation.
- Lua path
app.integrations.clickhouse_cloud.get_invitation_details- Full name
clickhouse-cloud.clickhouse_cloud_invitation_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_organization_invitation Write
Delete organization invitation Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/invitations/{invitationId} Deletes a single organization invitation.
- Lua path
app.integrations.clickhouse_cloud.delete_organization_invitation- Full name
clickhouse-cloud.clickhouse_cloud_invitation_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_organization_activities Read
List of organization activities Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/activities Returns a list of all organization activities.
- Lua path
app.integrations.clickhouse_cloud.list_organization_activities- Full name
clickhouse-cloud.clickhouse_cloud_activity_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
organization_activity Read
Organization activity Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/activities/{activityId} Returns a single organization activity by ID.
- Lua path
app.integrations.clickhouse_cloud.organization_activity- Full name
clickhouse-cloud.clickhouse_cloud_activity_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_organization_usage_costs Read
Get organization usage costs Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/usageCost Returns a grand total and a list of daily, per-entity organization usage cost records for the organization in the queried time
- Lua path
app.integrations.clickhouse_cloud.get_organization_usage_costs- Full name
clickhouse-cloud.clickhouse_cloud_usage_cost_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_clickpipes Read
List ClickPipes Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipes Returns a list of ClickPipes.
- Lua path
app.integrations.clickhouse_cloud.list_clickpipes- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_clickpipe Write
Create ClickPipe Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/services/{serviceId}/clickpipes Create a new ClickPipe.
- Lua path
app.integrations.clickhouse_cloud.create_clickpipe- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_clickpipe Read
Get ClickPipe Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId} Returns the specified ClickPipe.
- Lua path
app.integrations.clickhouse_cloud.get_clickpipe- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_clickpipe Write
Update ClickPipe Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId} Update the specified ClickPipe.
- Lua path
app.integrations.clickhouse_cloud.update_clickpipe- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_clickpipe Write
Delete ClickPipe Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId} Delete the specified ClickPipe.
- Lua path
app.integrations.clickhouse_cloud.delete_clickpipe- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_clickpipe_settings Read
Get ClickPipe settings Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings Returns the advanced settings for the specified ClickPipe.
- Lua path
app.integrations.clickhouse_cloud.get_clickpipe_settings- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_settings_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_clickpipe_settings Write
Update ClickPipe settings Official ClickHouse Cloud endpoint: PUT /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings Update the advanced settings for the specified ClickPipe. Send key-value pairs where
- Lua path
app.integrations.clickhouse_cloud.update_clickpipe_settings- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_settings_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_clickpipe_scaling Write
Update ClickPipe scaling Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/scaling Change scaling settings for the specified ClickPipe. This endpoint supports Kafka, K
- Lua path
app.integrations.clickhouse_cloud.update_clickpipe_scaling- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_scaling_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_clickpipe_state Write
Update ClickPipe state Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/state Start, stop or resync ClickPipe. Stopping a ClickPipe will stop the ingestion process fr
- Lua path
app.integrations.clickhouse_cloud.update_clickpipe_state- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_state_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_cdc_clickpipes_scaling Read
Get CDC ClickPipes scaling Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling Get scaling settings for database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery). The infrast
- Lua path
app.integrations.clickhouse_cloud.get_cdc_clickpipes_scaling- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_cdc_scaling_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_cdc_clickpipes_scaling Write
Update CDC ClickPipes scaling Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling Update scaling settings for database ClickPipes (PostgreSQL, MySQL, MongoDB, BigQuery). The
- Lua path
app.integrations.clickhouse_cloud.update_cdc_clickpipes_scaling- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_cdc_scaling_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_list_dashboards Read
ClickStack: List Dashboards Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in
- Lua path
app.integrations.clickhouse_cloud.clickstack_list_dashboards- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_list_dashboards
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_create_dashboard Write
ClickStack: Create Dashboard Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards **This endpoint is in beta.** API contract is stable, and no breaking changes are expected i
- Lua path
app.integrations.clickhouse_cloud.clickstack_create_dashboard- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_create_dashboard
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_get_dashboard Read
ClickStack: Get Dashboard Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId} **This endpoint is in beta.** API contract is stable, and no breaking ch
- Lua path
app.integrations.clickhouse_cloud.clickstack_get_dashboard- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_get_dashboard
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_update_dashboard Write
ClickStack: Update Dashboard Official ClickHouse Cloud endpoint: PUT /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId} **This endpoint is in beta.** API contract is stable, and no breaking
- Lua path
app.integrations.clickhouse_cloud.clickstack_update_dashboard- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_update_dashboard
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_delete_dashboard Write
ClickStack: Delete Dashboard Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId} **This endpoint is in beta.** API contract is stable, and no break
- Lua path
app.integrations.clickhouse_cloud.clickstack_delete_dashboard- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_delete_dashboard
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_list_alerts Read
ClickStack: List Alerts Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the futu
- Lua path
app.integrations.clickhouse_cloud.clickstack_list_alerts- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_list_alerts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_create_alert Write
ClickStack: Create Alert Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the fu
- Lua path
app.integrations.clickhouse_cloud.clickstack_create_alert- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_create_alert
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_list_sources Read
ClickStack: List Sources Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the fu
- Lua path
app.integrations.clickhouse_cloud.clickstack_list_sources- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_list_sources
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_get_alert Read
ClickStack: Get Alert Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId} **This endpoint is in beta.** API contract is stable, and no breaking changes are ex
- Lua path
app.integrations.clickhouse_cloud.clickstack_get_alert- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_get_alert
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_update_alert Write
ClickStack: Update Alert Official ClickHouse Cloud endpoint: PUT /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId} **This endpoint is in beta.** API contract is stable, and no breaking changes are
- Lua path
app.integrations.clickhouse_cloud.clickstack_update_alert- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_update_alert
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_delete_alert Write
ClickStack: Delete Alert Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId} **This endpoint is in beta.** API contract is stable, and no breaking changes
- Lua path
app.integrations.clickhouse_cloud.clickstack_delete_alert- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_delete_alert
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
clickstack_list_webhooks Read
ClickStack: List Webhooks Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the
- Lua path
app.integrations.clickhouse_cloud.clickstack_list_webhooks- Full name
clickhouse-cloud.clickhouse_cloud_click_stack_list_webhooks
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_organization_postgres_services Read
List of organization Postgres services Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/postgres **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns a l
- Lua path
app.integrations.clickhouse_cloud.list_organization_postgres_services- Full name
clickhouse-cloud.clickhouse_cloud_postgres_service_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_new_postgres_service Write
Create new Postgres service Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/postgres **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Creates a new Postgre
- Lua path
app.integrations.clickhouse_cloud.create_new_postgres_service- Full name
clickhouse-cloud.clickhouse_cloud_postgres_service_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_postgresql_service_details Read
Get PostgreSQL service details Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/postgres/{postgresId} **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Return
- Lua path
app.integrations.clickhouse_cloud.get_postgresql_service_details- Full name
clickhouse-cloud.clickhouse_cloud_postgres_service_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_postgresql_service Write
Update a PostgreSQL service Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/postgres/{postgresId} **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Update
- Lua path
app.integrations.clickhouse_cloud.update_postgresql_service- Full name
clickhouse-cloud.clickhouse_cloud_postgres_service_patch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_postgresql_service Write
Delete a PostgreSQL service Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/postgres/{postgresId} **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Delete
- Lua path
app.integrations.clickhouse_cloud.delete_postgresql_service- Full name
clickhouse-cloud.clickhouse_cloud_postgres_service_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_postgres_ca_certs Read
Get Postgres CA certs Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/postgres/{postgresId}/caCertificates **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future.
- Lua path
app.integrations.clickhouse_cloud.get_postgres_ca_certs- Full name
clickhouse-cloud.clickhouse_cloud_postgres_service_certs_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
restore_postgres_service Write
Restore a Postgres service Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/postgres/{postgresId}/restoredService **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the f
- Lua path
app.integrations.clickhouse_cloud.restore_postgres_service- Full name
clickhouse-cloud.clickhouse_cloud_postgres_instance_restore
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_postgres_superuser_password Write
Update Postgres superuser password Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/postgres/{postgresId}/password **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the
- Lua path
app.integrations.clickhouse_cloud.update_postgres_superuser_password- Full name
clickhouse-cloud.clickhouse_cloud_postgres_service_set_password
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_postgres_service_state Write
Update Postgres service state Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/postgres/{postgresId}/state **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future.
- Lua path
app.integrations.clickhouse_cloud.update_postgres_service_state- Full name
clickhouse-cloud.clickhouse_cloud_postgres_service_patch_state
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_read_replica_postgres_service Write
Create a read replica for a Postgres service Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/postgres/{postgresId}/readReplica **This endpoint is in beta.** API contract is stable, and no breaking changes are exp
- Lua path
app.integrations.clickhouse_cloud.create_read_replica_postgres_service- Full name
clickhouse-cloud.clickhouse_cloud_postgres_instance_create_read_replica
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_postgresql_service_configuration Read
Get PostgreSQL service configuration Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/postgres/{postgresId}/config **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the f
- Lua path
app.integrations.clickhouse_cloud.get_postgresql_service_configuration- Full name
clickhouse-cloud.clickhouse_cloud_postgres_instance_config_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
replace_postgres_service_configuration Write
Replace Postgres service configuration Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/postgres/{postgresId}/config **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in th
- Lua path
app.integrations.clickhouse_cloud.replace_postgres_service_configuration- Full name
clickhouse-cloud.clickhouse_cloud_postgres_instance_config_post
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_postgres_service_configuration Write
Update Postgres service configuration Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/postgres/{postgresId}/config **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in th
- Lua path
app.integrations.clickhouse_cloud.update_postgres_service_configuration- Full name
clickhouse-cloud.clickhouse_cloud_postgres_instance_config_patch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_private_endpoint_configuration_region_within_provider_organization Read
Get private endpoint configuration for region within cloud provider for an organization Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/privateEndpointConfig Deprecated. Please follow [documentation](https://click
- Lua path
app.integrations.clickhouse_cloud.get_private_endpoint_configuration_region_within_provider_organization- Full name
clickhouse-cloud.clickhouse_cloud_organization_private_endpoint_config_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_byoc_infrastructure Write
Create BYOC Infrastructure Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/byocInfrastructure Create a new BYOC Infrastructure in the organization. Returns the configuration of the newly created infrastructure
- Lua path
app.integrations.clickhouse_cloud.create_byoc_infrastructure- Full name
clickhouse-cloud.clickhouse_cloud_organization_byoc_infrastructure_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_byoc_infrastructure Write
Update BYOC Infrastructure Official ClickHouse Cloud endpoint: PATCH /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId} Update configuration of the BYOC infrastructure. Returns the modified infrastructure
- Lua path
app.integrations.clickhouse_cloud.update_byoc_infrastructure- Full name
clickhouse-cloud.clickhouse_cloud_organization_byoc_infrastructure_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
remove_byoc_infrastructure Write
Remove a BYOC infrastructure Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId} Removes a BYOC Infrastructure from the organization
- Lua path
app.integrations.clickhouse_cloud.remove_byoc_infrastructure- Full name
clickhouse-cloud.clickhouse_cloud_organization_byoc_infrastructure_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_reverse_private_endpoints Read
List reverse private endpoints Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints Returns a list of reverse private endpoints for the specified service.
- Lua path
app.integrations.clickhouse_cloud.list_reverse_private_endpoints- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_reverse_private_endpoint_get_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_reverse_private_endpoint Write
Create reverse private endpoint Official ClickHouse Cloud endpoint: POST /v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints Create a new reverse private endpoint.
- Lua path
app.integrations.clickhouse_cloud.create_reverse_private_endpoint- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_reverse_private_endpoint_create
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_reverse_private_endpoint Read
Get reverse private endpoint Official ClickHouse Cloud endpoint: GET /v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId} Returns the reverse private endpoint with the specifie
- Lua path
app.integrations.clickhouse_cloud.get_reverse_private_endpoint- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_reverse_private_endpoint_get
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_reverse_private_endpoint Write
Delete reverse private endpoint Official ClickHouse Cloud endpoint: DELETE /v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId} Delete the reverse private endpoint with the spe
- Lua path
app.integrations.clickhouse_cloud.delete_reverse_private_endpoint- Full name
clickhouse-cloud.clickhouse_cloud_click_pipe_reverse_private_endpoint_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||