# warehouse-api ## Pages - [Warehouse API](https://docs.ezghcloud.com/warehouse-api/index.md) — Managed ClickHouse data warehouses in your VPC: shards × replicas reached by DNS names over HTTPS and the native protocol, with TLS, users whose passwords live in Secrets, connections that load from buckets, Kafka clusters and databases, and daily backups. Every path is under an organization; lists are paged with limit, cursor and nextCursor. - [Cancel an operation](https://docs.ezghcloud.com/warehouse-api/CancelOperation/index.md) — 409 operation_finished or operation_not_cancellable when it can't be cancelled. - [Create a warehouse](https://docs.ezghcloud.com/warehouse-api/CreateWarehouse/index.md) — Asynchronous. Its first user, app (admin), and its password's Secret are created in the request, as the caller: secrets.secrets.create. 409 insufficient_hosts when the shape (shards, replicas and Keeper) isn't available on this instance type; 409 keeper_colocation_needs_larger_nodes; 400 instance_store_needs_replicas. - [Back up a warehouse now](https://docs.ezghcloud.com/warehouse-api/CreateWarehouseBackup/index.md) — Asynchronous. Every customer database, each shard's part on one healthy replica; incremental on the last backup unless a full is due. 409 backup_in_progress while a backup runs. - [Connect a warehouse to a bucket, a Kafka cluster or a database](https://docs.ezghcloud.com/warehouse-api/CreateWarehouseConnection/index.md) — Asynchronous. The credential on the target is made as the caller: objects.buckets.update on a bucket; hostedqueues.users.create on a Kafka cluster or databases.users.create on a database, and secrets.secrets.create for its Secret. A Kafka cluster or database must be in the warehouse's VPC (400 target_not_in_vpc); a database is PostgreSQL, Percona or MariaDB (400 unsupported_target); a target that refuses the credential as invalid, such as a logical database it hasn't got, is 400 target_refused. - [Create a database](https://docs.ezghcloud.com/warehouse-api/CreateWarehouseDatabase/index.md) — Asynchronous. A Replicated database on every data node: tables created in it on any node reach every node. system, information_schema, default and ezgh_* are 400 reserved_name. - [Open a connect session (a port forward)](https://docs.ezghcloud.com/warehouse-api/CreateWarehouseSession/index.md) — A one-time ticket for wss url, redeemed within 30 seconds with the subprotocols ezgh.warehouse.tunnel.v1 and ticket.; port 9440 (the native protocol over TLS) or 8443 (HTTPS). 429 too_many_sessions past 20 open; 503 while no node serves. - [Create a user](https://docs.ezghcloud.com/warehouse-api/CreateWarehouseUser/index.md) — Asynchronous. Its password is generated and written to a Secret in the warehouse's project, as the caller: secrets.secrets.create. Names starting ezgh_, and default, are 400 reserved_name. - [Delete a warehouse](https://docs.ezghcloud.com/warehouse-api/DeleteWarehouse/index.md) — Asynchronous. Deletes its users' Secrets and its backups too. 409 deletion_protected; 409 warehouse_in_use while a firewall rule names it. - [Delete a connection](https://docs.ezghcloud.com/warehouse-api/DeleteWarehouseConnection/index.md) — Asynchronous. Deletes the credential it made on the target, and its Secret, as the caller. - [Delete a database and its tables](https://docs.ezghcloud.com/warehouse-api/DeleteWarehouseDatabase/index.md) — Asynchronous. The body names the database again (400 confirmation_required otherwise). default can't be deleted; 409 deletion_protected. - [Delete a user](https://docs.ezghcloud.com/warehouse-api/DeleteWarehouseUser/index.md) — Asynchronous. Its Secret is deleted first, as the caller. - [Get an operation (poll it until it finishes)](https://docs.ezghcloud.com/warehouse-api/GetOperation/index.md) — While it's queued or running, Retry-After suggests when to poll again. Not recorded in Trails. - [Get a warehouse](https://docs.ezghcloud.com/warehouse-api/GetWarehouse/index.md) - [Get a backup](https://docs.ezghcloud.com/warehouse-api/GetWarehouseBackup/index.md) - [Get a connection](https://docs.ezghcloud.com/warehouse-api/GetWarehouseConnection/index.md) — A connection whose target is gone is broken; it stays until it's deleted. Getting a broken connection checks it again (at most every 30 seconds), and it's available again once the check passes. - [Get a database](https://docs.ezghcloud.com/warehouse-api/GetWarehouseDatabase/index.md) - [Get a user](https://docs.ezghcloud.com/warehouse-api/GetWarehouseUser/index.md) - [ClickHouse versions, upgrade targets, user presets and settings profiles](https://docs.ezghcloud.com/warehouse-api/ListEngineVersions/index.md) - [List the organization's operations, newest first](https://docs.ezghcloud.com/warehouse-api/ListOperations/index.md) - [List a warehouse's backups, newest first](https://docs.ezghcloud.com/warehouse-api/ListWarehouseBackups/index.md) - [List a warehouse's connections, newest first](https://docs.ezghcloud.com/warehouse-api/ListWarehouseConnections/index.md) - [List a warehouse's databases, newest first](https://docs.ezghcloud.com/warehouse-api/ListWarehouseDatabases/index.md) - [List a warehouse's events, newest first](https://docs.ezghcloud.com/warehouse-api/ListWarehouseEvents/index.md) - [List a database's tables by name](https://docs.ezghcloud.com/warehouse-api/ListWarehouseTables/index.md) — As the warehouse last reported them, up to 30 s behind. - [List a warehouse's users, newest first](https://docs.ezghcloud.com/warehouse-api/ListWarehouseUsers/index.md) - [List warehouses, newest first](https://docs.ezghcloud.com/warehouse-api/ListWarehouses/index.md) - [Run SQL as one of the warehouse's users](https://docs.ezghcloud.com/warehouse-api/QueryWarehouse/index.md) — Synchronous: the console's query editor. The user name and password are typed by the caller and never stored. At most 10,000 rows or 16 MiB (truncated), 300 seconds. 429 too_many_queries past 20 running; 503 while no node serves. With an Idempotency-Key the statement runs at most once: a retry replays that it ran (without its rows), and 409 query_outcome_unknown when it was sent but its answer never came back. - [Rotate a user's password](https://docs.ezghcloud.com/warehouse-api/RotateWarehouseUserPassword/index.md) — Asynchronous. Writes a new version of its Secret, then applies it. - [Change a warehouse](https://docs.ezghcloud.com/warehouse-api/UpdateWarehouse/index.md) — Asynchronous. shards and replicas only grow (409 scale_down_not_supported); existing data stays on the current shards. keeper, shards/replicas and engineVersion (newer only: 409 downgrade_not_supported) each change on their own. storage.sizeGiB only grows. - [Change a user's permissions or settings profile](https://docs.ezghcloud.com/warehouse-api/UpdateWarehouseUser/index.md) — Asynchronous; applied without a restart. - [Backups](https://docs.ezghcloud.com/warehouse-api/schemas/Backups/index.md) - [BackupsInput](https://docs.ezghcloud.com/warehouse-api/schemas/BackupsInput/index.md) - [Endpoint](https://docs.ezghcloud.com/warehouse-api/schemas/Endpoint/index.md) — How clients reach the warehouse. Null until its names resolve. - [EngineVersions](https://docs.ezghcloud.com/warehouse-api/schemas/EngineVersions/index.md) - [Error](https://docs.ezghcloud.com/warehouse-api/schemas/Error/index.md) — Every non-2xx answer. Clients branch on code, never on message. - [Maintenance](https://docs.ezghcloud.com/warehouse-api/schemas/Maintenance/index.md) - [Operation](https://docs.ezghcloud.com/warehouse-api/schemas/Operation/index.md) - [OperationList](https://docs.ezghcloud.com/warehouse-api/schemas/OperationList/index.md) - [OperationStatus](https://docs.ezghcloud.com/warehouse-api/schemas/OperationStatus/index.md) - [QuotaExceeded](https://docs.ezghcloud.com/warehouse-api/schemas/QuotaExceeded/index.md) — quota_exceeded: the quota that refused the request. Never with Retry-After. - [Storage](https://docs.ezghcloud.com/warehouse-api/schemas/Storage/index.md) - [StorageInput](https://docs.ezghcloud.com/warehouse-api/schemas/StorageInput/index.md) - [Tags](https://docs.ezghcloud.com/warehouse-api/schemas/Tags/index.md) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved. - [UserPermissions](https://docs.ezghcloud.com/warehouse-api/schemas/UserPermissions/index.md) - [UserPermissionsInput](https://docs.ezghcloud.com/warehouse-api/schemas/UserPermissionsInput/index.md) - [Warehouse](https://docs.ezghcloud.com/warehouse-api/schemas/Warehouse/index.md) - [WarehouseBackup](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseBackup/index.md) - [WarehouseBackupList](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseBackupList/index.md) - [WarehouseConnection](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseConnection/index.md) - [WarehouseConnectionCreate](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseConnectionCreate/index.md) - [WarehouseConnectionList](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseConnectionList/index.md) - [WarehouseCreate](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseCreate/index.md) - [WarehouseDatabase](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseDatabase/index.md) - [WarehouseDatabaseCreate](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseDatabaseCreate/index.md) - [WarehouseDatabaseDelete](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseDatabaseDelete/index.md) - [WarehouseDatabaseList](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseDatabaseList/index.md) - [WarehouseEvent](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseEvent/index.md) - [WarehouseEventList](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseEventList/index.md) - [WarehouseList](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseList/index.md) - [WarehouseQuery](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseQuery/index.md) - [WarehouseQueryResult](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseQueryResult/index.md) - [WarehouseSession](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseSession/index.md) - [WarehouseSessionCreate](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseSessionCreate/index.md) - [WarehouseTable](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseTable/index.md) - [WarehouseTableList](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseTableList/index.md) - [WarehouseUpdate](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseUpdate/index.md) - [WarehouseUser](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseUser/index.md) - [WarehouseUserCreate](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseUserCreate/index.md) - [WarehouseUserList](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseUserList/index.md) - [WarehouseUserUpdate](https://docs.ezghcloud.com/warehouse-api/schemas/WarehouseUserUpdate/index.md)