A protocol is used by a network listener to determine the nature of the communication expected by the listener. For example, a protocol determines the timeout of a request, as well as whether HTTPS should be used. The reason the protocol is separate to the listener is so that the same protocol configuration can be used to listen on multiple ports.


Existing protocols can be configured from the admin console or with asadmin commands. The protocol configurations can be found in the admin console under Configurationsyour-configNetwork ConfigProtocols.

Configuration Page Location

The following fields can be configured for protocols:

Standard Options


Whether security is enabled for the protocol. When disabled, all the SSL options are ignored.

Asadmin Command:


HTTP Options

Server Name

The name of the server. This will be sent as the Server header in responses.

Asadmin Command:


Default Virtual Server

The default virtual server for the protocol. If multiple virtual servers are appropriate for a request, this determines the priority.

Asadmin Command:


Redirect Port

The port used for SSL redirects.

Asadmin Command:


Max Connections

The maximum number of requests per connection to keep in keep-alive mode.

Asadmin Command:



The amount of time in seconds before a connection is deemed as idle. After this, the connection will no longer be in keep-alive state.

Asadmin Command:


Upload Timeout Enabled

Enables closing a connection that is reading bytes slowly after the Connection Upload Timeout is reached.

Asadmin Command:


Connection Upload Timeout

The timeout, in milliseconds, for uploads. A value of -1 will disable it.

Asadmin Command:


Request Timeout

The timeout, in seconds, for requests. A value of -1 will disable it.

Asadmin Command:


Send Buffer Size

The size, in bytes, of the send buffer.

Asadmin Command:


Header Buffer Length

The size, in bytes, of the buffer used to read the request data.

Asadmin Command:


Max Post Size

The maximum size, in bytes, of POST actions.

Asadmin Command:


Max Form Post Size

The maximum size, in bytes, of a POST form.

Asadmin Command:


Max Save Post Size

The maximum size, in bytes, of a POST which will be saved during authentication.

Asadmin Command:


URI Encoding

The character set used to decode the request URIs received.

Asadmin Command:


HTTP/2 Enabled

Whether to enable HTTP/2 support for the protocol. Note that HTTP/2 can only be used on a secure listener.

Asadmin Command:


Disable HTTP/2 Cipher Check

Whether TLS connections can be established using insecure cipher suites.

Asadmin Command:


HTTP/2 Max Concurrent Streams

The number of concurrent streams allowed per HTTP/2 connection.

Asadmin Command:


HTTP/2 Initial Window Size

The initial window size in bytes.

Asadmin Command:


HTTP/2 Max Frame Payload Size

The maximum size of the HTTP/2 frame payload to be accepted.

Asadmin Command:


HTTP/2 Max Header List Size

The maximum size, in bytes, of the header list.

Asadmin Command:


Streams High Water Mark

Streams are periodically cleaned when the stream count exceeds this value, as a proportion of the max concurrent streams

Asadmin Command:


Streams Clean Percentage

The number of streams to process when the high water mark is exceeded. Only closed streams will be removed.

Asadmin Command:


Streams Clean Frequency Check

The number of streams that must be closed before checking if the number of streams exceeds the high water mark.

Asadmin Command:


HTTP/2 Push

Enables server push. This is enabled by default.

Asadmin Command:



Whether to enable HTTP/1.1 GZIP compression to save server bandwidth. Will be ignored when HTTP/2 is used.

Asadmin Command:


Compressible Mime Types

Comma separated list of MIME types for which HTTP compression is used.

Asadmin Command:


Compression Minimum Size

The minimum size of a file when compression is applied.

Asadmin Command:


No-Compression User Agents

Comma separated list of regular expressions matching user agents for which compression should not be used.

Asadmin Command:


Restricted User Agents

List of restricted user agents for which HTTP compression is applied.

Asadmin Command:


Default Response Type

The default response type if none are matched. Specified as a semi-colon delimited string consisting of content type, encoding, language, charset.

