OpenAPI drift: 141 gaps between live spec and library

[github-actions]

The live ClickHouse Cloud OpenAPI spec has drifted from the Rust API library.
The comparison was produced by the shared syn-based analyzer.

• Live spec: https://api.clickhouse.cloud/v1
• Client: crates/clickhouse-cloud-api/src/client.rs
• Models: crates/clickhouse-cloud-api/src/models.rs
• Analyzer: crates/clickhouse-openapi-analyzer

Summary

Change	Count
Missing client methods	12
Extra client methods	0
Missing operation parameters	0
Operation parameter mismatches	0
Unsupported success response schemas	0
Missing model types	23
Missing schema definitions	0
Missing struct fields	20
Extra struct fields	0
Missing enum values	13
Extra enum values	0
Enum VALUES const mismatches	0
Additional properties mismatches	0
Field optionality mismatches	3
Beta status changes	29
Deprecated-field changes	1
Stale snapshot changes	40
Stale exemptions	0
New unsupported enum constraints	0
Changed acknowledged enum constraints	0
Acknowledged unsupported enum constraints	3

Missing Client Methods

saved_query_delete

DELETE /v1/organizations/{organizationId}/services/{serviceId}/saved-queries/{queryId}

Delete a saved query

Operation spec JSON

{
  "operationId": "savedQueryDelete",
  "summary": "Delete a saved query",
  "description": "**Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Deletes a saved query.",
  "tags": [
    "Saved queries"
  ],
  "security": [
    {
      "basicAuth": [
        "control-plane:service:manage"
      ]
    }
  ],
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "schema": {
        "description": "ID of the requested organization.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested organization."
    },
    {
      "in": "path",
      "name": "serviceId",
      "schema": {
        "description": "ID of the requested service.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested service."
    },
    {
      "in": "path",
      "name": "queryId",
      "schema": {
        "description": "ID of the requested saved query.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested saved query."
    }
  ],
  "responses": {
    "200": {
      "description": "The saved query was deleted.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "description": "HTTP status code.",
                "example": 200,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Error message.",
                "type": "string"
              },
              "issues": {
                "description": "Validation issues that caused the request to be rejected.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "path": {
                      "description": "Path to the invalid field.",
                      "type": "array",
                      "items": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "number"
                          }
                        ]
                      }
                    },
                    "code": {
                      "description": "Validation issue code.",
                      "type": "string"
                    },
                    "message": {
                      "description": "Human-readable description of the issue.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "path",
                    "code",
                    "message"
                  ],
                  "additionalProperties": false
                }
              },
              "status": {
                "description": "HTTP status code.",
                "example": 400,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "403": {
      "description": "The request is forbidden.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 403,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "404": {
      "description": "Saved query not found.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 404,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "409": {
      "description": "Saved query can not be managed via this API.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 409,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 500,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": {}
          }
        }
      }
    }
  },
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

organization_byoc_infrastructure_get

GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}

Get BYOC infrastructure details

Operation spec JSON

{
  "summary": "Get BYOC infrastructure details",
  "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. <br /><br /> Returns the full configuration of a BYOC infrastructure, including private link and load balancer state, network layout, and BYO-VPC settings read from the data plane.",
  "operationId": "organizationByocInfrastructureGet",
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "description": "ID of the requested organization.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "in": "path",
      "name": "byocInfrastructureId",
      "description": "ID of the requested BYOC Infrastructure",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 200
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              },
              "result": {
                "$ref": "#/components/schemas/ByocInfrastructureDetails"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 400
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer",
                "description": "HTTP status code.",
                "example": 500
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": [
        "control-plane:organization:view"
      ]
    }
  ],
  "tags": [
    "Organization"
  ],
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

organization_byoc_infrastructure_private_endpoint_config_get

GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/privateEndpointConfig

Get BYOC infrastructure private endpoint configuration

Operation spec JSON

{
  "summary": "Get BYOC infrastructure private endpoint configuration",
  "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. <br /><br /> Returns the private link endpoint service details of a BYOC infrastructure. For BYOC organizations this replaces the deprecated organization-level `privateEndpointConfig` endpoint.",
  "operationId": "organizationByocInfrastructurePrivateEndpointConfigGet",
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "description": "ID of the requested organization.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "in": "path",
      "name": "byocInfrastructureId",
      "description": "ID of the requested BYOC Infrastructure",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 200
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              },
              "result": {
                "$ref": "#/components/schemas/ByocInfrastructurePrivateEndpointConfig"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 400
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer",
                "description": "HTTP status code.",
                "example": 500
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": [
        "control-plane:organization:view"
      ]
    }
  ],
  "tags": [
    "Organization"
  ],
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

organization_byoc_infrastructure_progress_get

GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/progress

Get BYOC infrastructure provisioning progress

Operation spec JSON

{
  "summary": "Get BYOC infrastructure provisioning progress",
  "description": "**Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Returns the stage-by-stage provisioning progress of a BYOC infrastructure, more granular than the `state` field: overall status plus a tree of provisioning stages down to individual cloud resources.",
  "operationId": "organizationByocInfrastructureProgressGet",
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "description": "ID of the requested organization.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "in": "path",
      "name": "byocInfrastructureId",
      "description": "ID of the requested BYOC Infrastructure",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 200
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              },
              "result": {
                "$ref": "#/components/schemas/ByocInfrastructureProgress"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 400
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer",
                "description": "HTTP status code.",
                "example": 500
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": [
        "control-plane:organization:view"
      ]
    }
  ],
  "tags": [
    "Organization"
  ],
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

organization_byoc_infrastructure_tags_get

GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/tags

Get BYOC infrastructure tags

Operation spec JSON

{
  "summary": "Get BYOC infrastructure tags",
  "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. <br /><br /> Returns the additional tags currently applied to the cloud resources of the BYOC infrastructure. Tags are replaced as a whole through the infrastructure update endpoint.",
  "operationId": "organizationByocInfrastructureTagsGet",
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "description": "ID of the requested organization.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "in": "path",
      "name": "byocInfrastructureId",
      "description": "ID of the requested BYOC Infrastructure",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 200
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              },
              "result": {
                "$ref": "#/components/schemas/ByocInfrastructureTagsResponse"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 400
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer",
                "description": "HTTP status code.",
                "example": 500
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": [
        "control-plane:organization:view"
      ]
    }
  ],
  "tags": [
    "Organization"
  ],
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

postgres_service_backup_get_list

GET /v1/organizations/{organizationId}/postgres/{postgresId}/backups

List of Postgres service backups

Operation spec JSON

