Link
Search
Menu
Expand
Document
Documentation Menu
OpenSearch
Menu
Download
Community
Blog
Forum
Partners
Documentation
OpenSearch and Dashboards
Platform
Documentation
OpenSearch and OpenSearch Dashboards
← Back to docs home
About OpenSearch
Intro to OpenSearch
Quickstart
Version history
Breaking changes
Install and upgrade
Installing OpenSearch
Docker
Helm
Tarball
RPM
Debian
Ansible playbook
Windows
Installing OpenSearch Dashboards
Docker
Tarball
RPM
Debian
Helm
Windows
Configure TLS
Configuring OpenSearch
Configuration and system settings
Network settings
Discovery and gateway settings
Security settings
Circuit breaker settings
Cluster settings
Index settings
Search settings
Availability and recovery settings
Plugin settings
Experimental feature flags
Logs
Configuring OpenSearch Dashboards
Upgrading OpenSearch
Rolling Upgrade
Upgrades appendix
Rolling upgrade lab
Installing plugins
Managing OpenSearch Dashboards plugins
Migrate to OpenSearch
Using snapshots to migrate data
Migrating from Elasticsearch OSS to OpenSearch
Migrating Docker clusters to OpenSearch
Migrating from Kibana OSS to OpenSearch Dashboards
Managing Indexes
Index templates
Index aliases
Data streams
Reindex data
Index State Management
Policies
Managed indexes
Settings
ISM API
Index transforms
Transforms APIs
Index rollups
Index rollups API
Settings
Index management security
Refresh search analyzer
ISM Error Prevention
ISM Error Prevention resolutions
ISM Error Prevention API
Notification settings
Ingest Pipelines
Create pipeline
Simulate pipeline
Get pipeline
Delete pipeline
Handling pipeline failures
Ingest processors
Append
Bytes
Convert
CSV
Date
Date index name
Dissect
Dot expander
IP2Geo
Grok
KV
Lowercase
Remove
Sparse encoding
Text embedding
Text/image embedding
Uppercase
OpenSearch Dashboards
Quickstart guide
Discover
Time filter
Creating dashboards
Building data visualizations
Using area charts
Using coordinate and region maps
Using maps
Maps Stats API
Configuring a Web Map Service (WMS)
Using the self-host maps server
Using Gantt charts
Using VisBuilder
Index Management
Indexes
Data streams
Force merge
Rollover
Component templates
Notification settings
Snapshot Management
Dashboards Management
Index patterns
Advanced settings
Data sources
Configuring and using multiple data sources
Connecting Amazon S3 to OpenSearch
Query and visualize Amazon S3 data
Optimize query performance using OpenSearch indexing
Dev Tools
Running queries in the Dev Tools console
Query Workbench
Custom branding
Dashboards Query Language (DQL)
Search telemetry
OpenSearch Integrations
Creating and tuning your cluster
Cluster manager task throttling
Cross-cluster replication
Getting started
Auto-follow
Replication security
Replication settings
API
Availability and recovery
Snapshots
Take and restore snapshots
Snapshot management
Snapshot management API
Searchable snapshots
Remote-backed storage
Remote cluster state
Remote segment backpressure
Shallow snapshots
Remote Store Stats API
Search backpressure
Shard indexing backpressure
Stats API
Settings
Segment replication
Segment replication backpressure
Tuning for indexing speed
Security in OpenSearch
Configuration
System indexes
Configuring the Security backend
Modifying the YAML files
Configuring TLS certificates
Generating self-signed certificates
Applying changes to configuration files
API rate limiting
Configuring sign-in options
Disabling security
OpenSearch keystore
Authentication backends
HTTP basic authentication
JSON Web Token
OpenID Connect
SAML
Active Directory and LDAP
Proxy-based authentication
Client certificate authentication
Access control
REST layer authorization
Document-level security
Users and roles
Field-level security
Field masking
User impersonation
Cross-cluster search
Permissions
Default action groups
API
Anonymous authentication
Audit logs
Audit log field reference
Audit log storage types
OpenSearch Dashboards multi-tenancy
Multi-tenancy configuration
Dynamic configuration in OpenSearch Dashboards
Multi-tenancy aggregate view for saved objects
Cloud Lock - Encryption at Rest
Security analytics
OpenSearch Security for Security Analytics
Setting up Security Analytics
Creating detectors
Supported log types
Creating correlation rules
Creating custom log types
Using Security Analytics
The Overview page
Working with detectors
Working with findings
Working with detection rules
Working with the correlation graph
Working with alerts
API tools
Detector APIs
Rule APIs
Mappings APIs
Alerts and findings APIs
Correlation engine APIs
Log type APIs
Security Analytics settings
Mappings and field types
Supported field types
Alias
Binary
Numeric field types
Unsigned long
Boolean
Date field types
Date
Date nanoseconds
IP address
Range field types
Object field types
Object
Nested
Flat object
Join
String field types
Keyword
Text
Token count
Autocomplete field types
Completion
Search as you type
Geographic field types
Geopoint
Geoshape
Cartesian field types
xy point
xy shape
k-NN vector
Rank field types
Percolator
Text analysis
Language analyzers
Index analyzers
Search analyzers
Tokenizers
Token filters
Delimited term frequency
Normalizers
Query DSL
Query and filter context
Term-level and full-text queries compared
Term-level queries
Exists
Fuzzy
IDs
Prefix
Range
Regexp
Term
Terms
Terms set
Wildcard
Full-text queries
Match
Match Boolean prefix
Match phrase
Match phrase prefix
Multi-match
Query string
Simple query string
Intervals
Compound queries
Boolean
Boosting
Constant score
Disjunction max
Function score
Hybrid
Geographic and xy queries
Geo-bounding box
xy
Span queries
Match all queries
Specialized queries
Neural
Neural sparse
Script score
Minimum should match
Aggregations
Metric aggregations
Average
Cardinality
Extended stats
Geobounds
Matrix stats
Maximum
Minimum
Percentile ranks
Percentile
Scripted metric
Stats
Sum
Top hits
Value count
Bucket aggregations
Adjacency matrix
Date histogram
Date range
Diversified sampler
Filter
Filters
Geodistance
Geohash grid
Geohex grid
Geotile grid
Global
Histogram
IP range
Missing
Multi-terms
Nested
Range
Reverse nested
Sampler
Significant terms
Significant text
Terms
Pipeline aggregations
Search
Searching data
Paginate results
Point in Time
Point in Time API
Sort results
Highlight query matches
Autocomplete
Did-you-mean
Keyword search
k-NN search
k-NN index
Exact k-NN with scoring script
Approximate k-NN search
k-NN search with filters
k-NN Painless extensions
API
JNI libraries
Settings
Performance tuning
Neural search
Neural search tutorial
Semantic search
Multimodal search
Neural sparse search
Hybrid search
Conversational search
Search relevance
Compare Search Results
Search Relevance Stats API
Querqy
Search pipelines
Creating a search pipeline
Using a search pipeline
Retrieving search pipelines
Search processors
Filter query
Neural query enricher
Normalization
Rename field
Script
Personalize search ranking
Search pipeline metrics
Improving search performance
Asynchronous search
Asynchronous search security
Settings
Concurrent segment search
SQL and PPL
SQL and PPL API
Response formats
SQL and PPL CLI
SQL
Basic Queries
Complex Queries
Functions
JSON Support
Metadata Queries
Aggregate Functions
Delete
JDBC Driver
ODBC Driver
PPL
Syntax
Commands
Identifiers
Data Types
Functions
Full-Text Search
Settings
Troubleshooting
Monitoring
Limitations
Machine learning
ML Commons cluster settings
Integrating ML models
Model access control
Using ML models within OpenSearch
Custom models
Pretrained models
GPU acceleration
Connecting to externally hosted models
Connectors
Connector blueprints
Managing ML models in OpenSearch Dashboards
Supported algorithms
ML Commons API
Model APIs
Register model
Get model
Deploy model
Undeploy model
Delete model
Model group APIs
Register model group
Update model group
Search for a model group
Delete model group
Connector APIs
Create connector
Get connector
Delete connector
Execute algorithm
Tasks APIs
Get task
Delete task
Train and Predict APIs
Train and predict
Train
Predict
Profile
Stats
Monitoring your cluster
Job Scheduler
Performance Analyzer
API
Create PerfTop Dashboards
Metrics Reference
Root Cause Analysis
API
RCA Reference
Hot shard identification
Observability
Observability security
Application analytics
Event analytics
Log ingestion
Metrics analytics
Trace Analytics
Getting Started
OpenSearch Dashboards plugin
Analyzing Jaeger trace data
Distrbuted tracing
Notebooks
Operational panels
Alerting
Monitors
Per query and per bucket monitors
Per cluster metrics monitors
Per document monitors
Composite monitors
Triggers
Actions
Management
Alerting security
API
Cron
Alerting dashboards and visualizations
Anomaly detection
Anomaly detection API
Settings
Anomaly result mapping
Anomaly detection security
Anomaly detection visualizations and dashboards
Notifications
API
Simple Schema for Observability
Cross-cluster search
Reporting
Reporting using OpenSearch Dashboards
Reporting using the CLI
Download and install the Reporting CLI tool
Create and request visualization reports
Schedule reports with the cron utility
Schedule reports with AWS Lambda
Reporting CLI options
Use environment variables with the Reporting CLI
Tools
OpenSearch CLI
OpenSearch Kubernetes Operator
Logstash
Logstash execution model
Common filter plugins
Read from OpenSearch
Ship events to OpenSearch
Advanced configurations
Terraform
Grafana
API reference
Analyze API
Analysis API Terminology
CAT API
CAT aliases
CAT allocation
CAT count
CAT field data
CAT health
CAT indices operation
CAT cluster manager
CAT nodeattrs
CAT nodes
CAT pending tasks
CAT plugins
CAT recovery
CAT repositories
CAT segment replication
CAT segments
CAT shards
CAT snapshots
CAT tasks
CAT templates
CAT thread pool
Cluster APIs
Cluster allocation explain
Cluster routing and awareness
Cluster decommission
Cluster health
Cluster settings
Cluster stats
Count
Document APIs
Index document
Get document
Update document
Delete document
Bulk
Multi-get document
Delete by query
Update by query
Reindex document
Explain
Index APIs
Alias
Clear cache
Clone index
Close index
Create index
Create or update mappings
Dangling indexes
Delete index
Force merge
Get index
Get settings
Index exists
Open index
Shrink index
Split index
Stats
Update settings
Ingest APIs
Multi-search
Nodes APIs
Nodes info
Nodes stats
Nodes hot threads
Nodes usage
Nodes reload secure settings
Profile
Ranking evaluation
Remote cluster information
Script APIs
Create or Update Stored Script
Execute Painless stored script
Get Stored Script
Delete Script
Get Stored Script Contexts
Get Script Language
Execute Painless script
Scroll
Search
Search templates
Snapshot APIs
Register Snapshot Repository
Get Snapshot Repository
Delete Snapshot Repository
Verify Snaphot Repository
Create Snapshot
Get Snapshot
Delete Snapshot
Get Snapshot Status
Restore Snapshot
Tasks
Supported units
Common REST Parameters
Popular APIs
Troubleshooting
Troubleshoot securityadmin.sh
Troubleshoot TLS
Troubleshoot SAML
Troubleshoot OpenID Connect
Developer documentation
Extensions
ML Commons API
Model group APIs
Model group APIs
ML Commons supports the following model-group-level APIs:
Register model group
Update model group
Search for a model group
Delete model group
Related articles
Register model group
Update model group
Search for a model group
Delete model group