---
title: External HTTP Access Log Publisher
description: External HTTP Access Log Publishers publish HTTP access messages to an external handler.
component: pingds
version: 8.1
page_id: pingds:configref:objects-external-http-access-log-publisher
canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-external-http-access-log-publisher.html
section_ids:
  parent: Parent
  external_http_access_log_publisher_properties: External HTTP Access Log Publisher properties
  basic_properties: Basic properties
  config-file: config-file
  enabled: enabled
  log-field-blacklist: log-field-blacklist
  log-field-whitelist: log-field-whitelist
  advanced_properties: Advanced properties
  java-class: java-class
---

# External HTTP Access Log Publisher

External HTTP Access Log Publishers publish HTTP access messages to an external handler.

## Parent

The External HTTP Access Log Publisher object inherits from [HTTP Access Log Publisher](objects-http-access-log-publisher.html).

## External HTTP Access Log Publisher properties

You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html).

| Basic Properties                                                                                                                        | Advanced Properties       |
| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
| [config-file](#config-file) [enabled](#enabled) [log-field-blacklist](#log-field-blacklist) [log-field-whitelist](#log-field-whitelist) | [java-class](#java-class) |

### Basic properties

Use the `--advanced` option to access advanced properties.

### config-file

|                         |                                                                                                                                                                                                                                                   |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | The JSON configuration file that defines the External HTTP Access Log Publisher. The content of the JSON configuration file depends on the type of external audit event handler. The path to the file is relative to the instance directory path. |
| *Default value*         | None                                                                                                                                                                                                                                              |
| *Allowed values*        | A path to an existing file that is readable (and/or writeable) by the server.                                                                                                                                                                     |
| *Multi-valued*          | No                                                                                                                                                                                                                                                |
| *Required*              | Yes                                                                                                                                                                                                                                               |
| *Admin action required* | The object must be disabled and re-enabled for changes to take effect.                                                                                                                                                                            |
| *Advanced*              | No                                                                                                                                                                                                                                                |
| *Read-only*             | No                                                                                                                                                                                                                                                |

### enabled

|                         |                                                         |
| ----------------------- | ------------------------------------------------------- |
| *Synopsis*              | Indicates whether the Log Publisher is enabled for use. |
| *Default value*         | None                                                    |
| *Allowed values*        | truefalse                                               |
| *Multi-valued*          | No                                                      |
| *Required*              | Yes                                                     |
| *Admin action required* | None                                                    |
| *Advanced*              | No                                                      |
| *Read-only*             | No                                                      |

### log-field-blacklist

|                         |                                                                                   |
| ----------------------- | --------------------------------------------------------------------------------- |
| *Synopsis*              | List of fields that the server omits from access log messages.                    |
| *Description*           | Valid values for this property are JSON paths for fields present in the log file. |
| *Default value*         | No message elements are blacklisted by default                                    |
| *Allowed values*        | A JSON path to an existing object of the access event definition.                 |
| *Multi-valued*          | Yes                                                                               |
| *Required*              | No                                                                                |
| *Admin action required* | None                                                                              |
| *Advanced*              | No                                                                                |
| *Read-only*             | No                                                                                |

### log-field-whitelist

|                         |                                                                                   |
| ----------------------- | --------------------------------------------------------------------------------- |
| *Synopsis*              | List of fields that the server includes in access log messages.                   |
| *Description*           | Valid values for this property are JSON paths for fields present in the log file. |
| *Default value*         | Fields not containing sensitive information are whitelisted by default.           |
| *Allowed values*        | A JSON path to an existing object of the access event definition.                 |
| *Multi-valued*          | Yes                                                                               |
| *Required*              | No                                                                                |
| *Admin action required* | None                                                                              |
| *Advanced*              | No                                                                                |
| *Read-only*             | No                                                                                |

## Advanced properties

Use the `--advanced` option to access advanced properties.

### java-class

|                         |                                                                                                                 |
| ----------------------- | --------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | The fully-qualified name of the Java class that provides the External HTTP Access Log Publisher implementation. |
| *Default value*         | org.opends.server.loggers.CommonAuditHTTPAccessLogPublisher                                                     |
| *Allowed values*        | A Java class that extends or implements:- org.opends.server.loggers.LogPublisher                                |
| *Multi-valued*          | No                                                                                                              |
| *Required*              | Yes                                                                                                             |
| *Admin action required* | None                                                                                                            |
| *Advanced*              | Yes                                                                                                             |
| *Read-only*             | No                                                                                                              |