Docs
Documentation
Everything you need to learn, build with, and operate Apache Unomi.
Explore
Documentation by Topic
Installation & Configuration
Docker setup, manual installation, ElasticSearch configuration, and production deployment.
Read moreREST API & Integration
Send events, query profiles, manage segments, and integrate with external systems.
REST API docsExtending Unomi
Build plugins, custom actions, rules, conditions, and Groovy connectors.
Plugin guideUse Cases
Web personalization, mobile analytics, centralized profile management, and more.
View use casesVideos & Tutorials
Conference talks, video tutorials, articles, and community presentations.
Browse resourcesVersions
Manual by Version
Archived Versions (2.7.x – 1.1.x)
| Version | Online | HTML (zip) | |
|---|---|---|---|
| 2.7.x | Online | Download | Download |
| 2.6.x | — | Download | Download |
| 2.5.x | — | Download | Download |
| 2.4.x | — | Download | Download |
| 2.3.x | — | Download | Download |
| 2.2.x | — | Download | Download |
| 2.1.x | — | Download | Download |
| 2.0.x | — | Download | Download |
| 1.9.x | — | Download | Download |
| 1.7.x | — | Download | Download |
| 1.6.x | — | Download | Download |
| 1.5.x | — | Download | Download |
| 1.4.x | — | Download | Download |
| 1.3.x-incubating | — | Download | Download |
| 1.2.x-incubating | — | Download | Download |
| 1.1.x-incubating | — | Download | Download |
API Reference
REST API Endpoints
Since v1.6, the REST API is embedded as OpenAPI docs in the server athttp://localhost:8181/cxs/api-docs?url=openapi.json
| Endpoint | Description | Since |
|---|---|---|
| profiles | Manage user profiles | 1.3 |
| events | Send and query events | 1.4 |
| segments | Manage segments | 1.3 |
| rules | Manage rules | 1.3 |
| scoring | Manage scoring plans | 1.3 |
| campaigns | Manage campaigns | 1.3 |
| goals | Manage goals | 1.3 |
| definitions | Manage definitions | 1.3 |
| cluster | Manage cluster | 1.3 |
| query | Run queries | 1.3 |
| userList | Manage user lists | 1.3 |
| patches | Manage patches | 1.4 |
ElasticSearch Migration
When migrating between ElasticSearch versions used by Unomi:
- Standalone: Copy the data directory and custom
elasticsearch.ymlsettings to the new version. - Cluster: Use ElasticSearch Snapshot and Restore functionality.
Security Advisories
- CVE CVE-2021-31164— CRLF Log injection
- CVE CVE-2020-13942— Remote Code Execution
- CVE CVE-2020-11975— Remote Code Execution
Report vulnerabilities to security@apache.org.