# Log Exporters

## Get Log Exporters

> Get all Log Exporters in a configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/log-exporters":{"get":{"operationId":"document_resource_get_api_v3_configs__config__d__document___get_920494197590142712","summary":"Get Log Exporters","description":"Get all Log Exporters in a configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}}],"responses":{"200":{"description":"Log Exporters retrieved successfully","content":{"application/json":{"schema":{"title":"Log Exporters document","properties":{"total":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/LogExporterOut"}}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Log Exporters"]}}},"components":{"schemas":{"LogExporterOut":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Name field"},"active":{"type":"boolean","description":"This configuration will only take effect when the flag is set to true","title":"Configuration active","default":false},"filter":{"type":"string","enum":["all","blocked"]},"format":{"type":"string","enum":["custom_syslog"],"description":"Format of the log row that will be exported"},"server_groups":{"title":"Server Groups","description":"List of attached Server Group IDs or all","type":"object","properties":{"all":{"type":"boolean","description":"Log for all Server Groups existing now and in the future will be sent.","default":true},"ids":{"type":"array","description":"List of Server Group IDs in case 'all' is False","items":{"type":"string"}}}},"connection":{"type":"object","properties":{"host":{"anyOf":[{"type":"string","format":"uri"},{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]},"port":{"type":"integer"},"protocol":{"type":"string","description":"Protocol (e.g., TCP, UDP, etc.)"},"tls_mode":{"type":"string","default":"no_tls","enum":["no_tls","tls_no_verify","tls"]},"certificate":{"type":"object","properties":{"chain_data":{"type":"array","items":{"cn":"string","exp_date":"string"}},"cert_body":{"type":"string","description":"Certificate body"}},"required":["cert_body"]}},"required":["host","port","protocol"],"additionalProperties":false}},"required":["id","name","format","connection","server_groups"],"additionalProperties":false},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Get single Log Exporter configuration

> Get an individual Log Exporter configuration from the specified configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/log-exporters/{entry_id}":{"get":{"operationId":"entry_resource_get_api_v3_configs__config__d__document__e__entry___get_188924675193220040","summary":"Get single Log Exporter configuration","description":"Get an individual Log Exporter configuration from the specified configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"title":"Entry","type":"string"}}],"responses":{"200":{"description":"Log Exporter configuration retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogExporterOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Log Exporters"]}}},"components":{"schemas":{"LogExporterOut":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Name field"},"active":{"type":"boolean","description":"This configuration will only take effect when the flag is set to true","title":"Configuration active","default":false},"filter":{"type":"string","enum":["all","blocked"]},"format":{"type":"string","enum":["custom_syslog"],"description":"Format of the log row that will be exported"},"server_groups":{"title":"Server Groups","description":"List of attached Server Group IDs or all","type":"object","properties":{"all":{"type":"boolean","description":"Log for all Server Groups existing now and in the future will be sent.","default":true},"ids":{"type":"array","description":"List of Server Group IDs in case 'all' is False","items":{"type":"string"}}}},"connection":{"type":"object","properties":{"host":{"anyOf":[{"type":"string","format":"uri"},{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]},"port":{"type":"integer"},"protocol":{"type":"string","description":"Protocol (e.g., TCP, UDP, etc.)"},"tls_mode":{"type":"string","default":"no_tls","enum":["no_tls","tls_no_verify","tls"]},"certificate":{"type":"object","properties":{"chain_data":{"type":"array","items":{"cn":"string","exp_date":"string"}},"cert_body":{"type":"string","description":"Certificate body"}},"required":["cert_body"]}},"required":["host","port","protocol"],"additionalProperties":false}},"required":["id","name","format","connection","server_groups"],"additionalProperties":false},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Modify a single Log Exporter configuration

> Update an individual Log Exporter configuration within a configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/log-exporters/{entry_id}":{"put":{"operationId":"entry_resource_put_api_v3_configs__config__d__document__e__entry___put_188924675193220040","summary":"Modify a single Log Exporter configuration","description":"Update an individual Log Exporter configuration within a configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"title":"Entry","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogExporter"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUpdate"}}},"description":"Log Exporter configuration updated successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Log Exporters"]}}},"components":{"schemas":{"LogExporter":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Name field"},"active":{"type":"boolean","description":"This configuration will only take effect when the flag is set to true","title":"Configuration active","default":false},"filter":{"type":"string","enum":["all","blocked"]},"format":{"type":"string","enum":["custom_syslog"],"description":"Format of the log row that will be exported"},"include_request_data":{"type":"boolean","description":"Include base64 encoded request into exported data","default":false,"title":"Include Request Data"},"server_groups":{"title":"Server Groups","description":"List of attached Server Group IDs or all","type":"object","properties":{"all":{"type":"boolean","description":"Log for all Server Groups existing now and in the future will be sent.","default":true},"ids":{"type":"array","description":"List of Server Group IDs in case 'all' is False","items":{"type":"string"}}}},"connection":{"type":"object","properties":{"host":{"anyOf":[{"type":"string","format":"uri"},{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]},"port":{"type":"integer"},"protocol":{"type":"string","description":"Protocol (e.g., TCP, UDP, etc.)"},"tls_mode":{"type":"string","default":"no_tls","enum":["no_tls","tls_no_verify","tls"]},"certificate":{"type":"object","properties":{"cert_body":{"type":"string","description":"Certificate body"}},"required":["cert_body"]}},"required":["host","port","protocol"],"additionalProperties":false}},"required":["id","name","format","connection","server_groups"],"additionalProperties":false},"ResponseUpdate":{"title":"ResponseUpdate","type":"object","properties":{"message":{"title":"Message","description":"Information about successful update operation","type":"string"}},"required":["message"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Create single Log Exporter configuration

> Create an individual Log Exporter configuration within a configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/log-exporters/{entry_id}":{"post":{"description":"Create an individual Log Exporter configuration within a configuration","operationId":"entries_resource_post_api_v3_configs__config__d__document__e__post_1233211825730707681","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"title":"Entry","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogExporter"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreate"}}},"description":"Log Exporter configuration created successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Create single Log Exporter configuration","tags":["Log Exporters"]}}},"components":{"schemas":{"LogExporter":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Name field"},"active":{"type":"boolean","description":"This configuration will only take effect when the flag is set to true","title":"Configuration active","default":false},"filter":{"type":"string","enum":["all","blocked"]},"format":{"type":"string","enum":["custom_syslog"],"description":"Format of the log row that will be exported"},"include_request_data":{"type":"boolean","description":"Include base64 encoded request into exported data","default":false,"title":"Include Request Data"},"server_groups":{"title":"Server Groups","description":"List of attached Server Group IDs or all","type":"object","properties":{"all":{"type":"boolean","description":"Log for all Server Groups existing now and in the future will be sent.","default":true},"ids":{"type":"array","description":"List of Server Group IDs in case 'all' is False","items":{"type":"string"}}}},"connection":{"type":"object","properties":{"host":{"anyOf":[{"type":"string","format":"uri"},{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]},"port":{"type":"integer"},"protocol":{"type":"string","description":"Protocol (e.g., TCP, UDP, etc.)"},"tls_mode":{"type":"string","default":"no_tls","enum":["no_tls","tls_no_verify","tls"]},"certificate":{"type":"object","properties":{"cert_body":{"type":"string","description":"Certificate body"}},"required":["cert_body"]}},"required":["host","port","protocol"],"additionalProperties":false}},"required":["id","name","format","connection","server_groups"],"additionalProperties":false},"ResponseCreate":{"title":"ResponseCreate","type":"object","properties":{"message":{"title":"Message","description":"Information about successful create operation","type":"string"}},"required":["message"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Delete single Log Exporter configuration

> Delete an individual Log Exporter configuration from the specified configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/log-exporters/{entry_id}":{"delete":{"operationId":"entry_resource_delete_api_v3_configs__config__d__document__e__entry___delete_188924675193220040","summary":"Delete single Log Exporter configuration","description":"Delete an individual Log Exporter configuration from the specified configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"title":"Entry","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDelete"}}},"description":"Log Exporter configuration deleted successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Log Exporters"]}}},"components":{"schemas":{"ResponseDelete":{"title":"ResponseDelete","type":"object","properties":{"message":{"title":"Message","description":"Information about successful delete operation","type":"string"}},"required":["message"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Get Log Exporters version list

> Get list of versions of Log Exporters in a configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/log-exporters/versions":{"get":{"operationId":"document_list_version_resource_get_api_v3_configs__config__d__document__v__get_2192084746238710671","summary":"Get Log Exporters version list","description":"Get list of versions of Log Exporters in a configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"title":"Versions list","properties":{"total":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/VersionEntry"}}}}}},"description":"Log Exporters version list retrieved successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Log Exporters"]}}},"components":{"schemas":{"VersionEntry":{"title":"VersionEntry","type":"object","properties":{"author":{"title":"Author","type":"string"},"email":{"title":"Email","format":"email","type":"string"},"message":{"title":"Message","type":"string"},"date":{"format":"date-time","title":"Date","type":"string"},"version":{"title":"Version","type":"string"},"parents":{"type":"array","items":{"type":"string"}}}},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Get version of Log Exporters

> Get a specific version of an Log Exporter configuration

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/log-exporters/versions/{version}":{"get":{"operationId":"document_version_resource_get_api_v3_configs__config__d__document__v__version___get_2213417477955538928","summary":"Get version of Log Exporters","description":"Get a specific version of an Log Exporter configuration","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"version","required":true,"schema":{"title":"Version","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"title":"Log Exporters document","properties":{"total":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/LogExporterOut"}}}}}},"description":"Log Exporter configuration version retrieved successfully"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"tags":["Log Exporters"]}}},"components":{"schemas":{"LogExporterOut":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Name field"},"active":{"type":"boolean","description":"This configuration will only take effect when the flag is set to true","title":"Configuration active","default":false},"filter":{"type":"string","enum":["all","blocked"]},"format":{"type":"string","enum":["custom_syslog"],"description":"Format of the log row that will be exported"},"server_groups":{"title":"Server Groups","description":"List of attached Server Group IDs or all","type":"object","properties":{"all":{"type":"boolean","description":"Log for all Server Groups existing now and in the future will be sent.","default":true},"ids":{"type":"array","description":"List of Server Group IDs in case 'all' is False","items":{"type":"string"}}}},"connection":{"type":"object","properties":{"host":{"anyOf":[{"type":"string","format":"uri"},{"type":"string","format":"ipv4"},{"type":"string","format":"ipv6"}]},"port":{"type":"integer"},"protocol":{"type":"string","description":"Protocol (e.g., TCP, UDP, etc.)"},"tls_mode":{"type":"string","default":"no_tls","enum":["no_tls","tls_no_verify","tls"]},"certificate":{"type":"object","properties":{"chain_data":{"type":"array","items":{"cn":"string","exp_date":"string"}},"cert_body":{"type":"string","description":"Certificate body"}},"required":["cert_body"]}},"required":["host","port","protocol"],"additionalProperties":false}},"required":["id","name","format","connection","server_groups"],"additionalProperties":false},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```

## Revert Log Exporters to the specified version

> Set a previous Log Exporters version to be the current one

```json
{"openapi":"3.0.2","info":{"title":"Link11 WAAP","version":"v4.3"},"paths":{"/api/v4.3/conf/{config}/log-exporters/versions/{version}/revert":{"put":{"description":"Set a previous Log Exporters version to be the current one","operationId":"document_revert_resource_put_api_v3_configs__config__d__document__v__version__revert__put_2219093287643266132","parameters":[{"in":"path","name":"config","required":true,"schema":{"title":"Config","type":"string"}},{"in":"path","name":"version","required":true,"schema":{"title":"Version","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUpdate"}}},"description":"Log Exporters reversion was successful"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Revert Log Exporters to the specified version","tags":["Log Exporters"]}}},"components":{"schemas":{"ResponseUpdate":{"title":"ResponseUpdate","type":"object","properties":{"message":{"title":"Message","description":"Information about successful update operation","type":"string"}},"required":["message"]},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}}
```