Reference¶
Use these pages to look up Siglake interfaces, defaults, limits and schemas.
| Page | Contents |
|---|---|
| HTTP API | Ingester and query-server endpoints, request fields and response fields. |
| OpenAPI specifications | Machine-readable ingester and query APIs. Regenerate in the Siglake repo with cargo run -p siglake-openapi -- --out docs/api; the servers deliberately expose no runtime /openapi.json, keeping that route out of their attack surface. |
| CLI | Every siglake, siglake-query-server and siglake-operator subcommand and flag. Generated from the binaries. |
| Configuration | SIGLAKE_* environment variables, and the OTEL_* ones that configure Siglake's own OTLP export. Inventory generated from the source tree. |
| Table schemas | Columns in events, query_audit and user indexes. Tables generated from the source tree. |
| Metrics | Prometheus metrics exported by each role. Generated from the source tree. |
Ports¶
Defaults for each role:
| Role | API | Metrics |
|---|---|---|
| Ingester | 8088 | 9100 |
| Compactor | None | 9101 |
| Query server | 8089 | 9105 (SIGLAKE_QUERY_METRICS_BIND) |
Generated pages¶
Five of these pages have their tables generated directly from the Siglake source tree, because hand-maintaining 277 environment variables, 490 metrics and every table's field ids across a fast-moving codebase does not work.
Regenerate the pages from a Siglake checkout:
The generator preserves prose outside its marked blocks. If that prose disagrees with a generated table, update the prose.