{
  "summary": "List of Postgres service backups",
  "description": "**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. <br /><br /> Returns a list of the base backups retained for a Postgres service, ordered by last modified date, newest first. Results are capped at `limit` (default and maximum 100) 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. A Postgres service is recovered to a point in time rather than to a single backup, so restore it with the restore endpoint and a timestamp rather than with a backup key from this list.",
  "operationId": "postgresServiceBackupGetList",
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "description": "ID of the organization that owns the Postgres service.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "in": "path",
      "name": "postgresId",
      "description": "ID of the Postgres service the backups were created from.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "in": "query",
      "name": "limit",
      "description": "Maximum number of results to return.",
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100,
        "default": 100
      }
    },
    {
      "in": "query",
      "name": "cursor",
      "description": "Opaque cursor from a previous response's `nextCursor`, marking where to resume the list.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 200
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              },
              "result": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/PostgresBackup"
                }
              },
              "limit": {
                "type": "integer",
                "description": "Maximum number of results returned in this page."
              },
              "totalCount": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Total number of results across all pages. It has only informative value, thus is not guaranteed and it is provided on a best-effort basis. Null if the total count is unknown."
              },
              "nextCursor": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Cursor for the next page, to be sent as the `cursor` query parameter. Null on the last page."
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 400
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer",
                "description": "HTTP status code.",
                "example": 500
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": [
        "control-plane:postgres-service:view"
      ]
    }
  ],
  "tags": [
    "Postgres"
  ],
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

saved_query_list

GET /v1/organizations/{organizationId}/services/{serviceId}/saved-queries

List saved queries

Operation spec JSON

{
  "operationId": "savedQueryList",
  "summary": "List saved queries",
  "description": "**Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Returns saved queries for the service.",
  "tags": [
    "Saved queries"
  ],
  "security": [
    {
      "basicAuth": [
        "control-plane:service:view"
      ]
    }
  ],
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "schema": {
        "description": "ID of the requested organization.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested organization."
    },
    {
      "in": "path",
      "name": "serviceId",
      "schema": {
        "description": "ID of the requested service.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested service."
    },
    {
      "in": "query",
      "name": "cursor",
      "schema": {
        "description": "Cursor returned as `nextCursor` on the previous page.",
        "type": "string"
      },
      "description": "Cursor returned as `nextCursor` on the previous page."
    },
    {
      "in": "query",
      "name": "limit",
      "schema": {
        "description": "Maximum number of records to return per page. Defaults to 100. Maximum is 100.",
        "default": 100,
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 100
      },
      "description": "Maximum number of records to return per page. Defaults to 100. Maximum is 100."
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "result": {
                "description": "Saved queries for the service.",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/PublicSavedQueryListItem"
                }
              },
              "limit": {
                "description": "Maximum number of results returned in this page.",
                "type": "integer"
              },
              "totalCount": {
                "description": "Total number of results across all pages. It has only informative value, thus is not guaranteed and it is provided on a best-effort basis. Null if the total count is unknown.",
                "anyOf": [
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "nextCursor": {
                "description": "Cursor for the next page, to be sent as the `cursor` query parameter. Null on the last page.",
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "status": {
                "description": "HTTP status code.",
                "example": 200,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "result",
              "limit",
              "totalCount",
              "nextCursor",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Error message.",
                "type": "string"
              },
              "issues": {
                "description": "Validation issues that caused the request to be rejected.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "path": {
                      "description": "Path to the invalid field.",
                      "type": "array",
                      "items": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "number"
                          }
                        ]
                      }
                    },
                    "code": {
                      "description": "Validation issue code.",
                      "type": "string"
                    },
                    "message": {
                      "description": "Human-readable description of the issue.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "path",
                    "code",
                    "message"
                  ],
                  "additionalProperties": false
                }
              },
              "status": {
                "description": "HTTP status code.",
                "example": 400,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "403": {
      "description": "The request is forbidden.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 403,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "404": {
      "description": "Service not found.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 404,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 500,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": {}
          }
        }
      }
    }
  },
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

saved_query_get

GET /v1/organizations/{organizationId}/services/{serviceId}/saved-queries/{queryId}

Get a saved query

Operation spec JSON

{
  "operationId": "savedQueryGet",
  "summary": "Get a saved query",
  "description": "**Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Returns a saved query.",
  "tags": [
    "Saved queries"
  ],
  "security": [
    {
      "basicAuth": [
        "control-plane:service:view"
      ]
    }
  ],
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "schema": {
        "description": "ID of the requested organization.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested organization."
    },
    {
      "in": "path",
      "name": "serviceId",
      "schema": {
        "description": "ID of the requested service.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested service."
    },
    {
      "in": "path",
      "name": "queryId",
      "schema": {
        "description": "ID of the requested saved query.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested saved query."
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "description": "HTTP status code.",
                "example": 200,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              },
              "result": {
                "$ref": "#/components/schemas/PublicSavedQuery"
              }
            },
            "required": [
              "status",
              "requestId",
              "result"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Error message.",
                "type": "string"
              },
              "issues": {
                "description": "Validation issues that caused the request to be rejected.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "path": {
                      "description": "Path to the invalid field.",
                      "type": "array",
                      "items": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "number"
                          }
                        ]
                      }
                    },
                    "code": {
                      "description": "Validation issue code.",
                      "type": "string"
                    },
                    "message": {
                      "description": "Human-readable description of the issue.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "path",
                    "code",
                    "message"
                  ],
                  "additionalProperties": false
                }
              },
              "status": {
                "description": "HTTP status code.",
                "example": 400,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "403": {
      "description": "The request is forbidden.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 403,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "404": {
      "description": "Saved query not found.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 404,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 500,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": {}
          }
        }
      }
    }
  },
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

whoami_get

GET /v1/whoami

Resolve the caller identity

Operation spec JSON

{
  "summary": "Resolve the caller identity",
  "description": "**Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Returns the identity of the authenticated caller. For a user (JWT or clickhousectl token) the result carries the user fields; for an organization API key it carries the key fields instead. Use `actorType` to tell the two apart.",
  "operationId": "whoamiGet",
  "parameters": [],
  "responses": {
    "200": {
      "description": "Successful response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 200
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              },
              "result": {
                "$ref": "#/components/schemas/Whoami"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 400
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer",
                "description": "HTTP status code.",
                "example": 500
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    "User management"
  ],
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

organization_byoc_infrastructure_validate

POST /v1/organizations/{organizationId}/byocInfrastructure/validate

Validate BYOC infrastructure prerequisites

Operation spec JSON

{
  "summary": "Validate BYOC infrastructure prerequisites",
  "description": "**Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Preflight-validates that a cloud account is ready for BYOC infrastructure creation: simulates the cloud permissions ClickHouse needs (and, for BYO-VPC, checks the provided network resources) without creating anything. Takes the same parameters as infrastructure creation, so a payload that passes validation will not be rejected by create for the same inputs.",
  "operationId": "organizationByocInfrastructureValidate",
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "description": "ID of the requested organization.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ByocInfrastructureValidatePostRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successful response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 200
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              },
              "result": {
                "$ref": "#/components/schemas/ByocInfrastructureValidation"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "number",
                "description": "HTTP status code.",
                "example": 400
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer",
                "description": "HTTP status code.",
                "example": 500
              },
              "error": {
                "type": "string",
                "description": "Detailed error description."
              },
              "requestId": {
                "type": "string",
                "description": "Unique id assigned to every request. UUIDv4",
                "format": "uuid"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": [
        "control-plane:organization:manage"
      ]
    }
  ],
  "tags": [
    "Organization"
  ],
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

