v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Observability Pipelines

Validate an observability pipeline

Validates a pipeline configuration without creating or updating any resources. Returns a list of validation errors, if any.

post/api/v2/obs-pipelines/pipelines/validate

Request body

Example request

{
  "data": {
    "attributes": {
      "config": {
        "destinations": [
          {
            "id": "datadog-logs-destination",
            "inputs": [
              "my-processor-group"
            ],
            "type": "datadog_logs"
          }
        ],
        "pipeline_type": "logs",
        "processor_groups": [
          {
            "enabled": true,
            "id": "my-processor-group",
            "include": "service:my-service",
            "inputs": [
              "datadog-agent-source"
            ],
            "processors": [
              {
                "enabled": true,
                "id": "filter-processor",
                "include": "status:error",
                "type": "filter"
              },
              {
                "enabled": true,
                "field": "message",
                "id": "json-processor",
                "include": "*",
                "type": "parse_json"
              }
            ]
          }
        ],
        "processors": [],
        "sources": [
          {
            "id": "datadog-agent-source",
            "type": "datadog_agent"
          }
        ]
      },
      "name": "Main Observability Pipeline"
    },
    "type": "pipelines"
  }
}

Response

Example response

{
  "errors": [
    {
      "meta": {
        "field": "region",
        "id": "datadog-agent-source",
        "message": "Field 'region' is required"
      },
      "title": "Field 'region' is required"
    }
  ]
}