OpenAPI Specification

Complete OpenAPI 3.0 specification for all Lightning Logs API endpoints.

Download Specification
Download the OpenAPI specification file in YAML format
Download openapi.yaml

The specification file can be imported into tools like Postman, Insomnia, or Swagger UI.

View in Swagger UI
View the interactive API documentation
Open in Swagger Editor

Use Swagger Editor to view, edit, and test the API specification.

Specification Overview

Version

OpenAPI 3.0.3

Endpoints Covered

  • Log ingestion and search
  • Saved searches management
  • Usage and quota monitoring
  • Alert rules and history
  • Tenant and settings management
  • API key management
  • Health checks

Authentication Methods

  • JWT Bearer tokens (Supabase Auth)
  • API keys (X-API-Key header or Bearer with ll_ prefix)

Using the Specification

Import into Postman

  1. Open Postman
  2. Click Import
  3. Select the downloaded openapi.yaml file
  4. All endpoints will be imported as a collection

Generate Client SDKs

Use tools like OpenAPI Generator to generate client SDKs in various languages:

# Install OpenAPI Generator
npm install @openapitools/openapi-generator-cli -g

# Generate TypeScript client
openapi-generator-cli generate \
  -i openapi.yaml \
  -g typescript-axios \
  -o ./generated-client

API Testing

The OpenAPI specification can be used with tools like Insomnia, Bruno, or HTTPie for API testing.