- Enterprise Search Guide: other versions:
- Getting started
- Prerequisites
- Ingestion
- Web crawler
- Connectors
- Native connectors
- Connector clients
- Elastic connector framework
- Workplace Search connectors
- Using connectors
- Known issues
- Troubleshooting
- Document level security
- Logs
- Security
- Content syncs
- Sync rules
- Content extraction
- Reference: Azure Blob Storage
- Reference: Confluence
- Reference: Dropbox
- Reference: GitHub
- Reference: Gmail
- Reference: Google Cloud Storage
- Reference: Google Drive
- Reference: Jira
- Reference: Microsoft SQL
- Reference: MongoDB
- Reference: MySQL
- Reference: Network drive
- Reference: OneDrive
- Reference: Oracle
- Reference: PostgreSQL
- Reference: S3
- Reference: Salesforce
- Reference: ServiceNow
- Reference: SharePoint Online
- Reference: SharePoint Server
- Reference: Slack
- Ingestion APIs
- Ingest pipelines
- Document enrichment with ML
- ELSER text expansion
- Indices, engines, content sources
- Programming language clients
- Behavioral analytics
- Search UI
- App Search and Workplace Search
- Search Applications
- Enterprise Search server
- Run using Docker images
- Run using downloads (packages)
- Enterprise Search server known issues
- Troubleshooting
- Troubleshooting setup
- Monitoring
- Read-only mode
- Management APIs
- Monitoring APIs
- Read-only mode API
- Storage API
- Configuration
- Configuring encryption keys
- Configuring a mail service
- Configuring SSL/TLS
- Upgrading and migrating
- Upgrading self-managed deployments
- Upgrading from Enterprise Search 7.x
- Upgrading from Enterprise Search 7.11 and earlier
- Migrating from App Search on Elastic Cloud
- Migrating from App Search on Swiftype.com
- Migrating from self-managed App Search
- Logs and logging
- Known issues
- Troubleshooting
- Help, support, and feedback
- Release notes
- 8.10.4 release notes
- 8.10.3 release notes
- 8.10.2 release notes
- 8.10.1 release notes
- 8.10.0 release notes
- 8.9.2 release notes
- 8.9.1 release notes
- 8.9.0 release notes
- 8.8.2 release notes
- 8.8.1 release notes
- 8.8.0 release notes
- 8.7.1 release notes
- 8.7.0 release notes
- 8.6.2 release notes
- 8.6.1 release notes
- 8.6.0 release notes
- 8.5.3 release notes
- 8.5.2 release notes
- 8.5.1 release notes
- 8.5.0 release notes
- 8.4.3 release notes
- 8.4.2 release notes
- 8.4.1 release notes
- 8.4.0 release notes
- 8.3.3 release notes
- 8.3.2 release notes
- 8.3.1 release notes
- 8.3.0 release notes
- 8.2.3 release notes
- 8.2.2 release notes
- 8.2.1 release notes
- 8.2.0 release notes
- 8.1.3 release notes
- 8.1.2 release notes
- 8.1.1 release notes
- 8.1.0 release notes
- 8.0.1 release notes
- 8.0.0 release notes
- 8.0.0-rc2 release notes
- 8.0.0-rc1 release notes
- 8.0.0-beta1 release notes
- 8.0.0-alpha2 release notes
- 8.0.0-alpha1 release notes
Management APIs
editManagement APIs
editTo help operators better integrate Enterprise Search into their infrastructure and allow for better product deployment automation, we have added a set of low-level Enterprise Search API endpoints making it possible to check the health of a deployment, monitor its performance over time and to manage read-only mode for a deployment.
The following APIs are available for you to use:
- Health and Stats API – a set of endpoints for checking the health and monitoring the performance of a deployment over time.
- Read-Only Flag Management API – an API endpoint for managing the Read-only mode for a deployment.
- Storage API – an API endpoint for managing the indices for a deployment.
Authentication
editTo be able to call an Enterprise search management API, you need a set of credentials (username/password) for an Elasticsearch user. The user should have an appropriate set of privileges assigned to it depending on the API you are calling. See specific API documentation pages above for more details on the privileges you need to make an API call.
When making an API call, you need to attach a
basic auth header to your HTTP requests.
When using a curl
command, you can do it like this:
curl -X GET <ENTERPRISE_SEARCH_BASE_URL>/api/ent/v1/internal/something \ -H "Content-Type: application/json" \ -u username:password
See specific API documentation pages for more examples.
These endpoints are accessible without authentication when Elasticsearch security is disabled.
On this page