Log Exporters

PreviousLoad Balancers NextMobile Application Groups

Last updated 8 days ago

Was this helpful?

Get Log Exporters

Get all Log Exporters in a configuration

get

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

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/log-exporters'

200

422

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

Log Exporters retrieved successfully

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

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/log-exporters/{entry_id}'

200

422

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

Log Exporter configuration retrieved successfully

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

configConfigrequired

entry_idEntryrequired

Body

idstringrequired

namestringrequired

Name field

activeConfiguration active

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

filterenum

Options: all, blocked

formatenumrequired

Format of the log row that will be exported

Options: custom_syslog

server_groupsServer Groupsrequired

List of attached Server Group IDs or all

connectionobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/log-exporters/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","name":"text","active":false,"filter":"all","format":"custom_syslog","server_groups":{"all":true,"ids":[null]},"connection":{"port":1,"protocol":"text","tls_mode":"no_tls","certificate":{"cert_body":"text"}}}'

200

422

{
  "message": "Successfully updated entry"
}

Log Exporter configuration updated successfully

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

configConfigrequired

entry_idEntryrequired

Body

idstringrequired

namestringrequired

Name field

activeConfiguration active

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

filterenum

Options: all, blocked

formatenumrequired

Format of the log row that will be exported

Options: custom_syslog

server_groupsServer Groupsrequired

List of attached Server Group IDs or all

connectionobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/log-exporters/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","name":"text","active":false,"filter":"all","format":"custom_syslog","server_groups":{"all":true,"ids":[null]},"connection":{"port":1,"protocol":"text","tls_mode":"no_tls","certificate":{"cert_body":"text"}}}'

201

422

{
  "message": "Successfully created entry"
}

Log Exporter configuration created successfully

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

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/log-exporters/{entry_id}'

200

422

{
  "message": "Successfully deleted entry"
}

Log Exporter configuration deleted successfully

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

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/log-exporters/versions'

200

422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "hello@example.com",
      "message": "text",
      "date": "2025-02-13T08:26:06.341Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Log Exporters version list retrieved successfully

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

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/log-exporters/versions/{version}'

200

422

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

Log Exporter configuration version retrieved successfully

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

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/log-exporters/versions/{version}/revert'

200

422

{
  "message": "Successfully updated entry"
}

Log Exporters reversion was successful