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

Log Exporters retrieved successfully

Body

totalinteger

Example: 1

itemsarray of LogExporterOut (object)

Request

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

Response

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "active": false,
      "format": "custom_syslog",
      "connection": {
        "host": "https://example.com",
        "port": 0,
        "protocol": "text",
        "enable_tls": false,
        "certificate": {
          "chain_data": [],
          "cert_body": "text"
        }
      }
    }
  ]
}

Get single Log Exporter configuration

Get an individual Log Exporter configuration from the specified configuration

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

Path parameters

config*Config

entry_id*Entry

Response

Log Exporter configuration retrieved successfully

Body

id*string

name*string

Name field

activeConfiguration active

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

format*enum

Format of the log row that will be exported

custom_syslog

connection*object

Request

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

Response

{
  "id": "text",
  "name": "text",
  "active": false,
  "format": "custom_syslog",
  "connection": {
    "host": "https://example.com",
    "port": 0,
    "protocol": "text",
    "enable_tls": false,
    "certificate": {
      "chain_data": [],
      "cert_body": "text"
    }
  }
}

Modify a single Log Exporter configuration

Update an individual Log Exporter configuration within a configuration

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

Path parameters

config*Config

entry_id*Entry

Body

id*string

name*string

Name field

activeConfiguration active

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

format*enum

Format of the log row that will be exported

custom_syslog

connection*object

Response

Log Exporter configuration updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/log-exporters/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "format": "custom_syslog",
      "connection": {
        "host": "https://example.com",
        "port": 0,
        "protocol": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

Create single Log Exporter configuration

Create an individual Log Exporter configuration within a configuration

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

Path parameters

config*Config

entry_id*Entry

Body

id*string

name*string

Name field

activeConfiguration active

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

format*enum

Format of the log row that will be exported

custom_syslog

connection*object

Response

Log Exporter configuration created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/log-exporters/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "format": "custom_syslog",
      "connection": {
        "host": "https://example.com",
        "port": 0,
        "protocol": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully created entry"
}

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

Log Exporter configuration deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

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

Response

{
  "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

Log Exporters version list retrieved successfully

Body

totalinteger

Example: 1

itemsarray of VersionEntry

Request

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

Response

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2024-12-04T18:32:48.897Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Log Exporters

Get a specific version of an Log Exporter configuration

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

Path parameters

config*Config

version*Version

Response

Log Exporter configuration version retrieved successfully

Body

totalinteger

Example: 1

itemsarray of LogExporterOut (object)

Request

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

Response

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "active": false,
      "format": "custom_syslog",
      "connection": {
        "host": "https://example.com",
        "port": 0,
        "protocol": "text",
        "enable_tls": false,
        "certificate": {
          "chain_data": [],
          "cert_body": "text"
        }
      }
    }
  ]
}

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

Log Exporters reversion was successful

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

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

Response

{
  "message": "Successfully updated entry"
}

PreviousLoad Balancers NextPlanets

Last updated 2 days ago