Link11 WAAP
v5
v5
  • Link11 WAAP Documentation
  • Release Notes
  • Known Issues
  • User Guide
    • Introduction to Link11 WAAP
  • How Link11 WAAP Works
    • Traffic Filtering Process
    • Traffic Reporting and Analytics
    • Policy Mapping and Traffic Routing
    • Tagging
    • UI Overview and Common Elements
  • Console UI Walkthrough
    • Analytics
      • Dashboard
      • Events Log
    • Security
      • Global Filters
      • Flow Control Policies
      • Security Policies
      • Rate Limit Rules
      • ACL Profiles
      • Actions
      • Dynamic Rules
      • Quarantined
      • Content Filter
        • Content Filter Profiles
        • Content Filter Rules
    • Sites
      • Server Groups
      • Proxy Templates
      • Mobile Application Groups
      • Backend Services
      • Edge Functions
      • DNS Records
      • SSL
        • Load Balancers
        • Certificates
    • System
      • Interactive Challenge
      • SSO Configuration
      • Purge CDN Cache
      • Users Management
      • Security Alerts
      • Log Exporters
      • Version Control
      • System DB
      • Publish Changes
    • Account
  • Using the product
    • Best Practices
      • Saving and Publishing Your Changes
      • Enabling Passive Challenges
      • Understanding and Diagnosing Traffic Issues
    • How Do I...
      • Authenticate mobile app users
      • Ban, unban, and allowlist traffic sources
      • Bypass Link11 WAAP for loadtesting or other purposes
      • Configure a new path/section of a site
      • Control caching behavior
      • Enable GraphQL traffic
      • Enable mTLS (mutual TLS)
      • Protect sensitive information in logs and analytics
      • Quickly block an attacker
      • Redirect or block HTTP traffic
      • Run custom code
      • Set rate limits and exemptions
      • Stream event data to a SIEM solution or other destination
    • The Link11 WAAP API
      • Overview
      • Internal data structures
      • Using Swagger UI
      • Using curl
  • Reference Information
    • Acronyms
    • API
      • API access to traffic data
      • Types of namespaces
      • Namespace reference
        • ACL Profiles
        • Actions
        • Backend Services
        • Certificates
        • Configs
        • Content Filter Profiles
        • Content Filter Rules
        • Data queries
        • Dynamic Rules
        • Edge Functions
        • Flow Control Policies
        • Global Filters
        • Load Balancers
        • Log Exporters
        • Mobile Application Groups
        • Planets
        • Proxy Templates
        • Rate Limit Rules
        • Security Alerts
        • Security Policies
        • Server Groups
        • Tags
        • Tools
        • Users
    • Hostile Bot Detection / LWCSI
      • Environmental detection and browser verification
      • Client authentication
      • Biometric behavioral verification
    • HTTP Response Codes
    • Log Exporter Output
    • Pattern Matching Syntax
    • Query Filter Syntax and Best Practices
  • Support
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Reference Information
  2. API
  3. Namespace reference

Log Exporters

PreviousLoad BalancersNextMobile Application Groups

Last updated 2 months ago

Was this helpful?

Get Log Exporters

get

Get all Log Exporters in a configuration

Path parameters
configstringRequired
Responses
200
Log Exporters retrieved successfully
application/json
422
Validation Error
application/json
get
GET /api/v4.0/conf/{config}/log-exporters HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "active": true,
      "filter": "all",
      "format": "custom_syslog",
      "server_groups": {
        "all": true,
        "ids": [
          "text"
        ]
      },
      "connection": {
        "host": "https://example.com",
        "port": 1,
        "protocol": "text",
        "tls_mode": "no_tls",
        "certificate": {
          "chain_data": [],
          "cert_body": "text"
        }
      }
    }
  ]
}

Get single Log Exporter configuration

get

Get an individual Log Exporter configuration from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Log Exporter configuration retrieved successfully
application/json
422
Validation Error
application/json
get
GET /api/v4.0/conf/{config}/log-exporters/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "name": "text",
  "active": true,
  "filter": "all",
  "format": "custom_syslog",
  "server_groups": {
    "all": true,
    "ids": [
      "text"
    ]
  },
  "connection": {
    "host": "https://example.com",
    "port": 1,
    "protocol": "text",
    "tls_mode": "no_tls",
    "certificate": {
      "chain_data": [],
      "cert_body": "text"
    }
  }
}

