Clear the roles cache

POST /_security/role/{name}/_clear_cache

Evict roles from the native role cache.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_security/role/my_admin_role/_clear_cache

JavaScript Elasticsearch JavaScript Client

const response = await client.security.clearCachedRoles({
  name: "my_admin_role",
});

Python Elasticsearch Python Client

resp = client.security.clear_cached_roles(
    name="my_admin_role",
)

curl Shell

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

Java Elasticsearch Java Client

client.security().clearCachedRoles(c -> c
    .name("my_admin_role")
);

C# Elasticsearch .NET Client

var response = await client.Security.ClearCachedRolesAsync(name: new[] { "my_admin_role" });

PHP Elasticsearch PHP Client

$resp = $client->security()->clearCachedRoles([
    "name" => "my_admin_role",
]);

Ruby Elasticsearch Ruby Client

response = client.security.clear_cached_roles(
  name: "my_admin_role"
)

Response

No example