Skip to content

API Support for Log Pipeline Management #9799

@gonultasmf

Description

@gonultasmf

Currently, SigNoz only supports managing log pipelines through the UI. I would like to request API endpoints to programmatically create, update, and delete log pipelines.

Use Case
Managing log pipelines via API would enable:

Infrastructure as Code (IaC) practices
Automated pipeline deployment across environments
Version control for pipeline configurations
CI/CD integration for pipeline management
Programmatic bulk operations on pipelines
Current Limitation
According to the Logs API documentation, the API currently supports:

Searching logs
Paginating logs
Aggregating logs
However, there's no documented way to manage pipelines (create, read, update, delete) programmatically.

Proposed Solution
Add REST API endpoints for pipeline management, similar to the existing Logs Query API:

POST   /api/v1/pipelines          # Create pipeline
GET    /api/v1/pipelines          # List pipelines
GET    /api/v1/pipelines/{id}     # Get pipeline details
PUT    /api/v1/pipelines/{id}     # Update pipeline
DELETE /api/v1/pipelines/{id}     # Delete pipeline

Expected Behavior
API authentication using existing SIGNOZ-API-KEY header
JSON payload format matching the pipeline configuration structure
Response codes following REST conventions (200, 201, 400, 404, etc.)
Alternative Workarounds
Currently considering:

Managing processors in OpenTelemetry Collector configuration
Manual UI-based pipeline management (not scalable)
Additional Context
This feature would significantly improve the experience for teams managing multiple SigNoz instances or deploying pipelines across different environments.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions