Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Log Exporters

Get Log Exporters

get

Get all Log Exporters in a configuration

Path parameters
configstringRequired
Responses
200

Log Exporters retrieved successfully

application/json
totalintegerOptionalExample: 1
get/api/v4.3/conf/{config}/log-exporters
GET /api/v4.3/conf/{config}/log-exporters HTTP/1.1
Accept: */*

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "active": false,
      "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
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:
get/api/v4.3/conf/{config}/log-exporters/{entry_id}
GET /api/v4.3/conf/{config}/log-exporters/{entry_id} HTTP/1.1
Accept: */*

{
  "id": "text",
  "name": "text",
  "active": false,
  "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"
    }
  }
}

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:
include_request_databooleanOptional

Include base64 encoded request into exported data

Default: false
Responses
200

Log Exporter configuration updated successfully

application/json
messagestringRequired

Information about successful update operation

Example: Successfully updated entry
put/api/v4.3/conf/{config}/log-exporters/{entry_id}
PUT /api/v4.3/conf/{config}/log-exporters/{entry_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 281

{
  "id": "text",
  "name": "text",
  "active": false,
  "filter": "all",
  "format": "custom_syslog",
  "include_request_data": false,
  "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:
include_request_databooleanOptional

Include base64 encoded request into exported data

Default: false
Responses
201

Log Exporter configuration created successfully

application/json
messagestringRequired

Information about successful create operation

Example: Successfully created entry
post/api/v4.3/conf/{config}/log-exporters/{entry_id}
POST /api/v4.3/conf/{config}/log-exporters/{entry_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 281

{
  "id": "text",
  "name": "text",
  "active": false,
  "filter": "all",
  "format": "custom_syslog",
  "include_request_data": false,
  "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"
}

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
messagestringRequired

Information about successful delete operation

Example: Successfully deleted entry
delete/api/v4.3/conf/{config}/log-exporters/{entry_id}
DELETE /api/v4.3/conf/{config}/log-exporters/{entry_id} HTTP/1.1
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
totalintegerOptionalExample: 1
get/api/v4.3/conf/{config}/log-exporters/versions
GET /api/v4.3/conf/{config}/log-exporters/versions HTTP/1.1
Accept: */*

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2026-01-01T00:00:00.000Z",
      "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
totalintegerOptionalExample: 1
get/api/v4.3/conf/{config}/log-exporters/versions/{version}
GET /api/v4.3/conf/{config}/log-exporters/versions/{version} HTTP/1.1
Accept: */*

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "active": false,
      "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
messagestringRequired

Information about successful update operation

Example: Successfully updated entry
put/api/v4.3/conf/{config}/log-exporters/versions/{version}/revert
PUT /api/v4.3/conf/{config}/log-exporters/versions/{version}/revert HTTP/1.1
Accept: */*

{
  "message": "Successfully updated entry"
}
PreviousLoad Balancers
NextMobile Application Groups

Last updated

Was this helpful?