Public API

Since Payara Server 4.1.1.171

This page contains information on using the Public API integrated within Payara Server Community and Payara Micro Community.

Open Payara API Javadoc for complete public Payara API reference.

Use Cases

This Public API should be used in the following scenarios:

  1. Java EE Developers and end users that develop web and enterprise applications that require Payara specific features outside the specifications (and JCache).

  2. Contributors that want to develop extensions to Payara Server or Payara Micro.

Maven Coordinates

The public API is released as a Maven artifact in Maven Central. To use it in a Maven project, set the following dependency in your project’s POM:

<dependency>
    <groupId>fish.payara.api</groupId>
    <artifactId>payara-api</artifactId>
    <version>${payara.version}</version>
    <scope>provided</scope>
</dependency>

Where ${payara.version} of the artifact corresponds with the oldest version of Payara Server your application should support.