Capability

Cloud

Liferay Cloud Platform provides the infrastructure and tooling necessary to simplify, secure, and deliver applications on Liferay DXP when using the SaaS or PaaS deployment approaches. Using Liferay’s Cloud infrastructure provides a secure, reliable, and scalable platform for building Liferay solutions.

The Liferay Cloud Platform includes DevOps CI/CD tools, automated backups, real-time logs, and much more.

Feature
Deployment Approach
Capability
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...
Published Date: May 9, 2024 6:50 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 27, 2025 3:40 PM
Managing Object Entries Using GraphQL
Official Documentation
Managing Object Entries Using GraphQL You can use GraphQL to manage custom object entries in Liferay efficiently. This API framework simplifies data interaction and serves as an alternative to REST...
Published Date: Nov 22, 2024 10:50 PM
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...
Published Date: May 9, 2024 6:50 PM
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,...
Published Date: Jul 11, 2024 3:36 PM
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...
Published Date: Jun 28, 2025 6:30 PM
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...
Published Date: May 9, 2024 6:52 PM
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.
Published Date: Aug 15, 2025 9:05 PM
Using Aggregation Terms with REST APIs
Official Documentation
Using Aggregation Terms with REST APIs When querying Object entries using REST APIs, you can use an Object's fields as facet criteria for aggregating entry data. To do this, add the...
Published Date: May 9, 2024 6:54 PM
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...
Published Date: Jan 30, 2025 12:26 PM
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...
Published Date: May 9, 2024 6:52 PM
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...
Published Date: May 9, 2024 6:54 PM
Object API Basics
Official Documentation
Object API Basics When you publish an Object, Liferay automatically generates REST APIs for it. These APIs differ for Company and Site scoped Objects, but they all use the c/[pluralobjectlabel]...
Published Date: May 9, 2024 6:54 PM
Using Batch APIs
Official Documentation
Using Batch APIs When you publish an Object, Liferay automatically generates REST APIs for it. These include the batch APIs for bulk POST, PUT, and DELETE operations. Here you'll use cURL commands...
Published Date: May 9, 2024 6:54 PM
Using Object APIs With Base64 Encoded Files
Official Documentation
Using Object APIs With Base64 Encoded Files Liferay DXP 2024.Q2+/Portal GA120+ When creating object entries with attachment fields through APIs, you can generally upload files from your computer...
Published Date: Jun 7, 2024 3:58 PM
Using Relationship REST APIs
Official Documentation
Using Relationship REST APIs Liferay 7.4 U70+/GA70+ When you add relationships to custom or system objects, Liferay generates REST endpoints for accessing those relationships. You can relate and...
Published Date: May 9, 2024 6:54 PM
Using nestedFields to Query Related Entries
Official Documentation
Using nestedFields to Query Related Entries Liferay 7.4 U69+/GA69+ The nestedFields parameter returns multiple levels of related object entries in a single GET request. Pass the nestedFields...
Published Date: May 9, 2024 6:54 PM
Using nestedFields to Audit Entry History
Official Documentation
Using nestedFields to Audit Entry History Liferay 7.4 U72+/GA72+ When you enable entry history for an object definition, you can use the nestedFields parameter with REST APIs to audit entry...
Published Date: May 9, 2024 6:54 PM
Picklists API Basics
Official Documentation
Picklists API Basics Liferay provides the headless-admin-list-types REST APIs for creating and managing picklist definitions (ListTypeDefinition) and their entries (ListTypeEntry). You can view and...
Published Date: May 9, 2024 6:54 PM
Workflow Definition Link API Basics
Official Documentation
Workflow Definition Link API Basics Liferay DXP 2025.Q1+/Portal GA132+ You can manage workflow definition links from the Liferay UI or using Liferay's REST APIs. In Liferay, the Control Panel →...
Published Date: Feb 19, 2025 12:28 PM
Notifications API Basics
Official Documentation
Notifications API Basics Liferay's headless delivery application provides REST and GraphQL services for subscribing to or unsubscribing from notifications for platform events across several default...
Published Date: Oct 4, 2024 4:10 PM
Search APIs
Official Documentation
Search APIs You can search with headless APIs using the endpoints at /o/search. Search Headless APIs Availability The first search headless endpoint, /portal-search-rest, was released behind a...
Published Date: May 9, 2024 6:59 PM
Process Automation APIs
Process Automation APIs You can use headless APIs to interface with automation features in Liferay DXP, including workflows. Here are resources to help you understand and integrate these APIs to...
Published Date: Jun 28, 2025 6:30 PM
Search API Basics
Official Documentation
Search API Basics [Release Feature](../../../security-and-administration/administration/configuring-liferay/feature-flags.md#release-feature-flags) 7.4 U88+ and GA88+ You can search for content...
Published Date: Sep 7, 2024 3:46 PM
Search Suggestions API
Official Documentation
Search Suggestions API DXP 7.4 U36+/Portal GA36+ You can return suggestions with the using the /suggestions headless API. This API is used by Liferay's Search Bar Suggestions feature. There are...
Published Date: Sep 7, 2024 3:46 PM
User Management APIs
Official Documentation
User Management APIs You can use headless APIs to interface with important Liferay user management features, including user accounts, organizations, and roles. Here are resources to help you...
Published Date: May 9, 2024 6:59 PM
Account Groups API Basics
Official Documentation
Account Groups API Basics Liferay DXP/Portal 7.4+ You can manage account groups from the Applications menu or use Liferay's REST APIs. Call these services to create and manage account groups. ...
Published Date: Feb 13, 2025 12:50 PM
Site APIs
Official Documentation
Site APIs Use Liferay’s REST APIs to manage site elements programmatically. This guide introduces the Navigation Menu API and shows how to create, retrieve, update, and delete navigation menus...
Published Date: May 9, 2024 6:58 PM
Accounts API Basics
Official Documentation
Accounts API Basics Liferay DXP/Portal 7.4+ You can manage accounts from the Applications menu or use Liferay's REST APIs. Call these services to create and manage accounts. Adding an Account ...
Published Date: Feb 12, 2025 1:01 PM
Navigation Menu API Basics
Official Documentation
Navigation Menu API Basics Liferay's REST APIs provide services for Liferay's navigation menus. You can create and edit navigation menus with the API. Start by seeing an example of adding a new...
Published Date: May 9, 2024 6:58 PM
Countries API Basics
Official Documentation
Countries API Basics Liferay 7.4 U24+ and GA24+ Use Liferay's Rest APIs to create and manage countries. Adding a Country Then, follow these steps: Download and unzip Countries API Basics. ...
Published Date: May 9, 2024 6:59 PM
Account Users and Roles APIs
Official Documentation
Account Users and Roles APIs You can manage Account Users and Account Roles from the Applications menu, but you can also use Liferay's REST APIs. Call these services to create and manage account...
Published Date: May 9, 2024 6:59 PM
Adding the UAD Framework
Official Documentation
Adding the UAD Framework You can manage and delete user data with Liferay's User Associated Data (UAD) management tool. The tool is available out-of-the-box for many of Liferay's applications (e.g....
Published Date: May 9, 2024 6:59 PM
Organizations API Basics
Official Documentation
Organizations API Basics You can Create and Manage Organizations from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage organizations. Adding an...
Published Date: May 9, 2024 6:59 PM
User Groups API Basics
Official Documentation
User Groups API Basics You can Create and Manage User Groups from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage user groups. Adding a User Group ...
Published Date: May 9, 2024 6:59 PM
Using Liferay as a Headless Platform
Using Liferay as a Headless Platform Liferay provides a suite of APIs that perform the same kinds of actions available in the web interface. This is essential when you must get data in a...
Published Date: May 9, 2024 6:51 PM
API Headers Reference
Official Documentation
API Headers Reference API headers are components of HTTP requests that provide essential information to the server about the client's request and how the server should handle it. You can use API...
Published Date: May 9, 2024 6:51 PM
User Account API Basics
Official Documentation
User Account API Basics You can add and manage users from the Control Panel, but you can also use Liferay's REST APIs. You can call these services to add, edit, delete users. Start with adding a...
Published Date: Nov 22, 2024 10:53 PM
Regions API Basics
Official Documentation
Regions API Basics Liferay 7.4 U24+ and GA24+ Use Liferay's REST APIs to create and manage regions. Adding a Region Then, follow these steps: Download and unzip Regions API Basics. curl...
Published Date: May 9, 2024 6:59 PM
Postal Address API Basics
Official Documentation
Postal Address API Basics Liferay DXP/Portal 7.4+ Use Liferay's REST APIs to manage postal addresses. Add Postal Address to Account Then, follow these steps: Download and unzip Postal Address...
Published Date: May 9, 2024 6:59 PM
Roles API Basics
Official Documentation
Roles API Basics You can create and manage roles from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage roles. Associate a User to a Regular Role Then,...
Published Date: May 9, 2024 6:59 PM
Consuming APIs
Official Documentation
Consuming APIs APIs, or Application Programming Interfaces, serve as the bridge between different software applications, allowing them to communicate and exchange data. By consuming external APIs,...
Published Date: May 9, 2024 6:51 PM
API Query Parameters
Official Documentation
API Query Parameters Whether you consume REST APIs or GraphQL APIs, different query parameters are available to help you filter the responses. Fields Parameter Use this parameter to specify and...
Published Date: May 9, 2024 6:51 PM
Batch Engine API Basics - Importing Data
Official Documentation
Batch Engine API Basics - Importing Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to import data to Liferay. Importing Data Then follow...
Published Date: May 9, 2024 6:51 PM
Batch Engine API Basics - Exporting Data
Official Documentation
Batch Engine API Basics - Exporting Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to export data from Liferay. Exporting Data Then,...
Published Date: May 9, 2024 6:51 PM
Consuming GraphQL APIs
Official Documentation
Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. The GraphQL APIs are available at http://[host]:[port]/o/graphql. Here's how to consume them in three steps: ...
Published Date: May 9, 2024 6:51 PM
Configuring JSON Web Services
Official Documentation
Configuring JSON Web Services Liferay’s services are exposed as JSON web services out-of-the-box. This is enabled by default. You can access these services via the API page at...
Published Date: Nov 16, 2024 3:32 PM
Data Migration Center
Official Documentation
Data Migration Center Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) Currently,...
Published Date: May 9, 2024 6:51 PM
Using External Reference Codes
Official Documentation
Using External Reference Codes Liferay DXP/Portal 7.4+ Many of Liferay's headless API endpoints support an external reference code (ERC). The ERC field is useful in wide range of scenarios. For...
Published Date: May 9, 2024 6:51 PM
Sample API Tutorials
Official Documentation
Sample API Tutorials Follow the links below for sample API tutorials that include example requests and example code. Building Applications (Objects) Custom Objects API Basics Custom Objects...
Published Date: May 9, 2024 6:51 PM
Making Unauthenticated Requests
Official Documentation
Making Unauthenticated Requests By default, Liferay DXP restricts API access for the sake of security, requiring authentication to get a valid response. However, in certain cases it may make sense...
Published Date: May 9, 2024 6:51 PM
Consuming REST Services
Official Documentation
Consuming REST Services Liferay DXP contains REST services for most of its applications. These services are fully OpenAPI compliant. Here, learn how to consume them. This takes only three steps: ...
Published Date: May 9, 2024 6:51 PM
JSON Web Tokens (JWTs)
Official Documentation
JSON Web Tokens (JWTs) JSON Web Tokens (JWTs) represent encoded data. They are compact, self-contained, and secure. There are two primary types of JSON Web Tokens: Encrypted JWT: ensures the...
Published Date: Feb 25, 2025 12:39 PM
Authorizing Account Access with OAuth2
Official Documentation
Authorizing Account Access with OAuth2 Once you have an application registered, you can start authorizing users. To do that, you must construct the URL to the authorization server (Liferay DXP)....
Published Date: Nov 22, 2024 10:48 PM
Producing and Implementing APIs with REST Builder
Official Documentation
Producing and Implementing APIs with REST Builder With REST Builder, you can define the API you want to build, and REST Builder provides the framework and endpoints for you. Deploy an Example REST...
Published Date: May 9, 2024 6:51 PM
Configuring the JWT Bearer Flow
Official Documentation
Configuring the JWT Bearer Flow To use JWT Bearer as a grant type in Liferay, you must create an OAuth 2 client with the Client Authentication Method set to Client Secret Basic or Post. The client...
Published Date: Feb 25, 2025 12:39 PM
OAuth 2 Scopes
Official Documentation
OAuth 2 Scopes In OAuth 2.0, applications are granted access to limited subsets of user data. These are called scopes (not to be confused with Liferay scopes). You can create them in two ways: ...
Published Date: Nov 22, 2024 10:48 PM
Using OAuth2 to Authorize Users
Official Documentation
Using OAuth2 to Authorize Users You can create applications that access Liferay's headless REST APIs using the OAuth 2.0 authorization protocol. The provided sample React app demonstrates three...
Published Date: Nov 22, 2024 10:48 PM
JSON Web Token Assertions
Official Documentation
JSON Web Token Assertions An assertion helps in sharing identity and security information across different domains. There are two uses for assertions: Authorization grants Client authentication...
Published Date: Feb 25, 2025 12:39 PM