Search Results

All Results 6974
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Order API Basics
Official Documentation
Order API Basics You can manage orders from the Applications menu or with REST APIs. Call the headless-admin-commerce-order services to create and manage orders. Adding an Order Once Liferay is...
Order Type API Basics
Official Documentation
Order Type API Basics You can manage order types from the Applications menu or with REST APIs. Use the /order-types endpoint from headless-admin-commerce-order to create and manage order types. ...
Pricing APIs
Official Documentation
Pricing APIs Use the Price List and Discount APIs to manage product pricing and discounts in Liferay Commerce programmatically. Below are basic usage examples, including common endpoints and...
Price List API Basics
Official Documentation
Price List API Basics You can manage price lists from the Applications menu or with REST APIs. Call the headless-admin-commerce-pricing services to create and manage price lists. Adding a Price...
Currency API Basics
Official Documentation
Currency API Basics Liferay DXP 2024.Q1+/Portal GA112+ You can manage currencies from the Applications menu or with REST APIs. Call the headless-commerce-admin-catalog services to create and...
Catalog API Basics
Official Documentation
Catalog API Basics You can manage catalogs from the Applications menu or REST APIs. Call the headless-commerce-admin-catalog services to create and manage catalogs. Adding a Catalog Once Liferay...
Product Management APIs
Official Documentation
Product Management APIs You can invoke the services under headless-commerce-admin-catalog to perform various admin operations related to products. However, if you have a headless storefront, you...
Asset Libraries API Basics
Official Documentation
Asset Libraries API Basics Liferay's REST APIs provide endpoints for creating, retrieving, updating, and deleting asset libraries. Starting with Liferay DXP 2025.Q4, these same endpoints also...
Categories and Vocabulary API Basics
Official Documentation
Categories and Vocabulary API Basics Liferay's REST APIs provide services for Liferay's categories and vocabularies functionality. You can create and edit vocabularies with the API. You can also...
Option API Basics
Official Documentation
Option API Basics You can manage option templates from the Applications menu or with REST APIs. Call the headless-commerce-admin-catalog services to create and manage options. Adding an Option ...
Product Delivery API Basics
Official Documentation
Product Delivery API Basics Product API Basics covers the admin API used for creating and managing products. To display product data in your storefront, you must use the Product Delivery API. Call...
Knowledge Base API Basics
Official Documentation
Knowledge Base API Basics You can Create Knowledge Base Articles and Manage the Knowledge Base with Liferay's Knowledge Base app, but you can also use Liferay's REST APIs. Call these services to...
Product API Basics
Official Documentation
Product API Basics You can manage products from the Applications menu, but you can also use Liferay’s REST APIs. Call these services to create and manage products. Adding a Product Then follow...
Content Management APIs
Content Management APIs You can use headless APIs to interface with most types of content in Liferay, including asset libraries, web content, message boards, and knowledge base articles. Here are...
Blog API Basics
Official Documentation
Blog API Basics Liferay's REST APIs provide services for adding, modifying, and deleting blog posts and images. Liferay DXP 2024.Q4+/Portal GA129+ The Blogs API now uses External Reference Codes...
Product API - Creating a Product with Multiple SKUs
Official Documentation
Product API - Creating a Product with Multiple SKUs You can create products with multiple active SKUs using the product API or from the Products application. To create such a product, you must...
Channel API Basics
Official Documentation
Channel API Basics You can manage channels from the Applications menu or with REST APIs. Call the headless-commerce-admin-channel services to create and manage channels. Adding a Channel Once...
Store Management Basics
Official Documentation
Store Management Basics Here is a comprehensive resource for understanding and leveraging Liferay’s Channel API basics.
Specification API Basics
Official Documentation
Specification API Basics You can manage product specifications from the Applications menu or with REST APIs. Call the headless-commerce-admin-catalog services to create and manage specifications. ...
Option Value API Basics
Official Documentation
Option Value API Basics You can manage option values from the Options application or with REST APIs. Call the headless-commerce-admin-catalog services to create and manage option values. Adding an...
Advanced Web Content API
Official Documentation
Advanced Web Content API Using the Liferay DXP REST services, you can create and manage your site's structured content. Structured content is web content that uses a web content structure (or...
Web Content API Basics
Official Documentation
Web Content API Basics Using Liferay DXP REST services, you can create and manage structured content on your site. Structured content refers to web content articles that use a web content structure...
Managing Web Content Structures and Templates by Using the REST API
Official Documentation
Managing Web Content Structures and Templates by Using the REST API Web content structures define the information included in a web content article. Structures facilitate creating and managing web...
Message Boards API Basics
Official Documentation
Message Boards API Basics Liferay's Headless Delivery application provides REST services for the Message Boards application. With these services, you can add message board categories, threads, and...
Tags API Basics
Official Documentation
Tags API Basics Liferay's REST APIs provide services for managing tags (referred to as keywords in Liferay's codebase). You can create, edit, and delete tags using the API. Start with an example of...
Web Content API
Official Documentation
Web Content API Here is a comprehensive resource for understanding and leveraging Liferay’s Web Content APIs. It supports the integration and management of web content within applications,...
Wiki API Basics
Official Documentation
Wiki API Basics Wiki is deprecated as of Liferay DXP 2024.Q4/Portal GA129. For data continuity, consider transitioning to alternative content management solutions like Liferay Objects or Web...
Liferay Security APIs
Liferay Security APIs You can use headless APIs to interface with important Liferay security features, including CAPTCHA configurations and SCIM. Here are resources to help you understand and...
Document Shortcut API Basics
Official Documentation
Document Shortcut API Basics Liferay's headless delivery application provides REST services for Documents and Media that add document shortcuts to sites or asset libraries, list their information,...
Web Content API Basics Using GraphQL
Official Documentation
Web Content API Basics Using GraphQL Use Liferay DXP GraphQL services to manage web content by creating, retrieving, updating, and deleting structured content on your site. Structured content...
Digital Asset Management APIs
Digital Asset Management APIs You can use headless APIs to interface with Liferay's documents and media. Here are resources to help you understand and integrate these APIs.
SCIM Group API Basics
Official Documentation
SCIM Group API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM groups to keep their information in sync with your company's...
Document Types and Metadata Sets API Basics
Official Documentation
Document Types and Metadata Sets API Basics Liferay DXP 2025.Q1+/Portal GA132+ Liferay's headless delivery application provides REST services for Documents and Media that add document types and...
Captcha API Basics
Official Documentation
Captcha API Basics Liferay provides a headless API to retrieve and submit captchas using the SimpleCAPTCHA engine. Using the /captcha endpoint from the API Explorer, you can add captchas in your...
Document API Basics
Official Documentation
Document API Basics Liferay's headless delivery application provides REST services for Documents and Media that add documents and folders, list their information, modify them, delete them, and...
SCIM User API Basics
Official Documentation
SCIM User API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM users to keep their identity information in sync with your company's...
Custom Object APIs
Official Documentation
Custom Object APIs Liferay 7.4+ When you publish a custom object definition, Liferay generates default REST APIs for interacting with the object and its data. These APIs vary depending on the...
SCIM Resource Type, Service Provider, and Schema Basics
Official Documentation
SCIM Resource Type, Service Provider, and Schema Basics Liferay DXP 2025.Q2+ Liferay provides a headless API to query the SCIM resource types, service providers, and schemas available. Use the...
Object APIs
Object APIs You can use headless APIs to interface with objects and picklists. Here are resources to help you understand and integrate these APIs to enhance your ability to manage objects.
Database Configuration
Database Configuration By default for demonstration purposes, Liferay DXP/Portal is configured to use an embedded HSQL database. Beyond demonstration purposes, we recommend using a full-featured,...
Portal Developer Properties
Official Documentation
Portal Developer Properties There are Portal Properties that facilitate development. Liferay's portal-developer.properties file includes all of them. The portal-developer.properties file is enabled...
Liferay Home
Liferay Home Liferay Home is the folder from which Liferay DXP/Portal launches applications, reads and applies configurations, loads JAR files, generates logs, and more. Liferay Home's location...
JVM Configuration
Official Documentation
JVM Configuration As of Liferay DXP 2024.Q3+/Portal GA125+, Liferay DXP/Portal requires a Java JDK 17 or 21 (prior versions support JDKs 8 and 11) with specific JVM option settings. There are also...
Portal Properties
Portal Properties Configuration options are specified using Portal Properties, sets of name/value pairs read from properties files and Docker environment variables on server startup. Default values...
Database Templates
Database Templates Below are templates (example portal properties and Docker environment variables) for configuring various databases as a built-in data source for Liferay DXP. MariaDB Portal...
Liferay Software Versions
Liferay Software Versions Starting with Liferay 7.4, Liferay adopted a rolling release model for delivering updates and fixes. This means Liferay 7.4 is a long living release with many releases for...
System Properties
System Properties Liferay DXP/Portal runs in the application server's JVM. System properties can be passed directly to the JVM as arguments to java in the format -D[name1]=[value1] or can be loaded...
Private Network
Official Documentation
Private Network Every environment has its own private network. This lets services from the same environment communicate through multiple secure communication protocols without having to interact...
VPN Integration Overview
Official Documentation
VPN Integration Overview Liferay Cloud provides a VPN client-to-site connection that has port forwarding and redundant tunnels support. This feature is commonly used to connect a subscriber's...
Configuring Liferay PaaS for Client Extensions
Configuring Liferay PaaS for Client Extensions Beta Feature Client extensions are the ideal way to deploy various customizations and changes to Liferay DXP in cloud environments. Here are some...
Using the Liferay DXP Service
Official Documentation
Using the Liferay DXP Service The Liferay service is the heartbeat of any project in Liferay Cloud (SaaS or PaaS). It runs the application's Liferay DXP instance and interacts with other services...
AI
Official Documentation
AI Liferay DXP integrates with external AI systems to enhance and accelerate your content creation and management processes. With easy-to-configure AI integrations, you can Accelerate content...
Configuring the Cloud Network
Official Documentation
Configuring the Cloud Network Every environment has its own private network, so services from the same environment can communicate through secure protocols without interacting with the public...
Connecting a VPN Server to Liferay Cloud
Official Documentation
Connecting a VPN Server to Liferay Cloud You can use Liferay Cloud's VPN feature to connect your Liferay Cloud services to external services on private networks, so you can operate an external...
Using Liferay as an MCP Server
Official Documentation
Using Liferay as an MCP Server Liferay DXP 2025.Q4+ [Beta Feature](../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) Using Liferay DXP as an...
Configuring a VPN Server
Official Documentation
Configuring a VPN Server The following scenario walks through how to set up an IPsec or OpenVPN VPN server. Once a VPN server is configured, a secure connection can be established between an...
Custom Domains
Official Documentation
Custom Domains With Liferay Cloud, you can connect custom domains to environment services with a DNS provider. First, register your custom domain with your environment's Load Balancer IP address....
Configuring the Liferay DXP Service
Official Documentation
Configuring the Liferay DXP Service There are several methods available to configure DXP in Liferay PaaS: through the in DXP System Settings and through the use of config and property files. DXP...
Deploying to the Liferay Service
Official Documentation
Deploying to the Liferay Service As with other services, deploying custom additions involves adding your configurations or files to the appropriate locations in your Git repository. However,...
Upgrading Your Liferay DXP Instance
Official Documentation
Upgrading Your Liferay DXP Instance Every three months, Liferay releases a new quarterly release version of Liferay DXP that includes security and bug fixes, as well as enhancements. To upgrade to...