clickhouse-admin-single.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "ClickHouse Single-Node Admin Server API",
    "description": "API for interacting with the Oxide control plane's single-node ClickHouse database",
    "contact": {
      "url": "https://oxide.computer",
      "email": "api@oxide.computer"
    },
    "version": "0.0.1"
  },
  "paths": {
    "/init": {
      "put": {
        "summary": "Idempotently initialize a single-node ClickHouse database.",
        "operationId": "init_db",
        "responses": {
          "204": {
            "description": "resource updated"
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    },
    "/timeseries/{table}/{metric}/avg": {
      "get": {
        "summary": "Retrieve time series from the system database.",
        "description": "The value of each data point is the average of all stored data points within the interval. These are internal ClickHouse metrics.",
        "operationId": "system_timeseries_avg",
        "parameters": [
          {
            "in": "path",
            "name": "metric",
            "description": "Name of the metric to retrieve.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "table",
            "description": "Table to query in the `system` database",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/SystemTable"
            }
          },
          {
            "in": "query",
            "name": "interval",
            "description": "The interval to collect monitoring metrics in seconds. Default is 60 seconds.",
            "schema": {
              "type": "integer",
              "format": "uint64",
              "minimum": 0
            }
          },
          {
            "in": "query",
            "name": "time_range",
            "description": "Range of time to collect monitoring metrics in seconds. Default is 86400 seconds (24 hrs).",
            "schema": {
              "type": "integer",
              "format": "uint64",
              "minimum": 0
            }
          },
          {
            "in": "query",
            "name": "timestamp_format",
            "description": "Format in which each timeseries timestamp will be in. Default is UTC",
            "schema": {
              "$ref": "#/components/schemas/TimestampFormat"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Array_of_SystemTimeSeries",
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SystemTimeSeries"
                  }
                }
              }
            }
          },
          "4XX": {
            "$ref": "#/components/responses/Error"
          },
          "5XX": {
            "$ref": "#/components/responses/Error"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Error": {
        "description": "Error information from a response.",
        "type": "object",
        "properties": {
          "error_code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "request_id": {
            "type": "string"
          }
        },
        "required": [
          "message",
          "request_id"
        ]
      },
      "SystemTimeSeries": {
        "description": "Retrieved time series from the internal `system` database.",
        "type": "object",
        "properties": {
          "time": {
            "type": "string"
          },
          "value": {
            "type": "number",
            "format": "double"
          }
        },
        "required": [
          "time",
          "value"
        ]
      },
      "SystemTable": {
        "description": "Available metrics tables in the `system` database",
        "type": "string",
        "enum": [
          "asynchronous_metric_log",
          "metric_log"
        ]
      },
      "TimestampFormat": {
        "description": "Which format should the timestamp be in.",
        "type": "string",
        "enum": [
          "utc",
          "unix_epoch"
        ]
      }
    },
    "responses": {
      "Error": {
        "description": "Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    }
  }
}