Log Exporters

PreviousLoad Balancers NextMobile Application Groups

Last updated 1 month ago

Was this helpful?

Get Log Exporters

get

Get all Log Exporters in a configuration

Path parameters

configstringrequired

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

Log Exporters retrieved successfully

Get single Log Exporter configuration

get

Get an individual Log Exporter configuration from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

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

Log Exporter configuration retrieved successfully

Delete single Log Exporter configuration

delete

Delete an individual Log Exporter configuration from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

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

Get list of versions of Log Exporters in a configuration

Path parameters

configstringrequired

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": "name@gmail.com",
      "message": "text",
      "date": "2025-04-03T05:34:12.921Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Log Exporters version list retrieved successfully

Get version of Log Exporters

get

Get a specific version of an Log Exporter configuration

Path parameters

configstringrequired

versionstringrequired

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

Log Exporter configuration version retrieved successfully

Revert Log Exporters to the specified version

put

Set a previous Log Exporters version to be the current one

Path parameters

configstringrequired

versionstringrequired

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

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

activeboolean · default: falseoptional

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

filterstring · enumoptional

Available options:

formatstring · enumrequired

Format of the log row that will be exported

Available options:

server_groupsobjectrequired

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": 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"
      }
    }
  }'

200

422

{
  "message": "Successfully updated entry"
}

Log Exporter configuration updated successfully

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

activeboolean · default: falseoptional

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

filterstring · enumoptional

Available options:

formatstring · enumrequired

Format of the log row that will be exported

Available options:

server_groupsobjectrequired

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": 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"
      }
    }
  }'

201

422

{
  "message": "Successfully created entry"
}

Log Exporter configuration created successfully

Get Log Exporters

Get single Log Exporter configuration

Delete single Log Exporter configuration

Get Log Exporters version list

Get version of Log Exporters

Revert Log Exporters to the specified version

Modify a single Log Exporter configuration

Show Server Groups

Show child attributes

Create single Log Exporter configuration

Show Server Groups

Show child attributes