saved_query_create

POST /v1/organizations/{organizationId}/services/{serviceId}/saved-queries

Create a saved query

---

Report continues in the next comment.

[github-actions]

Drift report, continued from above.

---

Operation spec JSON

{
  "operationId": "savedQueryCreate",
  "summary": "Create a saved query",
  "description": "**Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Creates a saved query.",
  "tags": [
    "Saved queries"
  ],
  "security": [
    {
      "basicAuth": [
        "control-plane:service:manage"
      ]
    }
  ],
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "schema": {
        "description": "ID of the requested organization.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested organization."
    },
    {
      "in": "path",
      "name": "serviceId",
      "schema": {
        "description": "ID of the requested service.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested service."
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PublicSavedQueryRequest"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "The saved query was created.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "description": "HTTP status code.",
                "example": 201,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              },
              "result": {
                "$ref": "#/components/schemas/PublicSavedQuery"
              }
            },
            "required": [
              "status",
              "requestId",
              "result"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Error message.",
                "type": "string"
              },
              "issues": {
                "description": "Validation issues that caused the request to be rejected.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "path": {
                      "description": "Path to the invalid field.",
                      "type": "array",
                      "items": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "number"
                          }
                        ]
                      }
                    },
                    "code": {
                      "description": "Validation issue code.",
                      "type": "string"
                    },
                    "message": {
                      "description": "Human-readable description of the issue.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "path",
                    "code",
                    "message"
                  ],
                  "additionalProperties": false
                }
              },
              "status": {
                "description": "HTTP status code.",
                "example": 400,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "403": {
      "description": "The request is forbidden.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 403,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "404": {
      "description": "Service not found.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 404,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "409": {
      "description": "A saved query with this name already exists.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 409,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 500,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": {}
          }
        }
      }
    }
  },
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

saved_query_update

PUT /v1/organizations/{organizationId}/services/{serviceId}/saved-queries/{queryId}

Update a saved query

Operation spec JSON

{
  "operationId": "savedQueryUpdate",
  "summary": "Update a saved query",
  "description": "**Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Updates a saved query.",
  "tags": [
    "Saved queries"
  ],
  "security": [
    {
      "basicAuth": [
        "control-plane:service:manage"
      ]
    }
  ],
  "parameters": [
    {
      "in": "path",
      "name": "organizationId",
      "schema": {
        "description": "ID of the requested organization.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested organization."
    },
    {
      "in": "path",
      "name": "serviceId",
      "schema": {
        "description": "ID of the requested service.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested service."
    },
    {
      "in": "path",
      "name": "queryId",
      "schema": {
        "description": "ID of the requested saved query.",
        "type": "string",
        "format": "uuid",
        "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)$"
      },
      "required": true,
      "description": "ID of the requested saved query."
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PublicSavedQueryRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "The saved query was updated.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "description": "HTTP status code.",
                "example": 200,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              },
              "result": {
                "$ref": "#/components/schemas/PublicSavedQuery"
              }
            },
            "required": [
              "status",
              "requestId",
              "result"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "400": {
      "description": "The request cannot be processed due to a client error. Please verify your request parameters and try again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Error message.",
                "type": "string"
              },
              "issues": {
                "description": "Validation issues that caused the request to be rejected.",
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "path": {
                      "description": "Path to the invalid field.",
                      "type": "array",
                      "items": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "number"
                          }
                        ]
                      }
                    },
                    "code": {
                      "description": "Validation issue code.",
                      "type": "string"
                    },
                    "message": {
                      "description": "Human-readable description of the issue.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "path",
                    "code",
                    "message"
                  ],
                  "additionalProperties": false
                }
              },
              "status": {
                "description": "HTTP status code.",
                "example": 400,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "403": {
      "description": "The request is forbidden.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 403,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "404": {
      "description": "Saved query not found.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 404,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "409": {
      "description": "Saved query can not be managed via this API, or a saved query with this name already exists.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Human-readable error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 409,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "500": {
      "description": "An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "description": "Error message.",
                "type": "string"
              },
              "status": {
                "description": "HTTP status code.",
                "example": 500,
                "type": "integer"
              },
              "requestId": {
                "description": "Unique id assigned to every request. UUIDv4",
                "type": "string",
                "format": "uuid",
                "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)$"
              }
            },
            "required": [
              "error",
              "status",
              "requestId"
            ],
            "additionalProperties": {}
          }
        }
      }
    }
  },
  "x-badges": [
    {
      "name": "Beta",
      "position": "after"
    }
  ]
}

Missing Struct Fields

• /components/schemas/ByocConfig/properties/accountId — ByocConfig.accountId is missing from models.rs
• /components/schemas/ByocInfrastructurePatchRequest/properties/enablePrivateLink — ByocInfrastructurePatchRequest.enablePrivateLink is missing from models.rs
• /components/schemas/ByocInfrastructurePatchRequest/properties/enablePrivateLoadBalancer — ByocInfrastructurePatchRequest.enablePrivateLoadBalancer is missing from models.rs
• /components/schemas/ByocInfrastructurePatchRequest/properties/enablePublicLoadBalancer — ByocInfrastructurePatchRequest.enablePublicLoadBalancer is missing from models.rs
• /components/schemas/ByocInfrastructurePatchRequest/properties/gcpPscSubnetId — ByocInfrastructurePatchRequest.gcpPscSubnetId is missing from models.rs
• /components/schemas/ByocInfrastructurePatchRequest/properties/tags — ByocInfrastructurePatchRequest.tags is missing from models.rs
• /components/schemas/ByocInfrastructurePostRequest/properties/externalId — ByocInfrastructurePostRequest.externalId is missing from models.rs
• /components/schemas/ByocInfrastructurePostRequest/properties/gcpPodCidrRangeNames — ByocInfrastructurePostRequest.gcpPodCidrRangeNames is missing from models.rs
• /components/schemas/ByocInfrastructurePostRequest/properties/gcpSharedVpcHostProjectId — ByocInfrastructurePostRequest.gcpSharedVpcHostProjectId is missing from models.rs
• /components/schemas/ByocInfrastructurePostRequest/properties/privateSubnetIds — ByocInfrastructurePostRequest.privateSubnetIds is missing from models.rs
• /components/schemas/ByocInfrastructurePostRequest/properties/publicSubnetIds — ByocInfrastructurePostRequest.publicSubnetIds is missing from models.rs
• /components/schemas/ByocInfrastructurePostRequest/properties/servicePrincipalClientId — ByocInfrastructurePostRequest.servicePrincipalClientId is missing from models.rs
• /components/schemas/ByocInfrastructurePostRequest/properties/tags — ByocInfrastructurePostRequest.tags is missing from models.rs
• /components/schemas/ByocInfrastructurePostRequest/properties/tenantId — ByocInfrastructurePostRequest.tenantId is missing from models.rs
• /components/schemas/ByocInfrastructurePostRequest/properties/vpcId — ByocInfrastructurePostRequest.vpcId is missing from models.rs
• /components/schemas/CustomPrivateDnsMapping/properties/targetId — CustomPrivateDnsMapping.targetId is missing from models.rs
• /components/schemas/CustomPrivateDnsMapping/properties/targetId — CustomPrivateDnsMappingResponse.targetId is missing from models.rs
• /components/schemas/ReversePrivateEndpoint/properties/dnsTargets — ReversePrivateEndpoint.dnsTargets is missing from models.rs
• /components/schemas/ReversePrivateEndpoint/properties/privateDnsMappings — ReversePrivateEndpoint.privateDnsMappings is missing from models.rs
• /components/schemas/ServicePostRequest/properties/backupEncryptionConfig — ServicePostRequest.backupEncryptionConfig is missing from models.rs

