Path parameters

  • namestring | array[string] Required

    A comma-separated list of roles to evict from the role cache. To evict all roles, use an asterisk (*). It does not support other wildcard patterns.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • _nodesobject Required

      Contains statistics about the number of nodes selected by the request.

      Hide _nodes attributes Show _nodes attributes object
      • failuresarray[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Hide failures attributes Show failures attributes object
        • typestring Required

          The type of error

        • reasonstring | null

          A human-readable explanation of the error, in English.

          One of:
          string-1stringstring-2string | null
        • stack_tracestring

          The server stack trace. Present only if the error_trace=true parameter was sent with the request.

        • caused_byobject

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • root_causearray[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • suppressedarray[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • totalnumber Required

        Total number of nodes selected by the request.

      • successfulnumber Required

        Number of nodes that responded successfully to the request.

      • failednumber Required

        Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

    • cluster_namestring Required
    • nodesobject Required
      Hide nodes attribute Show nodes attribute object
      • *object Additional properties
        Hide * attribute Show * attribute object
POST /_security/role/{name}/_clear_cache
curl \
 --request POST 'http://api.example.com/_security/role/{name}/_clear_cache' \
 --header "Authorization: $API_KEY"