Log Exporters

Get Log Exporters

Get all Log Exporters in a configuration

GET/api/v4.0/conf/{config}/log-exporters

Path parameters

config*Config

Response

200422

Log Exporters retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of LogExporterOut (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/log-exporters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "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": 0,
        "protocol": "text",
        "enable_tls": false,
        "certificate": {
          "chain_data": [],
          "cert_body": "text"
        }
      }
    }
  ]
}

Delete single Log Exporter configuration

Delete an individual Log Exporter configuration from the specified configuration

DELETE/api/v4.0/conf/{config}/log-exporters/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

200422

Log Exporter configuration deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/log-exporters/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully deleted entry"
}

Get Log Exporters version list

Get list of versions of Log Exporters in a configuration

GET/api/v4.0/conf/{config}/log-exporters/versions

Path parameters

config*Config

Response

200422

Log Exporters version list retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of VersionEntry

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/log-exporters/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[e-mail]",
      "message": "text",
      "date": "2025-01-19T06:28:56.818Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Revert Log Exporters to the specified version

Set a previous Log Exporters version to be the current one

PUT/api/v4.0/conf/{config}/log-exporters/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

200422

Log Exporters reversion was successful

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/log-exporters/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}