Missing Enum Values

• /components/schemas/Activity/properties/type — ActivityType has no variant for wire value "organization_approved_domain_auto_invite"
• /components/schemas/Activity/properties/type — ActivityType has no variant for wire value "organization_approved_domain_auto_join"
• /components/schemas/Activity/properties/type — ActivityType has no variant for wire value "organization_approved_domain_delete"
• /components/schemas/Activity/properties/type — ActivityType has no variant for wire value "organization_approved_domain_update"
• /components/schemas/Activity/properties/type — ActivityType has no variant for wire value "organization_approved_domain_verify"
• /components/schemas/Activity/properties/type — ActivityType has no variant for wire value "organization_update_public_preview"
• /components/schemas/Activity/properties/type — ActivityType has no variant for wire value "organization_update_saml_query_ownership_migration"
• /components/schemas/Activity/properties/type — ActivityType has no variant for wire value "postgres_action"
• /components/schemas/ByocConfig/properties/state — ByocConfigState has no variant for wire value "infra-degraded"
• /components/schemas/ByocConfig/properties/state — ByocConfigState has no variant for wire value "infra-terminating"
• /components/schemas/ByocConfig/properties/state — ByocConfigState has no variant for wire value "infra-upgrading"
• /components/schemas/ClickPipeKafkaSource/properties/tombstoneMode — ClickPipeKafkaSourceTombstonemode has no variant for wire value "soft_delete"
• /components/schemas/ClickPipePostKafkaSource/properties/tombstoneMode — ClickPipePostKafkaSourceTombstonemode has no variant for wire value "soft_delete"

Field Optionality Mismatches

• /components/schemas/ByocInfrastructurePostRequest/properties/availabilityZoneSuffixes — ByocInfrastructurePostRequest.availabilityZoneSuffixes should be Option, found T
• /components/schemas/ByocInfrastructurePostRequest/properties/displayName — ByocInfrastructurePostRequest.displayName should be Option, found T
• /components/schemas/ByocInfrastructurePostRequest/properties/vpcCidrRange — ByocInfrastructurePostRequest.vpcCidrRange should be Option, found T

Newly Beta Operations

• /paths/~1v1~1organizations~1{organizationId}~1byocInfrastructure~1{byocInfrastructureId}/get — organization_byoc_infrastructure_get is Beta in the spec but absent from BETA_OPERATIONS
• /paths/~1v1~1organizations~1{organizationId}~1byocInfrastructure~1{byocInfrastructureId}~1privateEndpointConfig/get — organization_byoc_infrastructure_private_endpoint_config_get is Beta in the spec but absent from BETA_OPERATIONS
• /paths/~1v1~1organizations~1{organizationId}~1byocInfrastructure~1{byocInfrastructureId}~1progress/get — organization_byoc_infrastructure_progress_get is Beta in the spec but absent from BETA_OPERATIONS
• /paths/~1v1~1organizations~1{organizationId}~1byocInfrastructure~1{byocInfrastructureId}~1tags/get — organization_byoc_infrastructure_tags_get is Beta in the spec but absent from BETA_OPERATIONS
• /paths/~1v1~1organizations~1{organizationId}~1byocInfrastructure~1validate/post — organization_byoc_infrastructure_validate is Beta in the spec but absent from BETA_OPERATIONS
• /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1backups/get — postgres_service_backup_get_list is Beta in the spec but absent from BETA_OPERATIONS
• /paths/~1v1~1organizations~1{organizationId}~1services~1{serviceId}~1saved-queries/post — saved_query_create is Beta in the spec but absent from BETA_OPERATIONS
• /paths/~1v1~1organizations~1{organizationId}~1services~1{serviceId}~1saved-queries~1{queryId}/delete — saved_query_delete is Beta in the spec but absent from BETA_OPERATIONS
• /paths/~1v1~1organizations~1{organizationId}~1services~1{serviceId}~1saved-queries~1{queryId}/get — saved_query_get is Beta in the spec but absent from BETA_OPERATIONS
• /paths/~1v1~1organizations~1{organizationId}~1services~1{serviceId}~1saved-queries/get — saved_query_list is Beta in the spec but absent from BETA_OPERATIONS
• /paths/~1v1~1organizations~1{organizationId}~1services~1{serviceId}~1saved-queries~1{queryId}/put — saved_query_update is Beta in the spec but absent from BETA_OPERATIONS
• /paths/~1v1~1whoami/get — whoami_get is Beta in the spec but absent from BETA_OPERATIONS

Graduated Beta Operations

• meta.rs::BETA_OPERATIONS — query_api_endpoint_create is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — query_api_endpoint_delete is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — query_api_endpoint_get is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — query_api_endpoint_list is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — query_api_endpoint_update is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_attach is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_attachment_get is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_attachment_list is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_create is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_delete is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_detach is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_get is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_list is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_upload_session_create is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_version_create is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_version_delete is no longer Beta but remains in BETA_OPERATIONS
• meta.rs::BETA_OPERATIONS — udf_version_list is no longer Beta but remains in BETA_OPERATIONS

Newly Deprecated Fields

• /components/schemas/ByocConfig/properties/accountName — ByocConfig.accountName is deprecated in the spec but absent from DEPRECATED_FIELDS

New Operations Missing From Snapshot

