- Enterprise Search Guide: other versions:
- Getting started
- Prerequisites
- Ingestion
- Web crawler
- Connectors
- Native connectors
- Connector clients and frameworks
- Workplace Search connectors
- Usage
- Known issues
- Troubleshooting
- Logs
- Security
- Sync rules
- Content extraction
- Reference: Azure Blob Storage
- Reference: Confluence
- Reference: Google Cloud Storage
- Reference: Jira
- Reference: Microsoft SQL
- Reference: MongoDB
- Reference: MySQL
- Reference: Network drive
- Reference: Oracle
- Reference: PostgreSQL
- Reference: S3
- Reference: SharePoint
- 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.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
Managing Read-Only Mode via API
editManaging Read-Only Mode via API
editThe read-only mode flag for your deployment can be managed with the dedicated Read-Only Management API.
Authentication and Authorization
editTo make a call to one of the Read-Only Management APIs, you need to have a set of Elasticsearch credentials
(username/password) for a user that has a manage
Elasticsearch cluster privilege.
Getting read-only flag state
editIf you need to know if your deployment is in read-only mode, you can perform a GET
call on this
API endpoint. The response will have a single boolean field called enabled
representing the state
of the read-only flag for your deployment.
Here is how you can get the state of the read-only mode on your deployment using a curl
command:
curl -X GET <ENTERPRISE_SEARCH_BASE_URL>/api/ent/v1/internal/read_only_mode \ -H "Content-Type: application/json" \ -u username:password
An example response:
{"enabled":false}
Updating Read-Only Flag
editWhen you want to change the read-only mode flag for your deployment, you need to perform a PUT
call to
the read-only mode API endpoint with the value for the flag you want to set. The response will have
a single boolean field called enabled
representing the state of the read-only flag for your
deployment.
To set the new value for the read-only flag, you can use the following curl
command:
curl -X PUT <ENTERPRISE_SEARCH_BASE_URL>/api/ent/v1/internal/read_only_mode \ -d '{ "enabled": true }' \ -H "Content-Type: application/json" \ -u username:password
An example response:
{"enabled":true}