Delete single Log Exporter configuration

delete

Delete an individual Log Exporter configuration from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Log Exporter configuration deleted successfully
application/json
422
Validation Error
application/json
delete
DELETE /api/v4.0/conf/{config}/log-exporters/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get Log Exporters version list

get

Get list of versions of Log Exporters in a configuration

Path parameters
configstringRequired
Responses
200
Log Exporters version list retrieved successfully
application/json
422
Validation Error
application/json
get
GET /api/v4.0/conf/{config}/log-exporters/versions HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2025-05-03T17:12:46.163Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Log Exporters

get

Get a specific version of an Log Exporter configuration

Path parameters
configstringRequired
versionstringRequired
Responses
200
Log Exporter configuration version retrieved successfully
application/json
422
Validation Error
application/json
get
GET /api/v4.0/conf/{config}/log-exporters/versions/{version} HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "active": true,
      "filter": "all",
      "format": "custom_syslog",
      "server_groups": {
        "all": true,
        "ids": [
          "text"
        ]
      },
      "connection": {
        "host": "https://example.com",
        "port": 1,
        "protocol": "text",
        "tls_mode": "no_tls",
        "certificate": {
          "chain_data": [],
          "cert_body": "text"
        }
      }
    }
  ]
}

Revert Log Exporters to the specified version

put

Set a previous Log Exporters version to be the current one

Path parameters
configstringRequired
versionstringRequired
Responses
200
Log Exporters reversion was successful
application/json
422
Validation Error
application/json
put
PUT /api/v4.0/conf/{config}/log-exporters/versions/{version}/revert HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully updated entry"
}
  • GETGet Log Exporters
  • GETGet single Log Exporter configuration
  • PUTModify a single Log Exporter configuration
  • POSTCreate single Log Exporter configuration
  • DELETEDelete single Log Exporter configuration
  • GETGet Log Exporters version list
  • GETGet version of Log Exporters
  • PUTRevert Log Exporters to the specified version

Modify a single Log Exporter configuration

put

Update an individual Log Exporter configuration within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
idstringRequired
namestringRequired

Name field

activebooleanOptional

This configuration will only take effect when the flag is set to true

Default: false
filterstring · enumOptionalPossible values:
formatstring · enumRequired

Format of the log row that will be exported

Possible values:
Responses
200
Log Exporter configuration updated successfully
application/json
422
Validation Error
application/json
put
PUT /api/v4.0/conf/{config}/log-exporters/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 251

{
  "id": "text",
  "name": "text",
  "active": true,
  "filter": "all",
  "format": "custom_syslog",
  "server_groups": {
    "all": true,
    "ids": [
      "text"
    ]
  },
  "connection": {
    "host": "https://example.com",
    "port": 1,
    "protocol": "text",
    "tls_mode": "no_tls",
    "certificate": {
      "cert_body": "text"
    }
  }
}
{
  "message": "Successfully updated entry"
}

Create single Log Exporter configuration

post

Create an individual Log Exporter configuration within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
idstringRequired
namestringRequired

Name field

activebooleanOptional

This configuration will only take effect when the flag is set to true

Default: false
filterstring · enumOptionalPossible values:
formatstring · enumRequired

Format of the log row that will be exported

Possible values:
Responses
201
Log Exporter configuration created successfully
application/json
422
Validation Error
application/json
post
POST /api/v4.0/conf/{config}/log-exporters/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 251

{
  "id": "text",
  "name": "text",
  "active": true,
  "filter": "all",
  "format": "custom_syslog",
  "server_groups": {
    "all": true,
    "ids": [
      "text"
    ]
  },
  "connection": {
    "host": "https://example.com",
    "port": 1,
    "protocol": "text",
    "tls_mode": "no_tls",
    "certificate": {
      "cert_body": "text"
    }
  }
}
{
  "message": "Successfully created entry"
}