• /paths/~1v1~1organizations~1{organizationId}~1byocInfrastructure~1{byocInfrastructureId}/get — operation organization_byoc_infrastructure_get is present in the target spec but absent from the snapshot
• /paths/~1v1~1organizations~1{organizationId}~1byocInfrastructure~1{byocInfrastructureId}~1privateEndpointConfig/get — operation organization_byoc_infrastructure_private_endpoint_config_get is present in the target spec but absent from the snapshot
• /paths/~1v1~1organizations~1{organizationId}~1byocInfrastructure~1{byocInfrastructureId}~1progress/get — operation organization_byoc_infrastructure_progress_get is present in the target spec but absent from the snapshot
• /paths/~1v1~1organizations~1{organizationId}~1byocInfrastructure~1{byocInfrastructureId}~1tags/get — operation organization_byoc_infrastructure_tags_get is present in the target spec but absent from the snapshot
• /paths/~1v1~1organizations~1{organizationId}~1byocInfrastructure~1validate/post — operation organization_byoc_infrastructure_validate is present in the target spec but absent from the snapshot
• /paths/~1v1~1organizations~1{organizationId}~1postgres~1{postgresId}~1backups/get — operation postgres_service_backup_get_list is present in the target spec but absent from the snapshot
• /paths/~1v1~1organizations~1{organizationId}~1services~1{serviceId}~1saved-queries/post — operation saved_query_create is present in the target spec but absent from the snapshot
• /paths/~1v1~1organizations~1{organizationId}~1services~1{serviceId}~1saved-queries~1{queryId}/delete — operation saved_query_delete is present in the target spec but absent from the snapshot
• /paths/~1v1~1organizations~1{organizationId}~1services~1{serviceId}~1saved-queries~1{queryId}/get — operation saved_query_get is present in the target spec but absent from the snapshot
• /paths/~1v1~1organizations~1{organizationId}~1services~1{serviceId}~1saved-queries/get — operation saved_query_list is present in the target spec but absent from the snapshot
• /paths/~1v1~1organizations~1{organizationId}~1services~1{serviceId}~1saved-queries~1{queryId}/put — operation saved_query_update is present in the target spec but absent from the snapshot
• /paths/~1v1~1whoami/get — operation whoami_get is present in the target spec but absent from the snapshot

New Schemas Missing From Snapshot

• /components/schemas/BackupEncryptionConfig — schema BackupEncryptionConfig is present in the target spec but absent from the snapshot
• /components/schemas/ByocInfrastructureDetails — schema ByocInfrastructureDetails is present in the target spec but absent from the snapshot
• /components/schemas/ByocInfrastructurePrivateEndpointConfig — schema ByocInfrastructurePrivateEndpointConfig is present in the target spec but absent from the snapshot
• /components/schemas/ByocInfrastructureProgress — schema ByocInfrastructureProgress is present in the target spec but absent from the snapshot
• /components/schemas/ByocInfrastructureProgressStage — schema ByocInfrastructureProgressStage is present in the target spec but absent from the snapshot
• /components/schemas/ByocInfrastructureTags — schema ByocInfrastructureTags is present in the target spec but absent from the snapshot
• /components/schemas/ByocInfrastructureTagsResponse — schema ByocInfrastructureTagsResponse is present in the target spec but absent from the snapshot
• /components/schemas/ByocInfrastructureValidatePostRequest — schema ByocInfrastructureValidatePostRequest is present in the target spec but absent from the snapshot
• /components/schemas/ByocInfrastructureValidation — schema ByocInfrastructureValidation is present in the target spec but absent from the snapshot
• /components/schemas/ByocInfrastructureValidationCheck — schema ByocInfrastructureValidationCheck is present in the target spec but absent from the snapshot
• /components/schemas/ClickPipeKafkaConfluentSchemaRegistry — schema ClickPipeKafkaConfluentSchemaRegistry is present in the target spec but absent from the snapshot
• /components/schemas/ClickPipeKafkaGlueSchemaRegistry — schema ClickPipeKafkaGlueSchemaRegistry is present in the target spec but absent from the snapshot
• /components/schemas/ClickPipeMutateKafkaConfluentSchemaRegistry — schema ClickPipeMutateKafkaConfluentSchemaRegistry is present in the target spec but absent from the snapshot
• /components/schemas/PostgresBackup — schema PostgresBackup is present in the target spec but absent from the snapshot
• /components/schemas/PublicSavedQuery — schema PublicSavedQuery is present in the target spec but absent from the snapshot
• /components/schemas/PublicSavedQueryListItem — schema PublicSavedQueryListItem is present in the target spec but absent from the snapshot
• /components/schemas/PublicSavedQueryRequest — schema PublicSavedQueryRequest is present in the target spec but absent from the snapshot
• /components/schemas/ReversePrivateEndpointDnsTarget — schema ReversePrivateEndpointDnsTarget is present in the target spec but absent from the snapshot
• /components/schemas/ReversePrivateEndpointPrivateDnsMapping — schema ReversePrivateEndpointPrivateDnsMapping is present in the target spec but absent from the snapshot
• /components/schemas/Whoami — schema Whoami is present in the target spec but absent from the snapshot
• /components/schemas/WhoamiApiKey — schema WhoamiApiKey is present in the target spec but absent from the snapshot
• /components/schemas/WhoamiOrganization — schema WhoamiOrganization is present in the target spec but absent from the snapshot
• /components/schemas/WhoamiUser — schema WhoamiUser is present in the target spec but absent from the snapshot

Removed Schemas Still In Snapshot

• /components/schemas/Pagination — schema Pagination remains in the snapshot but is absent from the target spec
• /components/schemas/QueryApiEndpointListResponse — schema QueryApiEndpointListResponse remains in the snapshot but is absent from the target spec
• /components/schemas/UdfAttachmentListResponse — schema UdfAttachmentListResponse remains in the snapshot but is absent from the target spec
• /components/schemas/UdfListResponse — schema UdfListResponse remains in the snapshot but is absent from the target spec
• /components/schemas/UdfVersionListResponse — schema UdfVersionListResponse remains in the snapshot but is absent from the target spec

Missing Model Types

BackupEncryptionConfig (spec: BackupEncryptionConfig)

Schema JSON

{
  "type": "object",
  "additionalProperties": true,
  "description": "The `encryption_config.json` stored alongside this backup in your bucket, passed through unchanged. Supply the file contents verbatim rather than constructing this object \u2014 its shape is versioned and depends on your cloud provider. See [Export backups to your own cloud account](https://clickhouse.com/docs/cloud/manage/backups/export-backups-to-own-cloud-account) for what it contains.\n\nAccepted only for organizations enrolled in the private preview, and only when the backup is of a service that has transparent data encryption enabled. Such a restore always produces a service with transparent data encryption enabled, inherited from the source service.",
  "example": {
    "schema_version": 1,
    "restore_key_pairs": [
      {
        "customer_managed_encryption_key": {
          "aws_kms_key_arn": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
        },
        "encrypted_dek": "<base64 wrapped data encryption key>"
      }
    ]
  }
}

ByocInfrastructureDetails (spec: ByocInfrastructureDetails)

Schema JSON

