Search Guard - Enterprise Security for Elasticsearch
  • Security
  • Alerting
  • Index Management
  • Encryption at Rest
  • Anomaly Detection
  • Versions
    • FLX
    • 7x-53
    • 7x-52
    • 7x-51
    • 7x-50
    • 7x-49
    • 7x-48
    • 7x-47
    • 7x-46
    • 7x-45
    • 7x-43
    • 7x-42
    • 7x-41
    • 7x-40
    • 7x-38
    • 7x-37
    • 7x-36
    • 7x-35
    • 6x-25
    • 6x-24
    • 6x-23
    • 6x-22
    • 6x-21
    • 6x-20
    • v5
    • v2
  • Contact
  • Security
    • Getting Started
      • What is Search Guard?
      • Key Concepts
      • Quickstart
        • Demo Installer (Fastest)
        • Manual Installation
        • Your First Steps
          • Adding Users
          • Configuring Roles
          • Mapping Users to Roles
          • Testing the Configuration
      • Editions and Licensing
        • Feature Comparison
        • Community Edition
        • Academic and Scientific Licensing
        • OEM Licensing
    • Installation and Setup
      • Installation
      • TLS Certificate Setup
        • Quick Setup (TLS Tool)
        • Alternative (Installer)
        • Configuring TLS
        • Certificate Revocation
        • TLS Hot Reload
      • Versions and Compatibility
        • Available Versions
        • Compatibility Matrix
        • End of Life Policy
      • Upgrades and Migrations
        • Upgrading Between Minor Versions
        • Upgrading from FLX 1.x to 2.x
        • Upgrading from 7.x to 8.x
        • Migrating from Classic to FLX
          • Migration Overview
          • Quick Start
          • Production Migration
          • Feature Mapping
          • FLX Release Notes
    • Configuration
      • Configuration Overview
      • Demo Users and Roles
      • Configuration Tools
        • Using sgctl (CLI)
          • Basic Usage
          • Common Examples
          • Making Changes
          • System Administration
        • Configuration GUI (Kibana)
        • REST API
          • Access Control
          • Usage and Return Values
          • Internal Users API
          • Roles API
          • Role Mappings API
          • Action Groups API
          • Tenants API
          • Blocks API
          • License API
          • Cache API
          • Bulk Requests
          • Reserved and Hidden Resources
      • Configuration Variables
      • Configuration Index Maintenance
    • Authentication
      • Authentication Overview
      • General Configuration
        • Introduction to sg_authc
        • Advanced User Mapping
        • Advanced Options
      • Authentication Methods
        • Internal Users Database
        • Basic Authentication
        • Active Directory / LDAP
          • Quick Start
          • Advanced Configuration
        • JSON Web Tokens (JWT)
          • Quick Start
          • Advanced Configuration
        • Kerberos / SPNEGO
        • Proxy Authentication
          • Quick Start
          • Advanced Configuration
        • Client Certificate Authentication
        • Anonymous Authentication
        • Search Guard Auth Tokens
    • Authorization
      • Authorization Overview
      • Mapping Users to Roles
      • Role Mapping Modes
      • Defining Roles
      • Roles (Legacy 2.x format)
      • Action Groups
      • Runtime Privilege Evaluation
      • Advanced Topics
      • User Impersonation
    • Fine-Grained Access Control
      • Document-Level Security
        • Basics
        • Attribute-Based DLS
        • Advanced Topics
      • Field-Level Security
        • Basics
        • Field Anonymization
    • Audit and Compliance
      • Audit Logging Overview
      • Audit Configuration
        • Storage Types
        • Event Routing
        • Field Reference
      • Compliance Features
        • Read History
        • Write History
        • Immutable Indices
        • Configuration Change Tracking
        • Elasticsearch System Changes
    • Kibana
      • Installing the Kibana Plugin
      • Kibana Authentication
        • Authentication Types Overview
        • Basic Authentication
          • Configuration
          • Customizing Login Page
        • OpenID Connect (OIDC)
          • Quick Start
          • Advanced Configuration
        • SAML
          • Quick Start
          • Advanced Configuration
          • Troubleshooting
        • Proxy Authentication
        • Kerberos
        • JWT URL Parameters
        • Anonymous Authentication
        • Multiple Authentication Methods
      • Multi-Tenancy
      • Advanced Topics
        • Read-Only Mode
        • Using the Kibana API
        • Embedding Kibana in IFrame
    • Production Deployment
      • Production Checklist
      • TLS for Production
      • Security Hardening
      • Performance Tuning
      • Monitoring and Maintenance
      • Backup and Recovery
    • Integrations
      • Elastic Stack Components
        • Logstash
        • X-Pack Monitoring
        • X-Pack Alerting
        • X-Pack Machine Learning
      • Elasticsearch Features
        • Cross-Cluster Search
        • Snapshot and Restore
      • Third-Party Tools
        • Cerebro
        • Fluentd
        • Grafana
    • Advanced Topics
      • OEM Features
        • SSL-Only Mode
        • Index Restore
        • Inter-Node Traffic Evaluator
        • Custom Principal Extractor
        • Injecting SSLContext
      • Disabling or Removing Search Guard
    • Troubleshooting
      • General Troubleshooting
        • Setting Log Levels
      • TLS Issues
      • Authentication Issues
        • Users and Roles
        • Permissions
      • Kibana Issues
        • General Kibana Issues
        • Multi-Tenancy Issues
    • Changelogs
      • Search Guard Security
      • Kibana Plugin
      • TLS Tool
    • Security Glossary
Version: SG FLX
  1. Home
  2. Security
  3. Configuration
  4. Configuration Tools
  5. REST API

REST API

Browse all documentation pages in the REST API category:

  • Access Control
  • Usage and Return Values
  • Internal Users API
  • Roles API
  • Role Mappings API
  • Action Groups API
  • Tenants API
  • Blocks API
  • License API
  • Cache API
  • Bulk Requests
  • Reserved and Hidden Resources

Questions? Drop us a note!

Not what you were looking for? Try the search.

Search Guard is a trademark of floragunn GmbH, registered in the U.S. and in other countries.

Elasticsearch, Kibana, Logstash, and Beats are trademarks of Elasticsearch BV, registered in the U.S. and in other countries.

Apache, Apache Lucene, Apache Hadoop, Hadoop, HDFS and the yellow elephant logo are trademarks of the Apache Software Foundation in the United States and/or other countries.
  • Blog
  • Forum
  • Partners
  • Integrators
  • Licensing

© 2026 floragunn GmbH - All Rights Reserved
Search Guard