Asadmin Command:



The class name of the static resources adapter.

Asadmin Command:


Comet Support

Whether comet support is enabled or not.

Asadmin Command:


DNS Lookup

Enables Domain Name System lookups.

Asadmin Command:


Trace Enabled

Enables the TRACE operation. Setting this to false helps prevent cross-site scripting attacks.

Asadmin Command:


Auth Pass Through

Enable this if the network listener receives traffic from an SSL terminating proxy server.

Asadmin Command:


Chunking Enabled

Enables HTTP response chunking.

Asadmin Command:



Whether to include the X-Powered-By header in responses.

Asadmin Command:


XFrame Options

When enabled, the X-Frame-Options header will be set to SAMEORIGIN. This can still be overrided by a deployed application.

Asadmin Command:


Encoded Slash

Allow encoded slashes (e.g. %2F) in URIs.

Asadmin Command:


Websockets Support Enabled

Allows websockets to be used.

Asadmin Command:


Scheme Mapping

HTTP header name used for identifying the originating protocol of a HTTP request.

Asadmin Command:


Remote User Mapping

HTTP header name used for identifying the originating user of a HTTP request.

Asadmin Command:


SSL Options

SSLv3 Enabled

Whether to enable SSLv3 or not.

Asadmin Command:


TLS Enabled

Whether to enable TLS or not.

Asadmin Command:


TLS V1.1 Enabled

Whether to enable TLS V1.1 or not. Will be ignored if TLS is disabled.

Asadmin Command:


TLS V1.2 Enabled

Whether to enable TLS V1.2 or not. Will be ignored if TLS is disabled.

Asadmin Command:


TLS V1.3 Enabled

Whether to enable TLS V1.3 or not. Will be ignored if TLS is disabled.

Asadmin Command:


Support for TLS 1.3 is available with JDK 8 since 5.194, 5.191.10 and releases of Payara Platform but only when you are using Zulu JDK 1.8.0u222 or higher. If you using a lower version than 1.8.0u222, checkbox to enable TLS 1.3 will not be visible on the web administration console.
You will need to add the following Java Option: -Dfish.payara.clientHttpsProtocol=TLSv1.3 to the asadmin script for TLS 1.3 to work with asadmin CLI. This sets the TLS version to 1.3 which will be used by the asadmin client. If you are using JDK 8, you will also need to add the following Java Option: -XX:+UseOpenJSSE, this option makes OpenJSSE default TLS provider. OpenJSEE is a JSEE provider created by Azul to support TLS 1.3 on JDK 8. See TLS 1.3 Support in Zulu 8 with OpenJSSE for more information.

Client Authentication

When enabled, clients will be required to authenticate themselves to the server.

Asadmin Command:


Certificate Nickname

The alias of the certificate to be supplied on secure requests. The certificate should be present in the server keystore.

Asadmin Command:


Key Store

The name of the keystore file. A keystore stores the certificate to be sent by the server with responses.

Asadmin Command:


Trust Store

The name of the trust store file. The trust store stores trusted certificates.

Asadmin Command:


Trust Algorithm

The name of the trust management algorithm (e.g. PKIX) to use for certification path validation.

Asadmin Command:


Max Certificate Length

Maximum number of non self-issued intermediate certificates that can exist in a certification path. This is only valid if the trust algorithm is PKIX.

Asadmin Command:


Enabled Ciphers

A list of the server enabled ciphers. This string is stores as a comma separated list of the enabled ciphers with a + or a - at the start of each, depending on whether the cipher is enabled or disabled. E.g. +TLS_RSA_WITH_AES_256_CBC_SHA,+SSL_RSA_WITH_3DES_EDE_CBC_SHA.

Asadmin Command:


Handshake Timeout

The timeout, in millis, for a handshake. After this timeout the handshake will be aborted.

Asadmin Command:


TLS Rollback

Whether TLS rollback is enabled or not.

Asadmin Command: