Visit Azul.com
Support
Search
Toggle navigation
Azul Payara Community Documentation
General Info
Documentation Overview
Getting Started
Supported Platforms
Build Instructions
Contributing to Payara
Technical Documentation
Payara Server Documentation
Payara Server Documentation
General Administration
Overview of Payara Server Administration
General Runtime Administration
Using REST Interfaces to Administer Payara Server
Administering Domains
Administering the Virtual Machine for the Java Platform
Administration Console Features
Administering Thread Pools
Administering the Logging Service
Administering the Monitoring Service
Administering the Healthcheck Service
Administering the Request Tracing Service
Administering the Notification Service
Administering Batch Jobs
Administering Database Connectivity
Administering EIS Connectivity
Administering HTTP Connectivity
Administering Concurrent Resources
Administering the Object Request Broker (ORB)
Administering the Jakarta Mail Service
Administering the Java Message Service (JMS)
Administering the Java Naming and Directory Interface (JNDI) Service
Administering Transactions
Administering Web Applications
Configuration Variables Reference
Subcommands for the
asadmin
Utility
Mbeans Inventory
Deployment Planning
Overview of Payara Server Deployment Planning
Product Concepts
Planning Your Deployment
Deployment Checklist
Application Deployment
Overview of Payara Server Application Deployment
Deploying Applications
The
asadmin
Deployment Subcommands
Azul Payara Deployment Descriptor Files
Elements of the Azul Payara Deployment Descriptors
High Availability
High Availability in Payara Server
Enabling Centralized Administration of Payara Server Instances
Administering Payara Server Nodes
Administering Payara Server Clusters
Administering Deployment Groups
Administering the Domain Data Grid
Administering Payara Server Instances
Administering Named Configurations
Configuring HTTP Load Balancing
Configuring High Availability Session Persistence and Failover
Configuring Java Message Service High Availability
RMI-IIOP Load Balancing and Failover
Security Guide
Overview
Administering System Security
Administering User Security
Administering Message Security
Administering Security in a High-Availability Environment
Managing Administrative Security
Running in a Secure Environment
SSL Certificate Management
Printing Certificate Data
Command Reference
Overview
Domain
Instance
Configuration
Dotted Names
Deployment Group
Applications
Auto-Naming
Logging
Security
Add-Instance-To-Deployment-Group
Add-Library
Add-Resources
Appclient
Asadmin-Recorder-Enabled
Asadmin
Attach
Backup-Domain
Capture-Schema
Change-Admin-Password
Change-Master-Broker
Change-Master-Password
Clean-Jbatch-Repository
Clear-Cache
Collect-Log-Files
Configure-Jms-Cluster
Configure-Ldap-For-Admin
Configure-Managed-Jobs
Copy-Config
Create-Admin-Object
Create-Application-Ref
Create-Auth-Realm
Create-Cluster
Create-Connector-Connection-Pool
Create-Connector-Resource
Create-Connector-Security-Map
Create-Connector-Work-Security-Map
Create-Context-Service
Create-Custom-Resource
Create-Deployment-Group
Create-Domain
Create-File-User
Create-Http-Listener
Create-Http-Redirect
Create-Http
Create-Iiop-Listener
Create-Instance
Create-Jacc-Provider
Create-Javamail-Resource
Create-Jdbc-Connection-Pool
Create-Jdbc-Resource
Create-Jms-Host
Create-Jms-Resource
Create-Jmsdest
Create-Jndi-Resource
Create-Jvm-Options
Create-Jvm-Options
Create-Local-Instance
Create-Managed-Executor-Service
Create-Managed-Scheduled-Executor-Service
Create-Managed-Thread-Factory
Create-Message-Security-Provider
Create-Module-Config
Create-Network-Listener
Create-Node-Config
Create-Node-Docker
Create-Node-Ssh
Create-Password-Alias
Create-Protocol-Filter
Create-Protocol-Finder
Create-Protocol
Create-Resource-Adapter-Config
Create-Resource-Ref
Create-Service
Create-Ssl
Create-System-Properties
Create-System-Properties
Create-Threadpool
Create-Transport
Create-Virtual-Server
Debug-Asadmin
Delete-Admin-Object
Delete-Application-Ref
Delete-Auth-Realm
Delete-Cluster
Delete-Config-Property
Delete-Config
Delete-Connector-Connection-Pool
Delete-Connector-Resource
Delete-Connector-Security-Map
Delete-Connector-Work-Security-Map
Delete-Context-Service
Delete-Custom-Resource
Delete-Deployment-Group
Delete-Domain
Delete-File-User
Delete-Http-Listener
Delete-Http-Redirect
Delete-Http
Delete-Iiop-Listener
Delete-Instance
Delete-Jacc-Provider
Delete-Javamail-Resource
Delete-Jdbc-Connection-Pool
Delete-Jdbc-Resource
Delete-Jms-Host
Delete-Jms-Resource
Delete-Jmsdest
Delete-Jndi-Resource
Delete-Jvm-Options
Delete-Local-Instance
Delete-Managed-Executor-Service
Delete-Managed-Scheduled-Executor-Service
Delete-Managed-Thread-Factory
Delete-Message-Security-Provider
Delete-Module-Config
Delete-Network-Listener
Delete-Node-Config
Delete-Node-Docker
Delete-Node-Ssh
Delete-Password-Alias
Delete-Protocol-Filter
Delete-Protocol-Finder
Delete-Protocol
Delete-Resource-Adapter-Config
Delete-Resource-Ref
_Delete-Service
Delete-Ssl
Delete-System-Property
Delete-Threadpool
Delete-Transport
Delete-Virtual-Server
Deploy-Remote-Archive
Deploy
Disable-Asadmin-Recorder
Disable-Monitoring
Disable-Phone-Home
Disable-Secure-Admin-Internal-User
Disable-Secure-Admin-Principal
Disable-Secure-Admin
Disable
Enable-Asadmin-Recorder
Enable-Monitoring
Enable-Phone-Home
Enable-Secure-Admin-Internal-User
Enable-Secure-Admin-Principal
Enable-Secure-Admin
Enable
Export-Sync-Bundle
Export
Flush-Connection-Pool
Flush-Jmsdest
Freeze-Transaction-Service
Generate-Bash-Autocomplete
Generate-Encryption-Key
Generate-Jvm-Report
Get-Active-Module-Config
Get-Admin-Audit-Configuration
Get-Asadmin-Recorder-Configuration
Get-Aws-Config-Source-Configuration
Get-Azure-Config-Source-Configuration
Get-Cdieventbus-Notifier-Configuration
Get-Client-Stubs
Get-Config-Dir
Get-Config-Ordinal
Get-Config-Property
Get-Dynamodb-Config-Source-Configuration
Get-Ejb-Invoker-Configuration
Get-Environment-Warning-Configuration
Get-Eventbus-Notifier-Configuration
Get-Fault-Tolerance-Configuration
Get-Gcp-Config-Source-Configuration
Get-Hashicorp-Config-Source-Configuration
Get-Hazelcast-Configuration
Get-Health
Get-Healthcheck-Configuration
Get-Jdbc-Config-Source-Configuration
Get-Jms-Notifier-Configuration
Get-Jmx-Monitoring-Configuration
Get-Ldap-Config-Source-Configuration
Get-Log-Notifier-Configuration
Get-Metrics-Configuration
Get-Microprofile-Healthcheck-Configuration
Get-Monitoring-Level
Get-Monitoring-Service-Configuration
Get-Notification-Configuration
Get-Openapi-Configuration
Get-Requesttracing-Configuration
Get-Toml-Config-Source-Configuration
Get
Import-Sync-Bundle
Install-Node-Ssh
Install-Node
Jms-Ping
List-Admin-Objects
List-Application-Refs
List-Applications
List-Auth-Realms
List-Backups
List-Batch-Job-Executions
List-Batch-Job-Steps
List-Batch-Jobs
List-Batch-Runtime-Configuration
List-Cache-Keys
List-Caches
List-Clusters
List-Commands
List-Configs
List-Connector-Connection-Pools
List-Connector-Resources
List-Connector-Security-Maps
List-Connector-Work-Security-Maps
List-Containers
List-Context-Services
List-Custom-Resources
List-Deployment-Groups
List-Domains
List-File-Groups
List-File-Users
List-Hazelcast-Cluster-Members
List-Hazelcast-Members
List-Healthcheck-Services
List-Http-Listeners
List-Iiop-Listeners
List-Instances
List-Jacc-Providers
List-Javamail-Resources
List-Jdbc-Connection-Pools
List-Jdbc-Resources
List-Jms-Hosts
List-Jms-Resources
List-Jmsdest
List-Jndi-Entries
List-Jndi-Resources
List-Jobs
List-Jvm-Options
List-Libraries
List-Log-Attributes
List-Log-Levels
List-Loggers
List-Managed-Executor-Services
List-Managed-Scheduled-Executor-Services
List-Managed-Thread-Factories
List-Message-Security-Providers
List-Modules
List-Network-Listeners
List-Nodes-Config
List-Nodes-Ssh
List-Nodes
List-Notifiers
List-Password-Aliases
List-Persistence-Types
List-Phone-Home
List-Protocol-Filters
List-Protocol-Finders
List-Protocols
List-Requesttraces
List-Resource-Adapter-Configs
List-Resource-Refs
List-Rest-Endpoints
List-Secure-Admin-Internal-Users
List-Secure-Admin-Principals
List-Sub-Components
List-Supported-Cipher-Suites
List-System-Properties
List-Threadpools
List-Timers
List-Transports
List-Virtual-Servers
List-Web-Context-Param
List-Web-Env-Entry
List
Login
Migrate-Timers
Monitor
Monitoring
Multimode
Notification-Configure
Osgi-Shell
Osgi
Package-Appclient
Ping-Connection-Pool
Ping-Node-Ssh
Print-Certificate
Purge-Jbatch-Repository
Recover-Transactions
Redeploy
Remove-Instance-From-Deployment-Group
Remove-Library
Resource
Restart-Cluster
Restart-Deployment-Group
Restart-Domain
Restart-Domains
Restart-Hazelcast
Restart-Http-Listeners
Restart-Instance
Restart-Local-Instance
Restart-Monitoring
Restore-Domain
Rollback-Transaction
Rotate-Log
Set-Admin-Audit-Configuration
Set-Amx-Enabled
Set-Asadmin-Recorder-Configuration
Set-Aws-Config-Source-Configuration
Set-Azure-Config-Source-Configuration
Set-Batch-Runtime-Configuration
Set-Cdieventbus-Notifier-Configuration
Set-Config-Cache
Set-Config-Dir
Set-Config-Ordinal
Set-Config-Property
Set-Dynamodb-Config-Source-Configuration
Set-Ejb-Invoker-Configuration
Set-Environment-Warning-Configuration
Set-Eventbus-Notifier-Configuration
Set-Fault-Tolerance-Configuration
Set-Gcp-Config-Source-Configuration
Set-Hashicorp-Config-Source-Configuration
Set-Hazelcast-Configuration
Set-Healthcheck-Configuration
Set-Healthcheck-Service-Configuration
Set-Jdbc-Config-Source-Configuration
Set-Jms-Notifier-Configuration
Set-Jmx-Monitoring-Configuration
Set-Ldap-Config-Source-Configuration
Set-Log-Attributes
Set-Log-File-Format
Set-Log-Levels
Set-Log-Notifier-Configuration
Set-Metrics-Configuration
Set-Microprofile-Healthcheck-Configuration
Set-Monitoring-Level
Set-Monitoring-Service-Configuration
Set-Network-Listener-Configuration
Set-Notification-Configuration
Set-Openapi-Configuration
Set-Requesttracing-Configuration
Set-Toml-Config-Source-Configuration
Set-Web-Context-Param
Set-Web-Env-Entry
Set
Setup-Ssh
Show-Component-Status
Start-Cluster
Start-Database
Start-Deployment-Group
Start-Domain
Start-Domains
Start-Instance
Start-Local-Instance
Stop-All-Domains
Stop-Cluster
Stop-Database
Stop-Deployment-Group
Stop-Domain
Stop-Domains
Stop-Instance
Stop-Local-Instance
Undeploy
Unfreeze-Transaction-Service
Uninstall-Node-Ssh
Uninstall-Node
Unset-Web-Context-Param
Unset-Web-Env-Entry
Unset
Update-Connector-Security-Map
Update-Connector-Work-Security-Map
Update-File-User
Update-Node-Config
Update-Node-Docker
Update-Node-Ssh
Update-Password-Alias
Uptime
Validate-Multicast
Verify-Domain-Xml
Version
Extensions
Server Extensions
gRPC Support
Grpc
Installing Grpc Server Support Module
Using Grpc Support Module
Payara Server Docker Image Overview
Upgrade Guide
Upgrading Payara Server
Backup and Restore Upgrade Method
Domain and Node Directories Upgrade Method
Payara Micro Documentation
Payara Micro Documentation
Maven Support
Payara Micro Configuration and Management
Micro Management
Stopping and Starting Instances
Starting an Instance
Stopping an Instance
Configuring an Instance
Deploying Applications
Deploying Applications
Deploying Applications on Micro Programmatically
Jar Structure and Configuration
Payara Micro JAR Structure
Adding Third-Party Jars to a Micro Instance
Root Configuration Directory
Clustering
HTTP and HTTPS Auto-Binding
Command Line Options
Payara Micro Command Line Options
Disable Phone Home in Payara Micro
Asadmin Commands
Running Asadmin Commands Using Pre-Boot and Post-Boot Scripts
Sending Asadmin Commands to Payara Micro from a Domain Administration Server
Database Management
Logging JDBC Calls in Payara Micro
SQL Trace Listeners in Payara Micro
Slow SQL Logging in Payara Micro
Logging and Monitoring
Logging
Logging to a File
Configuring the Access Log
Request Tracing in Payara Micro
API
Jcache in Payara Micro
Payara Micro API
Payara Micro API
Running Asadmin Commands on Bootstrapped Instances Using the API
Extensions
JCA Support in Payara Micro
Persistent EJB Timers
Remote CDI Events in Payara Micro
Running Callable Objects on Bootstrapped Instances
Payara Micro Docker Image Overview
Payara Embedded Documentation
Overview
Payara Server Embedded Server Guide
Application Development
Overview
Class Loaders
Debugging Applications
Securing Applications
Developing CDI Components
Developing SOAP Web Services
Configuring the Java Persistence Provider
Developing Web Applications
Using Jakarta Faces Technology
Using Jakarta MVC
Using Jakarta Enterprise Beans Technology
Using Lite Remote EJB Technology
Developing Java Clients
Developing Connectors
Developing Osgi-Enabled Jakarta EE Applications
Using the JDBC API for Database Access
Using the Transaction Service
Using the Java Naming and Directory Interface
Using Jakarta Messaging
Using Jakarta Mail
Using the Data Grid in Your Applications
Using the Jcache API
Using Request Tracing in Applications
Tracing Apis Compatibility Matrix
Public API
Public API
Firing and Listening for Remote CDI Events
Clustered Singleton
OAuth2 Support
Openid Connect Support
Rolespermitted Support
Jakarta EE Security Extensions
MicroProfile
Eclipse Microprofile
Config
Eclipse Microprofile Config API
Cloud
Cloud Configuration Sources
AWS Cloud Config Source
Azure Cloud Config Source
Dynamodb Config Source
GCP Cloud Config Source
Hashicorp Secrets Config Source
Payara Server Maven Plugin
Payara Micro Maven Plugin
Directory Config Source
JDBC Config Source
LDAP Config Source
TOML Config Source
Eclipse Microprofile Fault Tolerance API
Eclipse Microprofile Health Check API
Eclipse Microprofile JWT Authentication API
Metrics
Metrics Configuration in Azul Payara
REST Endpoint
Custom Vendor Metrics
Eclipse Microprofile Openapi API
Opentelemetry and Opentracing Support
Eclipse Microprofile Opentracing
Eclipse Microprofile Rest Client API
Eclipse Microprofile Telemetry
Ecosystem
Azul Payara Ecosystem
Project Management Tools
Maven Bill of Materials Artifact
Maven Plugin
Payara Micro Maven Archetype
Payara Micro Gradle Plugin
Maven Regex Profile Activation Extension
Payara Starter Documentation
IDE Integration
Eclipse Plugin
Payara Eclipse IDE Plugin
Payara Server Tools in Eclipse IDE
Payara Micro Tools in Eclipse IDE
Building Payara Tools Eclipse IDE Plugin
Transform Maven Projects or Files from Java EE 8 to Jakarta EE 10
IntelliJ Plugin
Payara Intellij Tools
Payara Server Tools in Intellij IDEA
Payara Server Maven Plugin Tools in Intellij IDEA
Payara Micro Tools in Intellij IDEA
Building Payara Intellij Tools
Transform Maven Projects or Files from Java EE 8 to Jakarta EE 10
Apache NetBeans IDE
Azul Payara Apache Netbeans Tools
Payara Server Apache Netbeans IDE Support
Payara Micro Apache Netbeans IDE Support
Building Payara Tools Netbeans IDE Plugin
Transform Source Code to Jakarta EE 10
VSCode Extension
Payara VS Code Extension
Payara Server Tools in VS Code
Payara Micro Tools in VS Code
Building Payara Tools VS Code IDE Plugin
Transform Source Code to Jakarta EE 10
Hot Deploy and Auto Deploy
Connector Suites
Arquillian Containers
Arquillian Container Adapters
Payara Server Embedded Arquillian Container Adapter
Payara Server Managed Arquillian Container Adapter
Payara Server Remote Arquillian Container Adapter
Payara Micro Managed Arquillian Container Adapter
Cloud Connectors
Cloud Connectors
Amazon SQS
Amazon SQS Cloud Connector
Amazon SQS Versioning
Amazon Web Services SSO Integration
Amazon Web Services STS Integration
Programmatic SQS Queue Management
Apache Kafka Cloud Connector
Azure Service Bus Cloud Connector
MQTT Cloud Connector
Security Connectors
Upgrade Advisor Tool
Miscellaneous
JAX-RS Extension
Release Notes
Overview
Release Notes - Azul Payara Community 7.2026.6
Release Notes - Payara Platform Community 7.2026.5
Supported Apis and Applications
Release Notes - Payara Platform Community 7.2026.3
Release Notes - Payara Platform Community 7.2026.2
Release Notes - Payara Platform Community 7.2026.1
Release Notes - Payara Platform Community 7.2025.2
Release Notes - Payara Platform Community 7.2025.1
Jakarta EE Certification
Overview
7.2026.6
Platform TCK Results
7.2026.6 Web TCK Results
7.2026.5
Platform TCK Results
7.2026.5 Web TCK Results
7.2026.4
Platform TCK Results
7.2026.4 Web TCK Results
7.2026.3
Platform TCK Results
7.2026.3 Web TCK Results
7.2026.2
Platform TCK Results
7.2026.2 Web TCK Results
7.2026.1
Platform TCK Results
7.2026.1 Web TCK Results
7.2025.2
Platform TCK Results
7.2025.2 Web TCK Results
7.2025.1
Platform TCK Results
7.2025.1 Web TCK Results
7.2025.1.Beta1
Platform TCK Results
7.2025.1.Beta1 Web TCK Results
7.2024.1.Alpha3
Core TCK Results
Eclipse MicroProfile Certification
Overview
Security
Overview
Security Advisories
Appendix
Schemas
Overview
DTD for payara-resources.xml
DTD for payara-web.xml
DTD for payara-ejb-jar.xml
DTD for payara-application.xml
DTD for payara-application-client.xml
DTD for payara-acc.xml
Privacy Policy
Legal
Terms of Use
Overview of Payara Server Deployment Planning
Need help?
Schedule a consultation with an Azul performance expert.
Contact Us
This section explains how to build a production deployment of Payara Server.