{
  "properties": {
    "id": {
      "description": "Unique identifier of the BYOC infrastructure",
      "type": "string"
    },
    "state": {
      "description": "State of the infrastructure",
      "type": "string",
      "enum": [
        "infra-provisioning",
        "infra-terminated",
        "infra-terminating",
        "infra-ready",
        "infra-degraded",
        "infra-upgrading"
      ],
      "example": "infra-ready"
    },
    "accountId": {
      "description": "Cloud account ID the BYOC infrastructure is bound to: AWS account ID, GCP project ID, or Azure subscription ID",
      "type": "string",
      "example": "123456789012"
    },
    "regionId": {
      "description": "Region the BYOC infrastructure is located in",
      "type": "string",
      "enum": [
        "ap-northeast-1",
        "ap-northeast-2",
        "ap-south-1",
        "ap-southeast-1",
        "ap-southeast-2",
        "ca-central-1",
        "eu-central-1",
        "eu-west-1",
        "eu-west-2",
        "il-central-1",
        "us-east-1",
        "us-east-2",
        "us-west-2",
        "us-east1",
        "us-central1",
        "europe-west2",
        "europe-west4",
        "asia-southeast1",
        "asia-northeast1",
        "eastus",
        "eastus2",
        "westus3",
        "germanywestcentral",
        "centralus"
      ]
    },
    "cloudProvider": {
      "description": "Cloud provider of the region",
      "type": "string",
      "enum": [
        "gcp",
        "aws",
        "azure"
      ]
    },
    "displayName": {
      "description": "Human readable name for infrastructure",
      "type": "string"
    },
    "enablePrivateLink": {
      "description": "Whether private link connectivity is enabled on the infrastructure",
      "type": "boolean"
    },
    "enablePrivateLoadBalancer": {
      "description": "Whether the private load balancer is enabled on the infrastructure",
      "type": "boolean"
    },
    "enablePublicLoadBalancer": {
      "description": "Whether the public load balancer is enabled on the infrastructure",
      "type": "boolean"
    },
    "vpcCidrRange": {
      "description": "CIDR range of the ClickHouse-managed VPC. Absent for BYO-VPC infrastructures",
      "type": "string",
      "example": "10.0.0.0/16"
    },
    "vpcAvailabilityZoneList": {
      "type": "array",
      "description": "Availability zones the infrastructure spans",
      "items": {
        "type": "string"
      },
      "example": [
        "us-east-1a",
        "us-east-1b",
        "us-east-1c"
      ]
    },
    "isByoVpc": {
      "description": "True when the infrastructure runs in a customer-provided VPC (BYO-VPC) instead of a ClickHouse-managed one",
      "type": "boolean"
    },
    "byoVpcId": {
      "description": "Customer VPC ID or network name (BYO-VPC only)",
      "type": "string",
      "example": "vpc-0abc1234def567890"
    },
    "byoVpcPrivateSubnetIds": {
      "type": "array",
      "description": "Customer private subnet IDs or names (BYO-VPC only; exactly one entry on GCP)",
      "items": {
        "type": "string"
      }
    },
    "byoVpcPodCidrRangeNames": {
      "type": "array",
      "description": "Secondary IP range names pinned for pod IPs (GCP BYO-VPC only). Absent when all secondary ranges are used",
      "items": {
        "type": "string"
      }
    },
    "byoVpcSharedVpcHostProjectId": {
      "description": "Shared VPC host project owning the VPC and subnet (GCP BYO-VPC only). Absent when the VPC lives in the service project",
      "type": "string"
    },
    "gcpPscSubnetId": {
      "description": "Customer-provided Private Service Connect NAT subnet name configured for private link (GCP BYO-VPC only)",
      "type": "string"
    }
  }
}

ByocInfrastructurePrivateEndpointConfig (spec: ByocInfrastructurePrivateEndpointConfig)

Schema JSON

{
  "properties": {
    "endpointName": {
      "description": "Cloud-provider identifier of the private link endpoint service of the infrastructure: VPC endpoint service name on AWS, Private Service Connect service attachment on GCP, or Private Link service on Azure",
      "type": "string"
    },
    "privateDnsHostname": {
      "description": "Private DNS hostname under which services of the infrastructure are reachable over private link",
      "type": "string"
    }
  },
  "required": [
    "endpointName",
    "privateDnsHostname"
  ]
}

ByocInfrastructureProgress (spec: ByocInfrastructureProgress)

Schema JSON

{
  "properties": {
    "id": {
      "description": "Unique identifier of the BYOC infrastructure",
      "type": "string"
    },
    "status": {
      "description": "Overall provisioning status of the infrastructure",
      "type": "string",
      "enum": [
        "not_started",
        "pending",
        "waiting",
        "in_progress",
        "ready",
        "failed"
      ],
      "example": "in_progress"
    },
    "updatedAt": {
      "description": "Timestamp the overall status last changed. ISO-8601",
      "type": "string",
      "format": "date-time"
    },
    "stages": {
      "type": "array",
      "description": "Top-level provisioning stages with their nested resources",
      "items": {
        "$ref": "#/components/schemas/ByocInfrastructureProgressStage"
      }
    }
  }
}

ByocInfrastructureProgressStage (spec: ByocInfrastructureProgressStage)

Schema JSON

{
  "properties": {
    "name": {
      "description": "Name of the provisioning stage or resource",
      "type": "string",
      "example": "vpc"
    },
    "status": {
      "description": "Status of this stage",
      "type": "string",
      "enum": [
        "not_started",
        "pending",
        "waiting",
        "in_progress",
        "ready",
        "failed"
      ],
      "example": "ready"
    },
    "updatedAt": {
      "description": "Timestamp the stage status last changed. ISO-8601",
      "type": "string",
      "format": "date-time"
    },
    "message": {
      "description": "Human readable detail for the current status, e.g. an error message",
      "type": "string"
    },
    "subStages": {
      "type": "array",
      "description": "Nested stages; leaf entries are individual cloud resources",
      "items": {
        "$ref": "#/components/schemas/ByocInfrastructureProgressStage"
      }
    }
  }
}

ByocInfrastructureTags (spec: ByocInfrastructureTags)

Schema JSON

{
  "type": "object",
  "additionalProperties": {
    "type": "string"
  },
  "maxProperties": 50
}

ByocInfrastructureTagsResponse (spec: ByocInfrastructureTagsResponse)

Schema JSON

{
  "properties": {
    "tags": {
      "$ref": "#/components/schemas/ByocInfrastructureTags"
    }
  },
  "required": [
    "tags"
  ]
}

ByocInfrastructureValidatePostRequest (spec: ByocInfrastructureValidatePostRequest)

Schema JSON

