OpenSearch Cache API

Manage the security cache.

OpenAPI Specification

opensearch-cache-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: OpenSearch Security Plugin REST Account Cache API
  description: The OpenSearch Security plugin REST API lets administrators programmatically create and manage internal users, roles, role mappings, action groups, tenants, security configuration, audit log configuration, certificates, cache, allowlists, distinguished node names, and inspect the running security configuration. Endpoints are exposed under /_plugins/_security/api on the OpenSearch cluster.
  version: 2.x
  contact:
    name: OpenSearch Project
    url: https://opensearch.org/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://{cluster-host}:9200
  description: OpenSearch cluster (default port 9200)
  variables:
    cluster-host:
      default: localhost
security:
- BasicAuth: []
tags:
- name: Cache
  description: Manage the security cache.
paths:
  /_plugins/_security/api/cache:
    delete:
      operationId: flushSecurityCache
      summary: Flush security cache
      tags:
      - Cache
      responses:
        '200':
          description: Cache flushed.
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
externalDocs:
  description: OpenSearch Security Access Control API
  url: https://docs.opensearch.org/latest/security/access-control/api/