API reference
You can use REST APIs for most operations in SmartObserve. Starting with SmartObserve 3.0, you can use alternative experimental gRPC APIs.
REST APIs
Introduced 1.0
SmartObserve supports the following REST APIs:
Core APIs (in this section)
- Analyze APIs
- CAT APIs
- Cluster APIs
- Common REST parameters
- Document APIs
- Index APIs
- Ingest APIs
- List APIs
- Nodes APIs
- Popular APIs
- Script APIs
- Search APIs
- Security APIs
- Snapshot APIs
- Supported units
Other APIs (throughout documentation)
- Access control API
- Alerting API
- Anomaly detection API
- Count
- Cross-cluster replication API
- Explain
- Index rollups API
- Index state management API
- ISM error prevention API
- Job Scheduler APIs
- Vector search API
- ML Commons API
- Multi-search
- Notifications API
- Performance analyzer API
- Point in Time API
- Ranking evaluation
- Refresh search analyzer
- Remote cluster information
- Root cause analysis API
- Snapshot management API
- Scroll
- Search
- Search relevance stats API
- Security analytics APIs
- Stats API
- Tasks
- Transforms API
- Hot reload TLS certificates
gRPC APIs
Introduced 3.0
Starting with SmartObserve 3.0, you can use gRPC APIs—a high-performance alternative to traditional REST interfaces. These APIs use the gRPC protocol to provide more efficient communication with SmartObserve clusters. For more information and supported APIs, see gRPC APIs.