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
    • Introduction to Search Guard
      • Overview
      • Main Concepts
    • Quickstart
      • Demo Installer (Linux/Mac)
      • Manual Installation
      • Guided Tour
        • Adding users
        • Configuring roles
        • Mapping users to Search Guard roles
        • Testing the configuration
    • Search Guard Versions
      • Releases
      • Community Edition
      • Enterprise and Compliance Edition
      • Academic and Scientific Licensing
      • OEM Licensing
      • End of life policy
    • Installing Search Guard
      • Search Guard Installation
      • Updating Search Guard
      • Disabling or Removing Search Guard
      • Search Guard Compatibility
      • Migrating from Classic to FLX
        • Migrating to FLX
        • Quick Start
        • Production
        • FLX release notes
        • Feature map
      • Upgrading Search Guard
        • Upgrade from FLX 1.x to 2.x
        • Upgrade from SearchGuard 7.x to 8.x
    • TLS Setup
      • Generating Certificates
        • Search Guard Installer
        • Offline TLS Tool
      • Configuring TLS
      • Production environments
      • Certificate revocation
      • TLS hot-reload
    • Search Guard Configuration
      • Overview
      • Using sgctl
        • Basic Usage
        • Examples
        • Configuration changes
        • System Administration
      • Search Guard configuration GUI
      • Configuration variables
      • Configuration index maintenance
    • Authentication
      • Overview
      • General Configuration
        • Introduction to sg_authc
        • Advanced user mapping
        • Other advanced options
      • Password-based Authentication
        • Overview
        • Internal users database
      • Active Directory and LDAP
        • Quick Start
        • Advanced Configuration
      • Kerberos / SPNEGO
      • JWT
        • Quick Start
        • Advanced Configuration
      • Proxy authentication
        • Quick Start
        • Advanced Configuration
      • Client certificate authentication
      • Anonymous authentication
      • Search Guard Auth Tokens
    • Authorization
      • Demo users and roles
      • Mapping users to Search Guard roles
      • Permissions and action groups
      • Search Guard roles
      • Search Guard roles (2.x and below)
      • Role mapping modes
      • Runtime index privilege evaluation
      • Advanced topics
        • User impersonation
        • Snapshot and restore
    • Document-level security
      • Basics
      • Attribute-based authorization
      • Advanced topics
    • Field-level security
      • Field-level security
      • Field anonymization
    • Audit Logging
      • Configuring Audit Logging
      • Storage Types
      • Event routing
      • Field Reference
      • Read History Audit Logging
      • Write History Audit Logging
      • Configuration change tracking
      • System change tracking
      • Immutable indices
    • Rest API
      • Access Control
      • Usage and return values
      • Internal users API
      • Roles API
      • Roles mapping API
      • Action groups API
      • Blocks API
      • Tenants API
      • License API
      • Cache API
      • Advanced Topics
        • Bulk Requests
        • Reserved and hidden resources
    • Kibana
      • Installing the Plugin
      • Authentication
        • Overview
        • Password-based Authentication
          • Quick Start
          • Customizing the login page
        • OIDC
          • Quick Start
          • Advanced Configuration
        • SAML
          • Quick Start
          • Advanced Configuration
          • Troubleshooting
      • Proxy
      • Kerberos
      • Multi-Tenancy
      • Advanced Topics
        • Using multiple authentication methods
        • Read Only mode
        • Using the Kibana API
        • JWT URL Parameters
        • Anonymous Authentication
        • Kibana in IFrame
    • Integrations
      • Logstash
      • Cross Cluster Search
      • X-Pack Monitoring
      • X-Pack Alerting
      • X-Pack Machine Learning
      • Cerebro
      • Fluentd
      • Grafana
    • OEM Features
      • SSL only mode
      • Search Guard index restore
      • Inter-node traffic evaluator
      • Custom Principal Extractor
      • Injecting an SSLContext
    • Troubleshooting
      • Setting the log level
      • TLS
      • Users and Roles
      • Permissions
      • Kibana
      • Multi Tenancy
    • Changelogs
      • Search Guard Security
      • Kibana
      • TLS Tool
Version: SG FLX
  1. Home
  2. Security
  3. Rest API

Rest API

Browse all documentation pages in the Rest API category:

  • Access Control
  • Usage and return values
  • Internal users API
  • Roles API
  • Roles mapping API
  • Action groups API
  • Blocks API
  • Tenants API
  • License API
  • Cache API
  • Advanced Topics
    • 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

© 2025 floragunn GmbH - All Rights Reserved
Search Guard