Clear the privileges cache

POST /_security/privilege/{application}/_clear_cache

Auth

Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated.

Required privileges

Cluster privileges manage_security

Path parameters

application string required: A comma-separated list of applications. To clear all applications, use an asterism (*). It does not support other wildcard patterns.

Response

application/json

_nodes object required
cluster_name string required
nodes map string to object required

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_security/privilege/myapp/_clear_cache

JavaScript Elasticsearch JavaScript Client

const response = await client.security.clearCachedPrivileges({
  application: "myapp",
});

Python Elasticsearch Python Client

resp = client.security.clear_cached_privileges(
    application="myapp",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_security/privilege/myapp/_clear_cache" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().clearCachedPrivileges(c -> c
    .application("myapp")
);

C# Elasticsearch .NET Client

var response = await client.Security.ClearCachedPrivilegesAsync(application: "myapp");

PHP Elasticsearch PHP Client

$resp = $client->security()->clearCachedPrivileges([
    "application" => "myapp",
]);

Ruby Elasticsearch Ruby Client

response = client.security.clear_cached_privileges(
  application: "myapp"
)

Response

{
  "_nodes": {
    "failures": [
      {
        "type": "string",
        "reason": "string",
        "stack_trace": "string",
        "caused_by": {
          "type": "string",
          "reason": "string",
          "stack_trace": "string",
          "caused_by": {
            "type": "string",
            "stack_trace": "string"
          },
          "root_cause": [],
          "suppressed": []
        },
        "root_cause": [
          {
            "type": "string",
            "stack_trace": "string"
          }
        ],
        "suppressed": [
          {
            "type": "string",
            "stack_trace": "string"
          }
        ]
      }
    ],
    "total": 0,
    "successful": 0,
    "failed": 0
  },
  "cluster_name": "string",
  "nodes": {
    "key": {
      "name": "string"
    }
  }
}

Generated from the API spec