Pipeline Configuration via API

Automate Logstash pipeline management for your Log stack using the Logit.io Developer API. This guide covers retrieving configuration, validating changes, applying updates, and restarting the pipeline.

For background on ingestion pipelines, see Log Management Ingestion Pipeline.

Use your Dashboard API key from the Profile (opens in a new tab) page in the x-api-key header. See Authentication for setup and security. Examples use @logs_id for your Log stack (from your session/JWT when signed in).

Get Pipeline Configuration

Retrieve the current pipeline configuration and its status:

curl -H "x-api-key: @dashboardApiKey" https://dashboard.logit.io/api/stacks/@logs_id/pipeline-config

The response includes the configuration (filter YAML), last updated time, and whether it is stale.

Validate Pipeline Configuration

Test a pipeline configuration before applying it. The API runs validation and returns the result. Start validation with POST, then poll the GET endpoint until you get a final success or failure (you may see 202 Accepted while validation is running).

Start validation

POST with testConfiguration in the body.

curl -X POST -H "x-api-key: @dashboardApiKey" -H "Content-Type: application/json" \
  -d '{"testConfiguration": "filter {\n  grok { ... }\n}"}' \
  https://dashboard.logit.io/api/stacks/@logs_id/pipeline-config/validation

Get validation result

Poll this endpoint until validation completes.

curl -H "x-api-key: @dashboardApiKey" https://dashboard.logit.io/api/stacks/@logs_id/pipeline-config/validation

Apply Pipeline Configuration

After validating a test configuration, apply it to update the pipeline's filter configuration:

curl -X PUT -H "x-api-key: @dashboardApiKey" https://dashboard.logit.io/api/stacks/@logs_id/pipeline-config/apply

This updates the pipeline to match the validated test configuration.

Sync Pipeline Configuration

Request the latest pipeline configuration from the server (useful if configuration may have changed elsewhere):

curl -X PUT -H "x-api-key: @dashboardApiKey" https://dashboard.logit.io/api/stacks/@logs_id/pipeline-config/sync

Restart the Pipeline

Restart the Logstash Filter instance for the stack. This typically takes around 5 minutes to complete:

curl -X POST -H "x-api-key: @dashboardApiKey" https://dashboard.logit.io/api/stacks/@logs_id/pipeline/restart

Use this after applying configuration changes or to recover from pipeline issues. The pipeline will process in-flight data before restarting.

Typical Workflow

1. Get current config — GET /pipeline-config
2. Modify locally — Edit the filter configuration
3. Validate — POST /pipeline-config/validation with testConfiguration
4. Poll — GET /pipeline-config/validation until complete
5. Apply — PUT /pipeline-config/apply when validation succeeds
6. Restart (optional) — POST /pipeline/restart if needed

Full API Reference

See the API Reference for complete endpoint details and schemas. For configuring Logstash inputs and filters in the UI, see Configure Logstash Inputs and the Filter Editor.