{
  "properties": {
    "regionId": {
      "description": "Region in which the BYOC infrastructure will be located",
      "type": "string",
      "enum": [
        "ap-northeast-1",
        "ap-northeast-2",
        "ap-south-1",
        "ap-southeast-1",
        "ap-southeast-2",
        "ca-central-1",
        "eu-central-1",
        "eu-west-1",
        "eu-west-2",
        "il-central-1",
        "us-east-1",
        "us-east-2",
        "us-west-2",
        "us-east1",
        "us-central1",
        "europe-west2",
        "europe-west4",
        "asia-southeast1",
        "asia-northeast1",
        "eastus",
        "eastus2",
        "westus3",
        "germanywestcentral",
        "centralus"
      ]
    },
    "accountId": {
      "description": "Cloud account ID the BYOC infrastructure is configured for: AWS account ID, GCP project ID, or Azure subscription ID",
      "type": "string",
      "example": "123456789012"
    },
    "availabilityZoneSuffixes": {
      "type": "array",
      "description": "List of availability zone suffixes",
      "items": {
        "type": "string",
        "enum": [
          "a",
          "b",
          "c",
          "d",
          "e",
          "f"
        ]
      }
    },
    "vpcCidrRange": {
      "description": "CIDR range for the ClickHouse-managed VPC. Mutually exclusive with the BYO-VPC fields (`vpcId`, `privateSubnetIds`, `publicSubnetIds`)",
      "type": "string",
      "example": "10.0.0.0/16"
    },
    "externalId": {
      "description": "AWS only: ExternalID baked into the ClickHouse management role trust policy in your account",
      "type": "string",
      "example": "ch-0a1b2c3d4e5f6789"
    },
    "tenantId": {
      "description": "Azure only (required for Azure regions): Entra tenant ID of the subscription",
      "type": "string"
    },
    "servicePrincipalClientId": {
      "description": "Azure only (required for Azure regions): client ID of the service principal ClickHouse uses to manage the infrastructure",
      "type": "string"
    },
    "vpcId": {
      "description": "BYO-VPC only (AWS and GCP): ID or network name of the customer-provided VPC to deploy into. Requires `privateSubnetIds`",
      "type": "string",
      "example": "vpc-0abc1234def567890"
    },
    "privateSubnetIds": {
      "type": "array",
      "description": "BYO-VPC only: private subnet IDs or names (1-6 entries on AWS, exactly one on GCP)",
      "items": {
        "type": "string"
      }
    },
    "publicSubnetIds": {
      "type": "array",
      "description": "AWS BYO-VPC only: public subnet IDs (at most 6 entries)",
      "items": {
        "type": "string"
      }
    },
    "gcpPodCidrRangeNames": {
      "type": "array",
      "description": "GCP BYO-VPC only: secondary IP range names on the subnet to use for pod IPs. Omitted: all secondary ranges are used",
      "items": {
        "type": "string"
      }
    },
    "gcpSharedVpcHostProjectId": {
      "description": "GCP BYO-VPC only: Shared VPC host project owning the VPC and subnet, when different from `accountId`",
      "type": "string"
    },
    "tags": {
      "$ref": "#/components/schemas/ByocInfrastructureTags"
    }
  },
  "required": [
    "regionId",
    "accountId"
  ]
}

ByocInfrastructureValidation (spec: ByocInfrastructureValidation)

Schema JSON

{
  "properties": {
    "cloudProvider": {
      "description": "Cloud provider of the requested region",
      "type": "string",
      "enum": [
        "gcp",
        "aws",
        "azure"
      ]
    },
    "allPassed": {
      "description": "True when every check passed",
      "type": "boolean"
    },
    "anyPassed": {
      "description": "True when at least one check passed",
      "type": "boolean"
    },
    "supported": {
      "description": "Whether preflight validation is implemented for the requested cloud and configuration. When false, an empty check list means nothing was verified rather than everything passed",
      "type": "boolean"
    },
    "checks": {
      "type": "array",
      "description": "Individual permission checks with their outcomes",
      "items": {
        "$ref": "#/components/schemas/ByocInfrastructureValidationCheck"
      }
    }
  }
}

ByocInfrastructureValidationCheck (spec: ByocInfrastructureValidationCheck)

Schema JSON

{
  "properties": {
    "name": {
      "description": "Human readable name of the check",
      "type": "string",
      "example": "Create EKS cluster"
    },
    "action": {
      "description": "Cloud permission or action the check simulated",
      "type": "string",
      "example": "eks:CreateCluster"
    },
    "allowed": {
      "description": "Whether the account allowed the simulated action",
      "type": "boolean"
    },
    "reason": {
      "description": "Cloud-provider detail for a denied check, e.g. an IAM decision reason",
      "type": "string",
      "example": "implicitDeny"
    },
    "group": {
      "description": "Free-form grouping of related checks, e.g. base or vpc-write. Groupings may change as validations evolve",
      "type": "string"
    }
  }
}

ClickPipeKafkaConfluentSchemaRegistry (spec: ClickPipeKafkaConfluentSchemaRegistry)

Schema JSON

{
  "properties": {
    "type": {
      "description": "Type of the schema registry. Defaults to 'confluent' (a Confluent-compatible REST registry).",
      "type": "string",
      "enum": [
        "confluent"
      ]
    },
    "url": {
      "description": "Schema URL. HTTPS required.",
      "type": "string",
      "example": "https://psrc-aa00.us-east-2.aws.confluent.cloud/schemas/ids/100004"
    },
    "authentication": {
      "description": "Authentication type of the schema registry.",
      "type": "string",
      "enum": [
        "PLAIN"
      ]
    },
    "caCertificate": {
      "description": "PEM encoded CA certificates to validate the schema registry's certificate.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "url"
  ]
}

ClickPipeKafkaGlueSchemaRegistry (spec: ClickPipeKafkaGlueSchemaRegistry)

Schema JSON

{
  "properties": {
    "type": {
      "description": "Type of the schema registry. Use 'glue' for the AWS Glue Schema Registry, which authenticates with IAM instead of credentials.",
      "type": "string",
      "enum": [
        "glue"
      ]
    },
    "glueRegion": {
      "description": "AWS region of the Glue Schema Registry.",
      "type": "string",
      "example": "us-east-1"
    },
    "glueRegistryName": {
      "description": "Name of the Glue Schema Registry.",
      "type": "string",
      "example": "my-registry"
    },
    "glueRoleArn": {
      "description": "IAM role to assume for Glue Schema Registry access. Defaults to the iamRole of the Kafka source, so it is required when the source does not authenticate with IAM. Read more in ClickPipes documentation: https://clickhouse.com/docs/en/integrations/clickpipes/kafka#iam",
      "type": "string",
      "example": "arn:aws:iam::123456789012:role/MyGlueRegistryRole"
    }
  },
  "required": [
    "type",
    "glueRegion",
    "glueRegistryName"
  ]
}

ClickPipeMutateKafkaConfluentSchemaRegistry (spec: ClickPipeMutateKafkaConfluentSchemaRegistry)

Schema JSON

{
  "properties": {
    "type": {
      "description": "Type of the schema registry. Defaults to 'confluent' (a Confluent-compatible REST registry).",
      "type": "string",
      "enum": [
        "confluent"
      ]
    },
    "url": {
      "description": "Schema URL. HTTPS required.",
      "type": "string",
      "example": "https://psrc-aa00.us-east-2.aws.confluent.cloud/schemas/ids/100004"
    },
    "authentication": {
      "description": "Authentication type of the schema registry.",
      "type": "string",
      "enum": [
        "PLAIN"
      ]
    },
    "caCertificate": {
      "description": "PEM encoded CA certificates to validate the schema registry's certificate.",
      "type": [
        "string",
        "null"
      ]
    },
    "credentials": {
      "$ref": "#/components/schemas/ClickPipeKafkaSchemaRegistryCredentials"
    }
  },
  "required": [
    "url",
    "authentication",
    "credentials"
  ]
}

PostgresBackup (spec: PostgresBackup)

Schema JSON

{
  "properties": {
    "key": {
      "description": "Identifier of the base backup.",
      "type": "string",
      "example": "basebackups_005/000000010000000000000002_backup_stop_sentinel.json"
    },
    "lastModified": {
      "description": "Time the backup was last written to. ISO-8601.",
      "type": "string",
      "format": "date-time",
      "example": "2026-03-31T18:17:37Z"
    }
  },
  "required": [
    "key",
    "lastModified"
  ]
}

PublicSavedQuery (spec: PublicSavedQuery)

Schema JSON

{
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique ID of the saved query.",
      "type": "string",
      "format": "uuid",
      "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)$"
    },
    "name": {
      "description": "Name of the saved query.",
      "type": "string"
    },
    "sql": {
      "description": "Saved SQL query.",
      "type": "string",
      "maxLength": 4194304
    },
    "database": {
      "description": "Database used by the saved query.",
      "type": "string"
    },
    "parameters": {
      "description": "Query parameters.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "id",
    "name",
    "sql",
    "database",
    "parameters"
  ],
  "additionalProperties": false
}

