Search Results

All Results 6986
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
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.
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...
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...
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...
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 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]...
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...
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...
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.
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...
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...
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...
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...
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...
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...
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...
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...
Backup Service
Official Documentation
Backup Service Maintaining regular backups is vital to protecting your project's data. The Liferay Cloud backup service stores iterations of environment data that can be used to restore your...
Database Service
Official Documentation
Database Service The database service is a proxy in Liferay Cloud to the Cloud SQL service in the Google Cloud Platform where the database itself resides. The database service provides tools for...
Creating a Database Dump
Creating a Database Dump Uploading a backup to Liferay Cloud's backup service requires a snapshot comprised of two compressed files, containing the document library and database dump, respectively....
Changing Your Database Password
Official Documentation
Changing Your Database Password Changing the database password for your database service also affects the other services that must connect to the database. Updating your database password...
Breaking Changes
Official Documentation
Breaking Changes Breaking changes in the Cloud platform are changes that break or alter existing functionality of the platform's console, services, or infrastructure. These changes can impact the...
Adding a New Environment
Official Documentation
Adding a New Environment Liferay Cloud projects are provisioned with multiple environments to fit the needs of most users. If your application requires an additional environment, you can request...
Command-Line Tool
Official Documentation
Command-Line Tool The CLI tool can be used to view and manage your Liferay Cloud services. Once installed, you can run lcp --help in your terminal to view available actions. You can run the -v or...
Configuration via LCP.json
Official Documentation
Configuration via LCP.json Each service in your Liferay Cloud environments has an LCP.json file that you can use to configure the service. You can configure properties like the service ID, memory,...
Default Provisioning for PaaS Environments
Official Documentation
Default Provisioning for PaaS Environments Liferay PaaS provides preconfigured infrastructure templates to meet the varying needs of development, testing, and production environments. Liferay Cloud...
Defining Environment Variables
Official Documentation
Defining Environment Variables Environment variables are a set of dynamic placeholders that can affect the way a service behaves within an environment. You can define environment variables via the...
Search Service (Elasticsearch)
Official Documentation
Search Service (Elasticsearch) The Elasticsearch service is the text search engine for your Liferay DXP application. It's a private service that only communicates with the other services in your...
Using a Custom Service
Official Documentation
Using a Custom Service In Liferay Cloud, you are not limited to the standard set of services provided out-of-the-box. You can also create and deploy a custom service to run any new processes within...
Web Server Service (Nginx)
Official Documentation
Web Server Service (Nginx) The Nginx web server functions as a gateway from the open internet to your Liferay Cloud services. It handles all traffic from your users and acts as a high-performance...
Reference
Official Documentation
Reference
Platform Services
Official Documentation
Platform Services In Liferay Cloud, the processes necessary to host and maintain a site are run by platform services. Each service corresponds to a part of what is necessary to keep your...
Downloading and Uploading Backups
Official Documentation
Downloading and Uploading Backups The Liferay Cloud backup service creates backups of an environment's database and the full contents of the Liferay instance's LIFERAY_HOME/data folder. This...
Continuous Integration
Official Documentation
Continuous Integration Liferay Cloud uses Jenkins to power its continuous integration infrastructure service. When you send a pull request or push a commit to one of your pre-configured GitHub...
Restoring Data from a Backup
Official Documentation
Restoring Data from a Backup During project development, there may be times when you must restore data or roll back the project to an earlier state. Restoring a backup to an environment restores...
Changing Your Database Username
Official Documentation
Changing Your Database Username The database username is defined by the lcp-secret-database-user secret and can be changed at any time. When this value is changed, a user with the new credentials...
Using the Database Client
Official Documentation
Using the Database Client Viewing data in the database is sometimes necessary to troubleshoot an issue with your application or for custom development. In order to access the database, you must use...
Example Configuration Files
Official Documentation
Example Configuration Files Different services in Liferay Cloud (such as the search and web server services) use configuration files to perform what you might be used to handling differently in an...
Liferay Cloud Data Center Locations
Official Documentation
Liferay Cloud Data Center Locations Liferay Cloud has a variety of available, regional data centers around the world to host customer environments. Liferay SaaS Data Centers These data centers are...
Liferay Cloud Infrastructure
Official Documentation
Liferay Cloud Infrastructure Liferay Cloud is a flexible platform that combines a collection of key components to provide a robust, reliable, and manageable Liferay DXP implementation. This diagram...
Liferay SaaS Compatibility Matrix
Official Documentation
Liferay SaaS Compatibility Matrix Liferay DXP is the heart of Liferay SaaS, but not every DXP feature applies to Liferay SaaS. Some DXP features are not compatible, and some must be achieved via...
Liferay Cloud Version 5 Changes
Official Documentation
Liferay Cloud Version 5 Changes Liferay Cloud version 5 comes with several changes and new features: ModSecurity Capabilities with Nginx Improved Regional Persistence Prepare and Swap Backup...
Platform Limitations
Official Documentation
Platform Limitations Liferay Cloud and its services have some notable limitations, depending on your subscription level. Limitations with Liferay Cloud's infrastructure may change over time. ...
Support and Troubleshooting
Official Documentation
Support and Troubleshooting Troubleshooting Troubleshooting Tools and Resources Reading Liferay Cloud Service Logs Shell Access Troubleshooting Services Disaster Recovery Overview ...
Liferay Cloud Maintenance and Release Schedule
Official Documentation
Liferay Cloud Maintenance and Release Schedule Liferay SaaS and PaaS both have a weekly maintenance and release schedule. Liferay Cloud uses a transparent and predictable release cadence so you can...
Liferay Cloud Support FAQs
Official Documentation
Liferay Cloud Support FAQs Here are the answers to common questions pertaining to Liferay Cloud Support. Why isn't Liferay Cloud open source? Liferay is an open-source company, with open-source...
Troubleshooting Tools and Resources
Official Documentation
Troubleshooting Tools and Resources When you have an issue with your site, you need tools to diagnose and resolve technical issues quickly. Liferay Cloud provides you with tools and resources for...
Configuring Cross-Region Disaster Recovery
Official Documentation
Configuring Cross-Region Disaster Recovery Liferay Cloud provides two ways for customers to take advantage of the Disaster Recovery (DR) procedure in the case of major incidents: Automatic Disaster...
Upgrading to a High Availability Subscription
Official Documentation
Upgrading to a High Availability Subscription In many cases, the standard subscription plan for Liferay Cloud is sufficient to ensure quality performance for a live project. As your needs change,...
Understanding Service Stack Versions
Official Documentation
Understanding Service Stack Versions The Liferay Cloud service stack represents the major version of all of the services in your Liferay Cloud environment. Each individual service may have a...
Liferay Cloud Support
Official Documentation
Liferay Cloud Support Liferay is committed to providing excellent service and customer experience. Liferay Cloud customers have several means to contact support, including opening a Support ticket...
Support Access
Official Documentation
Support Access Support Access is an optional setting that expedites troubleshooting by giving Liferay engineers direct access to a Liferay Cloud project environment. Liferay Cloud administrators...
Enabling Glowroot on PaaS
Official Documentation
Enabling Glowroot on PaaS Liferay DXP 2023.Q4+/Portal GA100+ Glowroot is included with Liferay in the /opt/liferay/glowroot folder. If you're running Liferay in a clustered environment, enable...
Liferay Cloud Platform Status
Official Documentation
Liferay Cloud Platform Status The Liferay Cloud Platform is comprised of multiple systems. Users can view the status of Liferay Cloud Platform systems, incident history, and planned maintenance...
Reading Liferay Cloud Service Logs
Official Documentation
Reading Liferay Cloud Service Logs Environment logs are crucial for diagnosing and resolving technical issues in a project. Liferay Cloud provides a variety of environment logs that users can...
Self-Healing
Official Documentation
Self-Healing The self-healing functionality of Liferay Cloud detects if a service or application has become unresponsive and automatically initiates procedures to recover the unresponsive service....
Troubleshooting Services
Official Documentation
Troubleshooting Services Services are the core of a Liferay Cloud environment. This article covers troubleshooting techniques that can be used to investigate and address issues that may arise with...
Maintenance and Downtime
Official Documentation
Maintenance and Downtime Sometimes, big changes in the underlying infrastructure of a project may cause downtime. When planning for these changes, you can enable maintenance mode to redirect...