Public API

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

See the Payara API Javadoc for the complete public Payara API reference.

Use Cases

The Public API should be used in the following scenarios:

Java EE Developers and end users that develop web and enterprise applications that require Payara specific features outside the specifications (and JCache).
Contributors that want to develop extensions for Payara Server or Payara Micro.

Maven Coordinates

The Public API is released as a Maven artifact in Payara Nexus, in the payara-artifacts repository. To use it in a Maven project, set the following dependencies in your project’s POM:

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>fish.payara.api</groupId>
            <artifactId>payara-bom</artifactId>
            <version>6.2024.11</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>fish.payara.api</groupId>
        <artifactId>payara-api</artifactId>
        <scope>provided</scope>
    </dependency>
</dependencies>

For information on the Payara BOM, please see Maven Bom.