PublicSavedQueryListItem (spec: PublicSavedQueryListItem)

Schema JSON

{
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique ID of the saved query.",
      "type": "string",
      "format": "uuid",
      "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)$"
    },
    "name": {
      "description": "Name of the saved query.",
      "type": "string"
    },
    "database": {
      "description": "Database used by the saved query.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "database"
  ],
  "additionalProperties": false
}

PublicSavedQueryRequest (spec: PublicSavedQueryRequest)

Schema JSON

{
  "type": "object",
  "properties": {
    "name": {
      "description": "Name of the saved query.",
      "type": "string",
      "minLength": 1
    },
    "sql": {
      "description": "Saved SQL query.",
      "type": "string",
      "maxLength": 4194304
    },
    "database": {
      "description": "Database used by the saved query.",
      "type": "string"
    },
    "parameters": {
      "description": "Default query parameters.",
      "default": {},
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "name",
    "sql",
    "database"
  ]
}

ReversePrivateEndpointDnsTarget (spec: ReversePrivateEndpointDnsTarget)

Schema JSON

{
  "properties": {
    "id": {
      "description": "DNS target ID. For VPC_RESOURCE, the associated CHILD resource configuration ID, or the configuration ID for a single resource.",
      "type": "string",
      "example": "rcfg-097648d8068504966"
    },
    "kind": {
      "description": "DNS target kind.",
      "type": "string",
      "enum": [
        "RESOURCE_CONFIGURATION"
      ],
      "example": "RESOURCE_CONFIGURATION"
    },
    "internalDnsName": {
      "description": "Internal DNS name currently reported for this target. To select a target for a custom private DNS mapping, use its id as targetId.",
      "type": "string",
      "example": "vpce-052ef252671124ada.rcfg-097648d8068504966.4232ccc.vpc-lattice-rsc.us-east-1.on.aws"
    }
  }
}

ReversePrivateEndpointPrivateDnsMapping (spec: ReversePrivateEndpointPrivateDnsMapping)

Schema JSON

{
  "properties": {
    "privateDnsName": {
      "description": "Provider private DNS name reported by the Reverse Private Endpoint.",
      "type": "string",
      "example": "my-service.example.com"
    },
    "internalDnsName": {
      "description": "Internal DNS target for the provider private DNS name.",
      "type": "string",
      "example": "vpce-0123456789abcdef0-abcdefg.vpce-svc-0123456789abcdef0.us-east-1.vpce.amazonaws.com"
    }
  }
}

Whoami (spec: Whoami)

Schema JSON

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/WhoamiUser"
    },
    {
      "$ref": "#/components/schemas/WhoamiApiKey"
    }
  ]
}

WhoamiApiKey (spec: WhoamiApiKey)

Schema JSON

{
  "properties": {
    "actorType": {
      "description": "Discriminator identifying the caller as an organization API key.",
      "type": "string",
      "const": "apiKey"
    },
    "keyId": {
      "description": "Unique ID of the API key.",
      "type": "string"
    },
    "name": {
      "description": "Name of the API key.",
      "type": "string"
    },
    "organizationId": {
      "description": "ID of the organization that owns the API key.",
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "actorType",
    "keyId",
    "name",
    "organizationId"
  ]
}

WhoamiOrganization (spec: WhoamiOrganization)

Schema JSON

{
  "properties": {
    "organizationId": {
      "description": "ID of the organization the user belongs to.",
      "type": "string",
      "format": "uuid"
    },
    "organizationName": {
      "description": "Name of the organization.",
      "type": "string"
    }
  },
  "required": [
    "organizationId",
    "organizationName"
  ]
}

WhoamiUser (spec: WhoamiUser)

Schema JSON

{
  "properties": {
    "actorType": {
      "description": "Discriminator identifying the caller as a user (JWT or clickhousectl token).",
      "type": "string",
      "const": "user"
    },
    "userId": {
      "description": "Unique ID of the user.",
      "type": "string",
      "format": "uuid"
    },
    "email": {
      "description": "Email address of the user.",
      "type": "string",
      "format": "email"
    },
    "name": {
      "description": "Full name of the user.",
      "type": "string"
    },
    "organizations": {
      "type": "array",
      "description": "Organizations the user belongs to.",
      "items": {
        "$ref": "#/components/schemas/WhoamiOrganization"
      }
    }
  },
  "required": [
    "actorType",
    "userId",
    "email",
    "name",
    "organizations"
  ]
}

Acknowledged Unsupported Enum Constraints

These locations are inventoried but cannot yet be compared to a typed Rust value enum.
Acknowledgments cover the snapshot's enum values; changed values and new or stale locations count as drift.

• /components/schemas/ApiKey/properties/roles/items (models.rs::ApiKey::roles) — Rust type String is not an enum
• /components/schemas/ApiKeyPatchRequest/properties/roles/items (models.rs::ApiKeyPatchRequest::roles) — Rust type String is not an enum
• /components/schemas/ApiKeyPostRequest/properties/roles/items (models.rs::ApiKeyPostRequest::roles) — Rust type String is not an enum

Implementation Guide

1. Replace crates/clickhouse-cloud-api/clickhouse_cloud_openapi.json with this same live document; do not hand-edit it.
2. Follow each finding's spec_pointer and rust_item to update client.rs, models.rs, or meta.rs.
3. Regenerate beta/deprecation metadata when applicable and add focused model/client tests.
4. Edit crates/clickhouse-openapi-analyzer/src/config.rs only for a deliberate, documented divergence. New unsupported acknowledgements require a tracking issue.
5. Run the analyzer and Cloud API tests, Clippy, Python renderer tests, and this dry run again; see AGENTS.md for the exact commands.