How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Elastic Stack (ELK Stack)

Elastic Stack (ELK Stack) Security API

The security API from Elastic Stack (ELK Stack) — 64 operation(s) for security.

Documentation Provider Profile APIs.io OpenAPI GitHub

Elastic Stack (ELK Stack) Security API is one of 132 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Security. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 100 operations across 64 paths, and defines 824 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://{kibana_url}.

100 operations 64 paths 824 schemas 8 DELETE31 GET44 POST17 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://{elasticsearch_endpoint}
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

Elastic Stack (ELK Stack) Security API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). It accepts HTTP basic authentication (basicAuth).

  • apiKeyAuth — These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…

Paths & Operations 100

Across 64 paths, the API surfaces 100 operations — 8 DELETE, 31 GET, 44 POST, 17 PUT. Each is listed below with its method, path, parameters, and response codes.

security 100
POST
/_encryption/_reset
Reset the project encryption key
encryption-reset 3 params → 200
POST
/_security/profile/_activate
Activate a user profile
security-activate-user-profile body → 200
GET
/_security/_authenticate
Authenticate a user
security-authenticate → 200
GET
/_security/role
Get roles
security-get-role-1 1 param → 200
POST
/_security/role
Bulk create or update roles
security-bulk-put-role 1 param body → 200
DELETE
/_security/role
Bulk delete roles
security-bulk-delete-role 1 param body → 200
POST
/_security/api_key/_bulk_update
Bulk update API keys
security-bulk-update-api-keys body → 200
PUT
/_security/user/{username}/_password
Change passwords
security-change-password 2 params body → 200
POST
/_security/user/{username}/_password
Change passwords
security-change-password-1 2 params body → 200
PUT
/_security/user/_password
Change passwords
security-change-password-2 1 param body → 200
POST
/_security/user/_password
Change passwords
security-change-password-3 1 param body → 200
POST
/_security/api_key/{ids}/_clear_cache
Clear the API key cache
security-clear-api-key-cache 1 param → 200
POST
/_security/privilege/{application}/_clear_cache
Clear the privileges cache
security-clear-cached-privileges 1 param → 200
POST
/_security/realm/{realms}/_clear_cache
Clear the user cache
security-clear-cached-realms 2 params → 200
POST
/_security/role/{name}/_clear_cache
Clear the roles cache
security-clear-cached-roles 1 param → 200
POST
/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache
Clear service account token caches
security-clear-cached-service-tokens 3 params → 200
PUT
/_security/api_key/clone
Clone an API key
security-clone-api-key-1 1 param body → 200
POST
/_security/api_key/clone
Clone an API key
security-clone-api-key 1 param body → 200
GET
/_security/api_key
Get API key information
security-get-api-key 8 params → 200
PUT
/_security/api_key
Create an API key
security-create-api-key 1 param body → 200
POST
/_security/api_key
Create an API key
security-create-api-key-1 1 param body → 200
DELETE
/_security/api_key
Invalidate API keys
security-invalidate-api-key body → 200
POST
/_security/cross_cluster/api_key
Create a cross-cluster API key
security-create-cross-cluster-api-key body → 200
PUT
/_security/service/{namespace}/{service}/credential/token/{name}
Create a service account token
security-create-service-token 4 params → 200
POST
/_security/service/{namespace}/{service}/credential/token/{name}
Create a service account token
security-create-service-token-1 4 params → 200
DELETE
/_security/service/{namespace}/{service}/credential/token/{name}
Delete service account tokens
security-delete-service-token 4 params → 200
POST
/_security/service/{namespace}/{service}/credential/token
Create a service account token
security-create-service-token-2 3 params → 200
POST
/_security/delegate_pki
Delegate PKI authentication
security-delegate-pki body → 200
GET
/_security/privilege/{application}/{name}
Get application privileges
security-get-privileges-2 2 params → 200
DELETE
/_security/privilege/{application}/{name}
Delete application privileges
security-delete-privileges 3 params → 200
GET
/_security/role/{name}
Get roles
security-get-role 2 params → 200
PUT
/_security/role/{name}
Create or update roles
security-put-role 2 params body → 200
POST
/_security/role/{name}
Create or update roles
security-put-role-1 2 params body → 200
DELETE
/_security/role/{name}
Delete roles
security-delete-role 2 params → 200
GET
/_security/role_mapping/{name}
Get role mappings
security-get-role-mapping 1 param → 200
PUT
/_security/role_mapping/{name}
Create or update role mappings
security-put-role-mapping 2 params body → 200
POST
/_security/role_mapping/{name}
Create or update role mappings
security-put-role-mapping-1 2 params body → 200
DELETE
/_security/role_mapping/{name}
Delete role mappings
security-delete-role-mapping 2 params → 200
GET
/_security/user/{username}
Get users
security-get-user 2 params → 200
PUT
/_security/user/{username}
Create or update users
security-put-user 2 params body → 200
POST
/_security/user/{username}
Create or update users
security-put-user-1 2 params body → 200
DELETE
/_security/user/{username}
Delete users
security-delete-user 2 params → 200
PUT
/_security/user/{username}/_disable
Disable users
security-disable-user 2 params → 200
POST
/_security/user/{username}/_disable
Disable users
security-disable-user-1 2 params → 200
PUT
/_security/profile/{uid}/_disable
Disable a user profile
security-disable-user-profile 2 params → 200
POST
/_security/profile/{uid}/_disable
Disable a user profile
security-disable-user-profile-1 2 params → 200
PUT
/_security/user/{username}/_enable
Enable users
security-enable-user 2 params → 200
POST
/_security/user/{username}/_enable
Enable users
security-enable-user-1 2 params → 200
PUT
/_security/profile/{uid}/_enable
Enable a user profile
security-enable-user-profile 2 params → 200
POST
/_security/profile/{uid}/_enable
Enable a user profile
security-enable-user-profile-1 2 params → 200
GET
/_security/enroll/kibana
Enroll Kibana
security-enroll-kibana → 200
GET
/_security/enroll/node
Enroll a node
security-enroll-node → 200
GET
/_security/privilege/_builtin
Get builtin privileges
security-get-builtin-privileges → 200
GET
/_security/privilege
Get application privileges
security-get-privileges → 200
PUT
/_security/privilege
Create or update application privileges
security-put-privileges 1 param body → 200
POST
/_security/privilege
Create or update application privileges
security-put-privileges-1 1 param body → 200
GET
/_security/privilege/{application}
Get application privileges
security-get-privileges-1 1 param → 200
GET
/_security/role_mapping
Get role mappings
security-get-role-mapping-1 → 200
GET
/_security/service/{namespace}/{service}
Get service accounts
security-get-service-accounts 2 params → 200
GET
/_security/service/{namespace}
Get service accounts
security-get-service-accounts-1 1 param → 200
GET
/_security/service
Get service accounts
security-get-service-accounts-2 → 200
GET
/_security/service/{namespace}/{service}/credential
Get service account credentials
security-get-service-credentials 2 params → 200
GET
/_security/settings
Get security index settings
security-get-settings 1 param → 200
PUT
/_security/settings
Update security index settings
security-update-settings 2 params body → 200
GET
/_security/stats
Get security stats
security-get-stats → 200
POST
/_security/oauth2/token
Get a token
security-get-token body → 200
DELETE
/_security/oauth2/token
Invalidate a token
security-invalidate-token body → 200
GET
/_security/user
Get users
security-get-user-1 1 param → 200
GET
/_security/user/_privileges
Get user privileges
security-get-user-privileges → 200
GET
/_security/profile/{uid}
Get a user profile
security-get-user-profile 2 params → 200
POST
/_security/api_key/grant
Grant an API key
security-grant-api-key 1 param body → 200
GET
/_security/user/_has_privileges
Check user privileges
security-has-privileges body → 200
POST
/_security/user/_has_privileges
Check user privileges
security-has-privileges-1 body → 200
GET
/_security/user/{user}/_has_privileges
Check user privileges
security-has-privileges-2 1 param body → 200
POST
/_security/user/{user}/_has_privileges
Check user privileges
security-has-privileges-3 1 param body → 200
GET
/_security/profile/_has_privileges
Check user profile privileges
security-has-privileges-user-profile body → 200
POST
/_security/profile/_has_privileges
Check user profile privileges
security-has-privileges-user-profile-1 body → 200
POST
/_security/oidc/authenticate
Authenticate OpenID Connect
security-oidc-authenticate body → 200
POST
/_security/oidc/logout
Logout of OpenID Connect
security-oidc-logout body → 200
POST
/_security/oidc/prepare
Prepare OpenID connect authentication
security-oidc-prepare-authentication body → 200
GET
/_security/_query/api_key
Find API keys with a query
security-query-api-keys 3 params body → 200
POST
/_security/_query/api_key
Find API keys with a query
security-query-api-keys-1 3 params body → 200
GET
/_security/_query/role
Find roles with a query
security-query-role body → 200
POST
/_security/_query/role
Find roles with a query
security-query-role-1 body → 200
GET
/_security/_query/user
Find users with a query
security-query-user 1 param body → 200
POST
/_security/_query/user
Find users with a query
security-query-user-1 1 param body → 200
POST
/_security/saml/authenticate
Authenticate SAML
security-saml-authenticate body → 200
POST
/_security/saml/complete_logout
Logout of SAML completely
security-saml-complete-logout body → 200
POST
/_security/saml/invalidate
Invalidate SAML
security-saml-invalidate body → 200
POST
/_security/saml/logout
Logout of SAML
security-saml-logout body → 200
POST
/_security/saml/prepare
Prepare SAML authentication
security-saml-prepare-authentication body → 200
GET
/_security/saml/metadata/{realm_name}
Create SAML service provider metadata
security-saml-service-provider-metadata 1 param → 200
GET
/_security/profile/_suggest
Suggest a user profile
security-suggest-user-profiles 1 param body → 200
POST
/_security/profile/_suggest
Suggest a user profile
security-suggest-user-profiles-1 1 param body → 200
PUT
/_security/api_key/{id}
Update an API key
security-update-api-key 1 param body → 200
PUT
/_security/cross_cluster/api_key/{id}
Update a cross-cluster API key
security-update-cross-cluster-api-key 1 param body → 200
PUT
/_security/profile/{uid}/_data
Update user profile data
security-update-user-profile-data 4 params body → 200
POST
/_security/profile/{uid}/_data
Update user profile data
security-update-user-profile-data-1 4 params body → 200
GET
/_ssl/certificates
Get SSL certificates
ssl-certificates → 200
POST
/api/security/role/_query
Query roles
post-security-role-query 1 param body → 200

Schemas 824

The contract defines 824 schemas that model the data the API accepts and returns. The most detailed are _types.query_dsl.QueryContainer (61 properties), indices._types.IndexSettings (57 properties), _global.search._types.SearchRequestBody (34 properties), _global.search._types.HighlightBase (21 properties). Each schema is shown below with its type and property counts.

_types.query_dsl.SpanContainingQuery
_types.query_dsl.TypeQuery
_types.analysis.MinHashTokenFilter
_types.aggregations.TopHitsAggregation
_types.query_dsl.CombinedFieldsZeroTerms
string
_types.aggregations.BucketSelectorAggregation
_types.analysis.HunspellTokenFilter
_types.aggregations.TermsPartition
object
2 properties 2 required
security.query_role.RoleQueryContainer
object
11 properties
_types.query_dsl.GeoBoundingBoxQuery
_types.analysis.DanishAnalyzer
object
3 properties 1 required
_types.SortResults
array
indices._types.SoftDeletes
object
2 properties
_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator
object
3 properties 2 required
indices._types.SegmentSortMode
string
_types.analysis.KuromojiAnalyzer
object
3 properties 1 required
_types.aggregations.ChildrenAggregation
_types.EpochTimeUnitMillis
_types.aggregations.MatrixAggregation
_types.aggregations.MultiBucketAggregateBaseMultiTermsBucket
_types.aggregations.MultiBucketBase
object
Base type for multi-bucket aggregation results that can hold sub-aggregations results.
1 property 1 required
_types.aggregations.BucketsMultiTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.query_dsl.DisMaxQuery
_types.aggregations.SamplerAggregationExecutionHint
string
_types.aggregations.MovingPercentilesAggregation
_types.aggregations.HoltWintersModelSettings
object
6 properties
_types.aggregations.HistogramAggregation
_types.GeoTilePrecision
number
_types.analysis.CompoundWordTokenFilterBase
_types.aggregations.DateRangeAggregation
indices._types.MappingLimitSettingsFieldNameLength
object
1 property
indices._types.SettingsSimilarityDfr
object
4 properties 4 required
indices._types.TranslogRetention
object
2 properties
_types.aggregations.StringStatsAggregation
_types.analysis.BulgarianAnalyzer
object
4 properties 1 required
_types.aggregations.TTestType
string
_types.TextSimilarityReranker
_types.aggregations.ParentAggregation
_types.aggregations.MaxBucketAggregation
_global.search._types.FieldCollapse
object
4 properties 1 required
_types.DateTime
A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch…
_types.query_dsl.RangeQueryBase
_types.query_dsl.NumericDecayFunction
_types.analysis.StemmerOverrideTokenFilter
_types.aggregations.SingleBucketAggregateBase
Base type for single-bucket aggregation results that can hold sub-aggregations results.
_types.aggregations.FormattableMetricAggregation
indices._types.RetentionLease
object
1 property 1 required
_types.aggregations.MissingAggregate
_types.analysis.TokenizerDefinition
_types.query_dsl.UntypedRangeQuery
security.get_token.AuthenticatedUser
_types.IndexName
string
_types.aggregations.GeoLineSort
object
1 property 1 required
_types.aggregations.MultiBucketAggregateBaseStringTermsBucket
_types.aggregations.MultiBucketAggregateBaseDoubleTermsBucket
_types.aggregations.MultiBucketAggregateBaseRangeBucket
_types.analysis.KuromojiPartOfSpeechTokenFilter
security._types.RestrictionWorkflow
_types.Uuid
string
_types.aggregations.MultiTermLookup
_types.query_dsl.DecayFunctionBaseGeoLocationDistance
object
1 property
_types.aggregations.CompositeAggregation
_types.analysis.HyphenationDecompounderTokenFilter
_types.query_dsl.SemanticQuery
_types.aggregations.InferenceAggregation
_types.analysis.ArabicAnalyzer
object
4 properties 1 required
_types.aggregations.HoltWintersMovingAverageAggregation
_types.query_dsl.TextQueryType
string
_types.analysis.KuromojiIterationMarkCharFilter
_types.analysis.StopWords
Language value, such as arabic or thai. Defaults to english. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by la…
_types.analysis.SimplePatternSplitTokenizer
_types.aggregations.ScriptedMetricAggregation
_types.analysis.ScandinavianNormalizationTokenFilter
_types.aggregations.StatsBucketAggregation
_types.query_dsl.RangeQueryBaselong
security._types.TemplateFormat
string
security._types.ManageUserPrivileges
object
1 property 1 required
security._types.RemoteUserIndicesPrivileges
object
6 properties 4 required
_types.analysis.DictionaryDecompounderTokenFilter
_types.analysis.UppercaseTokenFilter
_types.aggregations.BucketPathAggregation
security._types.Restriction
object
1 property 1 required
_types.analysis.DelimitedPayloadEncoding
string
_types.aggregations.AggregationRange
object
3 properties
_types.DateFormat
string
_types.analysis.CustomNormalizer
object
3 properties 1 required
security._types.UserIndicesPrivileges
object
5 properties 3 required
_types.DiversifyRetriever
_types.query_dsl.TextExpansionQuery
security.query_api_keys.ApiKeyFiltersAggregation
_types.analysis.ClassicTokenFilter
_types.analysis.SimplePatternTokenizer
_types.analysis.SimpleAnalyzer
object
2 properties 1 required
_types.analysis.MultiplexerTokenFilter
security._types.CredentialManagedBy
string
_types.aggregations.ExtendedStatsBucketAggregation
_types.analysis.CjkAnalyzer
object
3 properties 1 required
_types.analysis.TrimTokenFilter
_types.analysis.PersianNormalizationTokenFilter
_types.analysis.IndicNormalizationTokenFilter
_types.GeoHash
string
_types.query_dsl.WildcardQuery
security._types.IndicesPrivileges
object
5 properties 2 required
_global.search._types.HighlighterOrder
string
security.get_service_accounts.RoleDescriptorWrapper
object
1 property 1 required
_types.query_dsl.FuzzyQuery
security._types.RealmInfo
object
2 properties 2 required
_types.Id
string
_types.InnerRetriever
object
3 properties 3 required
_types.query_dsl.SparseVectorQuery
_types.analysis.PhoneticNameType
string
_types.aggregations.SingleMetricAggregateBase
_types.SlicedScroll
object
3 properties 2 required
_types.aggregations.SignificantTextAggregation
_types.aggregations.SignificantTermsAggregation
indices._types.IndexSettingsUnassigned
object
1 property
_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance
_types.query_dsl.MultiValueMode
string
indices._types.SettingsSimilarityBoolean
object
1 property 1 required
_types.Sort
_types.query_dsl.TermsSetQuery
_types.aggregations.GoogleNormalizedDistanceHeuristic
object
1 property
_types.aggregations.TermsAggregation
_types.analysis.IcuCollationAlternate
string
_types.analysis.IcuNormalizationMode
string
_types.query_dsl.ConstantScoreQuery
_types.query_dsl.DateRangeQuery
_types.Indices
_types.query_dsl.MatchPhraseQuery
_types.query_dsl.FunctionBoostMode
string
indices._types.IndexRoutingRebalanceOptions
string
_types.query_dsl.DateDecayFunction
_types.query_dsl.DecayFunctionBasedoubledouble
object
1 property
security.suggest_user_profiles.Hint
object
2 properties
_types.analysis.TokenChar
string
_types.query_dsl.HasParentQuery
_types.query_dsl.SpanMultiTermQuery
_types.aggregations.StringTermsAggregate
Result of a terms aggregation when the field is a string.
_types.SortOrder
string
security._types.UserProfile
object
5 properties 4 required
_types.analysis.MappingCharFilter
_types.analysis.IndonesianAnalyzer
object
4 properties 1 required
_types.analysis.CharFilterBase
object
1 property
_types.analysis.IrishAnalyzer
object
4 properties 1 required
security._types.RemoteIndicesPrivileges
object
The subset of index level privileges that can be defined for remote clusters.
6 properties 3 required
_types.query_dsl.RankFeatureQuery
security.has_privileges_user_profile.HasPrivilegesUserProfileErrors
object
2 properties 2 required
_types.analysis.PortugueseAnalyzer
object
4 properties 1 required
_types.aggregations.HoltMovingAverageAggregation
indices._types.Storage
object
3 properties 1 required
_types.analysis.DelimitedPayloadTokenFilter
_types.analysis.SynonymTokenFilter
_types.query_dsl.SpanFirstQuery
indices._types.Queries
object
1 property
_types.query_dsl.MatchBoolPrefixQuery
_types.RuleRetriever
_types.analysis.DutchStemTokenFilter
_types.analysis.FinnishAnalyzer
object
4 properties 1 required
indices._types.IndexingSlowlogTresholds
object
1 property
_types.analysis.StopWordLanguage
string
_types.query_dsl.FieldValueFactorModifier
string
_types.aggregations.ValueCountAggregate
Value count aggregation result. value is always present.
_types.GeoHashPrecision
A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m".
security._types.RoleDescriptorRead
object
11 properties 2 required
_types.analysis.FingerprintTokenFilter
_types.analysis.LetterTokenizer
_types.Fields
_types.ulong
number
_types.analysis.IcuTransformDirection
string
_spec_utils.Stringifiedboolean
Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the sema…
_types.query_dsl.SpanNearQuery
_global.search._types.ScoreMode
string
_types.aggregations.PercentageScoreHeuristic
object
_types.analysis.StopTokenFilter
_types.analysis.ThaiTokenizer
_types.analysis.PatternAnalyzer
object
7 properties 1 required
_types.query_dsl.IntervalsFuzzy
object
6 properties 1 required
_types.aggregations.MutualInformationHeuristic
object
2 properties
_types.analysis.IcuFoldingTokenFilter
_types.analysis.HtmlStripCharFilter
_types.aggregations.GeoLineAggregation
object
5 properties 1 required
_types.analysis.PatternReplaceCharFilter
_types.PinnedRetriever
_types.RRFRetrieverComponent
object
Wraps a retriever with an optional weight for RRF scoring.
2 properties 1 required
_types.analysis.PhoneticEncoder
string
_types.analysis.DutchAnalyzer
object
4 properties 1 required
indices._types.SettingsSimilarityScripted
object
3 properties 2 required
indices._types.IndexSettingsLifecycleStep
object
1 property
_types.ScriptField
object
2 properties 1 required
_types.analysis.SnowballAnalyzer
object
4 properties 2 required
_types.analysis.SoraniNormalizationTokenFilter
_types.analysis.FrenchAnalyzer
object
4 properties 1 required
_types.query_dsl.CombinedFieldsOperator
string
_types.aggregations.EwmaMovingAverageAggregation
_types.aggregations.AutoDateHistogramAggregation
_types.analysis.ThaiAnalyzer
object
3 properties 1 required
_types.aggregations.PercentileRanksAggregation
_types.query_dsl.RuleQuery
_types.query_dsl.Operator
string
security._types.RolesStats
object
1 property 1 required
indices._types.MappingLimitSettingsSourceFields
object
1 property 1 required
ml._types.ClassificationInferenceOptions
object
5 properties
_types.analysis.HindiAnalyzer
object
4 properties 1 required
security._types.CreatedStatus
object
1 property 1 required
_types.query_dsl.RankFeatureFunctionLinear
_types.RrfRank
security._types.RoleTemplate
object
2 properties 1 required
_types.aggregations.PipelineAggregationBase
_types.analysis.ApostropheTokenFilter
_types.KnnSearch
object
12 properties 1 required
_types.query_dsl.FunctionScoreQuery
_types.analysis.BasqueAnalyzer
object
4 properties 1 required
indices._types.SlowlogTresholds
object
2 properties
security._types.GlobalPrivilege
object
2 properties 1 required
_types.analysis.EstonianAnalyzer
object
3 properties 1 required
security.query_user.QueryUser
_types.aggregations.DoubleTermsBucket
_types.mapping.CompositeSubField
object
1 property 1 required
_types.analysis.LatvianAnalyzer
object
4 properties 1 required
_types.query_dsl.GeoShapeQuery
_types.analysis.SynonymGraphTokenFilter
indices._types.SearchIdle
object
1 property
_types.aggregations.MovingFunctionAggregation
xpack.usage.SecurityRolesDls
object
1 property 1 required
_types.query_dsl.FieldAndFormat
object
A reference to a field with formatting instructions on how to return the value
3 properties 1 required
_types.GeoHexCell
string
A map hex cell (H3) reference
indices._types.IndexSettingBlocks
object
5 properties
_types.aggregations.BucketsFiltersBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.TopMetricsAggregation
security.get_role.Role
object
11 properties 4 required
_types.analysis.PatternCaptureTokenFilter
_types.GeoHashLocation
object
1 property 1 required
_types.analysis.WordDelimiterTokenFilter
security.authenticate.AuthenticateApiKey
object
4 properties 2 required
_types.Password
string
_types.SortOptions
object
4 properties
_types.aggregations.BoxplotAggregation
indices._types.IndexSettings
object
57 properties
_types.analysis.PredicateTokenFilter
_types.ByteSize
_types.analysis.SwedishAnalyzer
object
4 properties 1 required
_types.aggregations.TermsAggregateBaseDoubleTermsBucket
_types.query_dsl.TermsQuery
security.query_role.QueryRole
_global.search._types.BoundaryScanner
string
_types.ScoreNormalizer
string
security._types.UserProfileHitMetadata
object
2 properties 2 required
_types.analysis.IcuNormalizationCharFilter
_types.aggregations.GeohexGridAggregation
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
indices._types.SettingsQueryString
object
1 property 1 required
_types.analysis.NGramTokenFilter
_types.query_dsl.RankFeatureFunctionSaturation
_types.aggregations.StatsAggregation
_types.analysis.ElisionTokenFilter
_types.analysis.LithuanianAnalyzer
object
4 properties 1 required
_types.GeoDistanceSort
object
6 properties
_types.DateMath
string
security.put_privileges.Actions
object
4 properties 1 required
_types.aggregations.TermsAggregateBaseStringTermsBucket
_types.analysis.KeywordMarkerTokenFilter
security._types.RoleTemplateQuery
object
1 property
security._types.RemoteClusterPrivilege
string
_types.mapping.RuntimeFields
object
security.has_privileges.ApplicationPrivilegesCheck
object
3 properties 3 required
_types.TimeZone
string
_types.analysis.KeywordTokenizer
_types.query_dsl.MatchPhrasePrefixQuery
_types.analysis.KeepTypesMode
string
_types.aggregations.CartesianCentroidAggregation
_types.Embedding
object
3 properties 1 required
_types.analysis.TokenFilter
_types.analysis.CustomAnalyzer
object
6 properties 2 required
_types.analysis.EdgeNGramTokenizer
_types.query_dsl.SpanTermQuery
_types.aggregations.MultiBucketAggregateBaseCompositeBucket
_types.CoordsGeoBounds
object
4 properties 4 required
_types.query_dsl.MultiMatchQuery
_types.analysis.BrazilianStemTokenFilter
_types.InferenceStringGroup
_types.query_dsl.GeoExecution
string
_types.aggregations.MetricAggregationBase
object
3 properties
_types.query_dsl.UntypedDistanceFeatureQuery
_types.Script
object
5 properties
indices._types.SlowlogTresholdLevels
object
4 properties
_types.query_dsl.ChildScoreMode
string
_types.analysis.AsciiFoldingTokenFilter
_types.aggregations.CompositeAggregate
_types.GeoLocation
A latitude/longitude as a 2 dimensional point. It can be represented in various ways: - as a {lat, long} object - as a geo hash value - as a [lon, lat] array -…
_types.aggregations.CompositeAggregationBase
object
6 properties
security.has_privileges.ApplicationsPrivileges
object
indices._types.IndexRouting
object
2 properties
_types.analysis.PersianStemTokenFilter
_types.aggregations.MatrixStatsAggregation
_types.aggregations.TTestAggregation
_types.aggregations.ScriptedHeuristic
object
1 property 1 required
_types.IBDistribution
string
_types.mapping.RuntimeFieldFetchFields
object
2 properties 1 required
_types.aggregations.FrequentItemSetsAggregation
object
5 properties 1 required
security.delete_privileges.FoundStatus
object
1 property 1 required
_types.aggregations.FiltersAggregation
_types.query_dsl.IntervalsAnyOf
object
2 properties 1 required
_types.aggregations.PValueHeuristic
object
2 properties
_types.aggregations.BucketCorrelationAggregation
A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.
_types.analysis.DecimalDigitTokenFilter
_types.GeoTile
string
A map tile reference, represented as {zoom}/{x}/{y}
indices._types.SlowlogSettings
object
4 properties
_types.analysis.TokenFilterDefinition
_types.analysis.ArmenianAnalyzer
object
4 properties 1 required
_global.search._types.HighlighterType
security._types.IndicesPrivilegesQuery
While creating or updating a role you can provide either a JSON structure or a string to the API. However, the response provided by Elasticsearch will only be…
security._types.GrantType
string
_types.WktGeoBounds
object
1 property 1 required
_types.aggregations.ChangePointAggregation
_types.mapping.RuntimeFieldType
string
_types.query_dsl.CombinedFieldsQuery
security._types.SearchAccess
object
4 properties 1 required
_types.TextEmbedding
object
2 properties 1 required
indices._types.IndexSettingsAnalysis
object
5 properties
_types.aggregations.DateRangeAggregate
Result of a daterange aggregation. Same format as a for a range aggregation: from and to in buckets are milliseconds since the Epoch, represented as a floating…
_types.aggregations.LongTermsAggregate
Result of a terms aggregation when the field is some kind of whole number like a integer, long, or a date.
_types.analysis.KuromojiReadingFormTokenFilter
_types.analysis.Normalizer
indices._types.IndexingSlowlogSettings
object
4 properties
security.get_service_credentials.NodesCredentials
object
2 properties 2 required
_types.RescorerRetriever
_types.query_dsl.DistanceFeatureQuery
_types.analysis.ConditionTokenFilter
_types.analysis.WhitespaceAnalyzer
object
2 properties 1 required
_types.aggregations.CartesianBoundsAggregation
_types.GeoBounds
A geo bounding box. It can be represented in various ways: - as 4 top/bottom/left/right coordinates - as 2 topleft / bottomright points - as 2 topright / botto…
_global.search._types.SearchRequestBody
object
34 properties
_types.analysis.HungarianAnalyzer
object
4 properties 1 required
security._types.BulkError
object
2 properties 2 required
_types.analysis.IcuCollationTokenFilter
_types.aggregations.FiltersAggregate
_types.TopLeftBottomRightGeoBounds
object
2 properties 2 required
_types.query_dsl.IntervalsQuery
_types.NestedSortValue
object
4 properties 1 required
_types.query_dsl.RankFeatureFunction
object
_global.search._types.SourceFilter
object
3 properties
security.get_role.IndicesPrivilegesRead
object
Read-side variant of IndicesPrivileges returned by the get role API. Carries the implicitlygranted marker that is set on entries contributed by a registered Im…
6 properties 2 required
_types.QueryVectorBuilder
object
3 properties
_types.query_dsl.SpanNotQuery
_types.analysis.NoriTokenizer
_types.analysis.IcuNormalizationType
string
security.enroll_kibana.Token
object
2 properties 2 required
indices._types.IndexRoutingRebalance
object
1 property 1 required
_types.aggregations.MovingAverageAggregationBase
_types.Ids
_types.query_dsl.RegexpQuery
_types.aggregations.FieldDateMath
A date range limit, represented either as a DateMath expression or a number expressed according to the target field's precision.
_types.DiversifyRetrieverTypes
string
_types.Metadata
object
_types.analysis.FingerprintAnalyzer
object
6 properties 1 required
_types.aggregations.AverageAggregation
_types.GeoDistanceType
string
_types.TokenPruningConfig
object
3 properties
_types.TopRightBottomLeftGeoBounds
object
2 properties 2 required
indices._types.SettingsSimilarityLmj
object
2 properties 1 required
_types.query_dsl.QueryBase
object
2 properties
_types.analysis.PhoneticLanguage
string
_types.query_dsl.PercolateQuery
_types.query_dsl.IntervalsWildcard
object
3 properties 1 required
_types.aggregations.TermsExclude
_types.SequenceNumber
number
_types.query_dsl.WrapperQuery
_types.query_dsl.FieldValueFactorScoreFunction
object
4 properties 1 required
_types.analysis.PatternTokenizer
_types.aggregations.TermsAggregationExecutionHint
string
security._types.RoleMapping
object
5 properties 3 required
_types.analysis.NoriPartOfSpeechTokenFilter
_types.analysis.RomanianAnalyzer
object
4 properties 1 required
_types.analysis.CzechAnalyzer
object
4 properties 1 required
_types.aggregations.BucketsRangeBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.analysis.TokenizerBase
object
1 property
_types.aggregations.SerialDifferencingAggregation
_types.query_dsl.QueryContainer
object
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
61 properties
security.query_user.UserQueryContainer
object
11 properties
_types.analysis.HindiNormalizationTokenFilter
_types.aggregations.MinimumInterval
string
security._types.DataSourcePrivilege
_types.ScoreSort
object
1 property
indices._types.MappingLimitSettingsDepth
object
1 property
_types.aggregations.BucketSortAggregation
_types.query_dsl.CommonTermsQuery
_spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag
A set of flags that can be represented as a single enum value or a set of values that are encoded as a pipe-separated string Depending on the target language,…
_types.aggregations.BucketsApiKeyQueryContainer
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.KnnQuery
_types.Fuzziness
_types.analysis.JaStopTokenFilter
_types.EmptyObject
object
For empty Class assignments
_types.SortMode
string
_types.query_dsl.PinnedDoc
object
2 properties 1 required
indices._types.StorageType
security._types.ApplicationGlobalUserPrivileges
object
1 property 1 required
_types.analysis.ArabicStemTokenFilter
_global.search._types.Rescore
security.authenticate.Token
object
3 properties
_types.QueryVector
array
_types.aggregations.BucketsQueryContainer
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.query_dsl.DistanceFeatureQueryBase
_types.Name
string
_types.aggregations.SumBucketAggregation
_types.aggregations.Missing
_types.aggregations.DateHistogramAggregation
_types.query_dsl.RangeQueryBasedouble
indices._types.MappingLimitSettingsDimensionFields
object
1 property
_types.aggregations.MultiTermsBucket
_types.aggregations.TermsBucketBase
xpack.usage.SecurityRolesDlsBitSetCache
object
8 properties 7 required
_types.query_dsl.IdsQuery
_types.query_dsl.BoostingQuery
_global.search._types.HighlighterEncoder
string
_types.query_dsl.QueryStringQuery
security.query_api_keys.ApiKeyAggregationContainer
security.has_privileges.IndexPrivilegesCheck
object
3 properties 2 required
_types.query_dsl.SpanWithinQuery
indices._types.CacheQueries
object
1 property 1 required
_types.MultiTermQueryRewrite
string
_types.analysis.RussianStemTokenFilter
_types.aggregations.WeightedAverageValue
object
3 properties
indices._types.MergeScheduler
object
2 properties
_types.query_dsl.IntervalsRegexp
object
3 properties 1 required
_types.analysis.KeywordAnalyzer
object
2 properties 1 required
indices._types.IndexingPressure
object
1 property 1 required
_types.query_dsl.DecayFunctionBaseDateMathDuration
object
1 property
_types.analysis.KeywordRepeatTokenFilter
_types.analysis.BrazilianAnalyzer
object
3 properties 1 required
security._types.Access
object
2 properties
_types.aggregations.DoubleTermsAggregate
Result of a terms aggregation when the field is some kind of decimal number like a float, double, or distance.
_types.analysis.LowercaseNormalizer
object
1 property 1 required
_types.analysis.WhitespaceTokenizer
_global.search._types.InnerHits
object
17 properties
_types.query_dsl.SpanQuery
object
10 properties
indices._types.IndexRoutingAllocationDisk
object
1 property
_types.aggregations.TDigestExecutionHint
string
security._types.ApplicationPrivileges
object
3 properties 3 required
_global.search._types.RescoreQuery
object
4 properties 1 required
_types.aggregations.MissingOrder
string
_types.ScriptLanguage
ssl.certificates.CertificateInformation
object
8 properties 7 required
_types.query_dsl.SpanGapQuery
object
Can only be used as a clause in a spannear query.
_types.analysis.WordDelimiterTokenFilterBase
_types.query_dsl.ExistsQuery
_types.analysis.EnglishAnalyzer
object
4 properties 1 required
_types.RankBase
object
_types.analysis.SynonymFormat
string
_types.RetrieverContainer
object
9 properties
_types.analysis.SpanishAnalyzer
object
4 properties 1 required
_types.VersionString
string
_types.query_dsl.ParentIdQuery
indices._types.IndexSettingsTimeSeries
object
3 properties
_types.analysis.FrenchStemTokenFilter
_types.analysis.KeepTypesTokenFilter
_types.RelationName
string
_types.query_dsl.GeoPolygonQuery
_spec_utils.Void
object
The absence of any type. This is commonly used in APIs that don't return a body. Although "void" is generally used for the unit type that has only one value, t…
_types.query_dsl.MatchAllQuery
_types.analysis.NoriAnalyzer
object
5 properties 1 required
_types.KnnRetriever
_types.analysis.TurkishAnalyzer
object
4 properties 1 required
_types.aggregations.TermsAggregateBaseLongTermsBucket
_types.mapping.ChunkRescorerChunkingSettings
object
6 properties 1 required
_types.aggregations.IpPrefixAggregation
_types.analysis.IcuCollationCaseFirst
string
security._types.ReplicationAccess
object
2 properties 1 required
_types.analysis.SnowballTokenFilter
_types.aggregations.MissingAggregation
_types.aggregations.MaxAggregation
_types.analysis.PhoneticRuleType
string
indices._types.SettingsHighlight
object
1 property
_types.analysis.UniqueTokenFilter
_types.aggregations.BucketKsAggregation
A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred to as a "K-S test" from now on) against a provided distribution, a…
_types.KnnEmbeddingInput
Knn embedding input. Either a string, an object or array of objects
_types.RRFRetriever
_types.InferenceString
object
3 properties 2 required
_global.search._types.HighlightField
_types.aggregations.SumAggregation
_types.aggregations.ExtendedStatsAggregation
_types.analysis.SynonymTokenFilterBase
_types.analysis.KuromojiStemmerTokenFilter
security.grant_api_key.GrantApiKey
object
4 properties 1 required
_global.search._types.LearningToRank
object
2 properties 1 required
indices._types.SourceMode
string
_types.ScriptSortType
string
indices._types.IndexSettingsLifecycle
object
7 properties
_types.query_dsl.IntervalsContainer
object
8 properties
indices._types.SegmentSortMissing
string
ml._types.RegressionInferenceOptions
object
2 properties
_types.mapping.RuntimeField
object
9 properties 1 required
indices._types.SettingsSimilarityIb
object
4 properties 4 required
_types.DFIIndependenceMeasure
string
_types.query_dsl.RandomScoreFunction
object
2 properties
_types.aggregations.MedianAbsoluteDeviationAggregation
_types.query_dsl.LikeDocument
object
8 properties
_types.aggregations.RangeAggregation
_types.analysis.IcuCollationStrength
string
_types.analysis.GermanStemTokenFilter
_types.analysis.CharFilter
_types.analysis.TruncateTokenFilter
_types.analysis.LimitTokenCountTokenFilter
_types.aggregations.TermsAggregateBaseMultiTermsBucket
_types.analysis.GermanAnalyzer
object
4 properties 1 required
_types.aggregations.SamplerAggregation
_types.query_dsl.PinnedQuery
_global.search._types.HighlighterTagsSchema
string
_types.aggregations.FiltersBucket
_types.aggregations.IpRangeAggregationRange
object
3 properties
_types.ScriptSort
object
5 properties 1 required
_types.query_dsl.FunctionScoreContainer
_types.analysis.StopAnalyzer
object
4 properties 1 required
_types.aggregations.HoltWintersType
string
_types.aggregations.MultiTermsAggregate
_types.aggregations.RangeBucket
_types.aggregations.TermsAggregateBaseVoid
_types.analysis.GalicianAnalyzer
object
4 properties 1 required
_types.analysis.IcuTokenizer
inference._types.EmbeddingContentFormat
string
_types.aggregations.RangeAggregate
_types.analysis.WordDelimiterGraphTokenFilter
_types.query_dsl.IntervalsAllOf
object
4 properties 1 required
_types.aggregations.RandomSamplerAggregation
_types.query_dsl.ShapeQuery
_types.analysis.CatalanAnalyzer
object
4 properties 1 required
indices._types.Translog
object
4 properties
_types.analysis.PersianAnalyzer
object
3 properties 1 required
_types.aggregations.NormalizeAggregation
_types.analysis.CjkBigramTokenFilter
_types.analysis.CharFilterDefinition
_types.aggregations.MovingAverageAggregation
_types.query_dsl.SimpleQueryStringFlags
Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX
security._types.UserProfileUser
object
6 properties 3 required
_types.Names
_types.aggregations.CompositeDateHistogramAggregation
security.get_service_credentials.NodesCredentialsFileToken
object
1 property 1 required
_types.analysis.CharGroupTokenizer
_types.aggregations.BucketsDoubleTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.UnmappedTermsAggregate
Result of a terms aggregation when the field is unmapped. buckets is always empty.
_types.aggregations.CardinalityAggregation
_types.query_dsl.RangeRelation
string
_types.analysis.KuromojiTokenizer
_types.analysis.KuromojiTokenizationMode
string
_types.analysis.NGramTokenizer
_types.analysis.StemmerTokenFilter
security._types.ClusterPrivilege
_types.analysis.CommonGramsTokenFilter
_types.query_dsl.DecayFunction
_types.query_dsl.PrefixQuery
_types.analysis.IcuCollationDecomposition
string
_global.search._types.SourceConfig
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
_global.search._types.HighlightBase
object
21 properties
_types.DurationLarge
string
A date histogram interval. Similar to Duration with additional units: w (week), M (month), q (quarter) and y (year)
_spec_utils.StringifiedEpochTimeUnitMillis
Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the sema…
_types.LatLonGeoLocation
object
2 properties 2 required
_types.analysis.UaxEmailUrlTokenizer
_types.aggregations.PercentilesAggregation
_types.aggregations.NormalizeMethod
string
_types.analysis.IcuNormalizationTokenFilter
_types.aggregations.FilterAggregate
_types.aggregations.VariableWidthHistogramAggregation
object
5 properties
_types.aggregations.RateAggregation
_types.aggregations.CategorizeTextAggregation
A multi-bucket aggregation that groups semi-structured text into buckets. Each text field is re-analyzed using a custom analyzer. The resulting tokens are then…
security._types.FieldSecurity
object
2 properties
_types.query_dsl.IntervalsFilter
object
9 properties
_types.aggregations.TestPopulation
object
3 properties 1 required
_types.aggregations.CustomCategorizeTextAnalyzer
object
3 properties
security._types.NodeSecurityStats
object
1 property 1 required
security._types.ClusterNode
object
1 property 1 required
_types.aggregations.StringTermsBucket
_types.aggregations.MultiTermsAggregation
_global.search._types.Highlight
_types.query_dsl.SpanFieldMaskingQuery
_types.analysis.ShingleTokenFilter
security.grant_api_key.ApiKeyGrantType
string
security._types.RoleTemplateScript
object
5 properties
indices._types.TranslogDurability
string
security.has_privileges.ResourcePrivileges
object
_types.aggregations.GeoLinePoint
object
1 property 1 required
_types.aggregations.AdjacencyMatrixAggregation
_types.query_dsl.ScriptQuery
_types.query_dsl.RangeQueryBaseDateMath
indices._types.MappingLimitSettingsTotalFields
object
2 properties
indices._types.Merge
object
1 property
indices._types.IndexSettingsUnassignedNodeLeft
object
1 property
_types.query_dsl.RangeQuery
_types.Distance
string
security.delegate_pki.Authentication
object
11 properties 9 required
_types.aggregations.TopMetricsValue
object
1 property 1 required
_types.Service
string
_types.aggregations.CumulativeSumAggregation
security.delegate_pki.AuthenticationRealm
object
3 properties 2 required
_types.analysis.Analyzer
_types.DurationValueUnitMillis
security._types.RemoteClusterPrivileges
object
The subset of cluster level privileges that can be defined for remote clusters.
2 properties 2 required
_types.aggregations.GeoTileGridAggregation
_types.analysis.TokenFilterBase
object
1 property
_types.query_dsl.DecayFunctionBase
object
1 property
_types.query_dsl.GeoDistanceFeatureQuery
_types.analysis.ArabicNormalizationTokenFilter
_global.search._types.HighlighterFragmenter
string
_types.analysis.BengaliAnalyzer
object
4 properties 1 required
security._types.User
object
7 properties 4 required
_types.FieldValue
A field value.
_types.RankContainer
object
1 property
_types.query_dsl.IntervalsPrefix
object
3 properties 1 required
indices._types.SegmentSortOrder
string
_types.aggregations.BucketAggregationBase
Base type for bucket aggregations. These aggregations also accept sub-aggregations.
security.suggest_user_profiles.TotalUserProfiles
object
2 properties 2 required
_types.aggregations.ChiSquareHeuristic
object
2 properties 2 required
security._types.DataSourcePrivileges
object
2 properties 2 required
_global.search._types.PointInTimeReference
object
2 properties 1 required
_types.PipelineName
string
_types.analysis.LowercaseTokenizer
_types.query_dsl.MoreLikeThisQuery
indices._types.IndexRoutingAllocationOptions
string
_types.aggregations.CompositeTermsAggregation
_types.query_dsl.RankFeatureFunctionSigmoid
_types.RescoreVector
object
1 property 1 required
_types.aggregations.TermsAggregationCollectMode
string
_types.analysis.NoriDecompoundMode
string
_types.aggregations.WeightedAverageAggregation
_types.AcknowledgedResponseBase
object
1 property 1 required
security.has_privileges_user_profile.PrivilegesCheck
object
3 properties
_types.query_dsl.Like
Text that we want similar documents for or a lookup to a document's field for the text.
_types.RRFRetrieverEntry
Either a direct RetrieverContainer (backward compatible) or an RRFRetrieverComponent with weight.
_types.aggregations.AggregationContainer
_types.analysis.SnowballLanguage
string
_types.MinimumShouldMatch
The minimum number of terms that should match as integer, percentage or range
_types.aggregations.FrequentItemSetsField
object
3 properties 1 required
_types.aggregations.CategorizeTextAnalyzer
_types.query_dsl.ScriptScoreQuery
_types.Username
string
_types.aggregations.ReverseNestedAggregation
_types.NodeStatistics
object
Contains statistics about the number of nodes selected by the request.
4 properties 3 required
_types.analysis.Tokenizer
_types.aggregations.GeoHashGridAggregation
_types.query_dsl.NestedQuery
_types.query_dsl.TermQuery
indices._types.IndexRoutingAllocationInclude
object
2 properties
_types.analysis.StandardTokenizer
_types.aggregations.EwmaModelSettings
object
1 property
_types.aggregations.FormatMetricAggregationBase
_types.aggregations.ExtendedBoundsFieldDateMath
object
2 properties
_types.query_dsl.GeoGridQuery
_types.DistanceUnit
string
_types.query_dsl.NumberRangeQuery
_types.aggregations.AverageBucketAggregation
_types.aggregations.CardinalityExecutionMode
string
security._types.ApiKeyType
string
security._types.IndexPrivilege
_types.aggregations.RateMode
string
_types.aggregations.CompositeGeoTileGridAggregation
_types.analysis.BengaliNormalizationTokenFilter
_types.aggregations.DerivativeAggregation
_types.aggregations.LongTermsBucket
_types.aggregations.CompositeHistogramAggregation
indices._types.IndexRoutingAllocation
object
4 properties
_types.aggregations.BucketsStringTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.MultiBucketAggregateBaseLongTermsBucket
_types.aggregations.HdrMethod
object
1 property
_types.analysis.CjkWidthTokenFilter
_types.VersionNumber
number
_global.search._types.TrackHits
Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response do…
_types.query_dsl.FunctionScoreMode
string
indices._types.IndexCheckOnStartup
string
_types.analysis.ReverseTokenFilter
security.create_service_token.Token
object
2 properties 2 required
_types.aggregations.BucketsVoid
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.query_dsl.GeoValidationMethod
string
_types.DFRBasicModel
string
_types.aggregations.BucketCorrelationFunctionCountCorrelation
object
1 property 1 required
_types.analysis.IcuAnalyzer
object
3 properties 3 required
indices._types.IndexRoutingAllocationInitialRecovery
object
1 property
_types.query_dsl.LongNumberRangeQuery
indices._types.IndexVersioning
object
2 properties
_types.analysis.ClassicTokenizer
security.get_token.AccessTokenGrantType
string
_types.Duration
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indica…
_spec_utils.Stringifiedinteger
Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the sema…
_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration
indices._types.SettingsSimilarityBm25
object
4 properties 1 required
_types.query_dsl.TermRangeQuery
_types.aggregations.DateRangeExpression
object
3 properties
_types.aggregations.BucketsCompositeBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.aggregations.ValueType
string
indices._types.SettingsAnalyze
object
1 property
_global.search._types.Suggester
object
1 property
security._types.ApiKey
object
17 properties 8 required
_types.aggregations.GeoBoundsAggregation
_types.analysis.SerbianNormalizationTokenFilter
_types.LinearRetriever
_types.analysis.CzechStemTokenFilter
_types.analysis.LowercaseTokenFilterLanguages
string
security.get_token.UserRealm
object
2 properties 2 required
security._types.SecuritySettings
object
1 property
_types.LookupQueryVectorBuilder
object
4 properties 3 required
_types.query_dsl.MatchNoneQuery
_types.query_dsl.UntypedDecayFunction
_types.aggregations.SimpleMovingAverageAggregation
_types.mapping.OnScriptError
string
_types.query_dsl.ZeroTermsQuery
string
_types.analysis.GreekAnalyzer
object
3 properties 1 required
_types.RetrieverBase
object
3 properties
_spec_utils.NullValue
stringnull
A null value that is to be interpreted as an actual value, unless other uses of null that are equivalent to a missing value. It is used for exemple in settings…
_types.aggregations.TDigest
object
2 properties
_types.analysis.GermanNormalizationTokenFilter
_types.VersionType
string
security._types.RoleDescriptor
object
11 properties
_types.analysis.ItalianAnalyzer
object
4 properties 1 required
indices._types.SettingsSimilarityLmd
object
2 properties 1 required
security._types.UserProfileId
string
_types.Namespace
string
_types.StandardRetriever
_types.aggregations.GeoDistanceAggregation
_types.aggregations.RareTermsAggregation
_types.aggregations.ExtendedBoundsdouble
object
2 properties
security.get_token.AuthenticationProvider
object
2 properties 2 required
_types.aggregations.BucketScriptAggregation
indices._types.MappingLimitSettings
object
Mapping Limit Settings
9 properties
_types.aggregations.TermsInclude
_types.aggregations.LinearMovingAverageAggregation
indices._types.SettingsSimilarity
security.has_privileges.Privileges
object
_types.aggregations.ValueCountAggregation
_types.analysis.EdgeNGramSide
string
_types.query_dsl.HasChildQuery
_types.analysis.ScandinavianFoldingTokenFilter
_types.query_dsl.DateDistanceFeatureQuery
indices._types.SettingsSearch
object
2 properties
security._types.RoleMappingRule
object
4 properties
_types.aggregations.CardinalityAggregate
_types.aggregations.GlobalAggregation
_types.aggregations.Aggregation
object
_types.analysis.StandardAnalyzer
object
4 properties 1 required
_types.analysis.LowercaseTokenFilter
_types.query_dsl.SpanOrQuery
_types.aggregations.TimeSeriesAggregation
security._types.UserProfileWithMetadata
_types.query_dsl.BoolQuery
_types.SpecifiedDocument
object
2 properties 1 required
security.query_api_keys.ApiKeyQueryContainer
object
11 properties
_types.query_dsl.SimpleQueryStringQuery
_types.aggregations.AggregateBase
object
1 property
indices._types.IndexingPressureMemory
object
1 property
_types.aggregations.InferenceConfigContainer
object
2 properties
_types.SortCombinations
_types.aggregations.GapPolicy
string
_types.analysis.LengthTokenFilter
_types.analysis.FlattenGraphTokenFilter
_types.aggregations.CompositeBucket
_types.analysis.PatternReplaceTokenFilter
_types.query_dsl.RangeQueryBasestring
_types.query_dsl.ScriptScoreFunction
object
1 property 1 required
_types.aggregations.DiversifiedSamplerAggregation
_types.aggregations.NestedAggregation
_types.analysis.CjkBigramIgnoredScript
string
indices._types.IndexSegmentSort
object
4 properties
_types.aggregations.CalendarInterval
string
_types.ScriptSource
_types.analysis.KeepWordsTokenFilter
_types.analysis.NorwegianAnalyzer
object
4 properties 1 required
_types.Refresh
string
_types.aggregations.CompositeAggregateKey
object
_types.Normalization
string
_types.analysis.RemoveDuplicatesTokenFilter
_types.query_dsl.MatchQuery
_types.aggregations.CumulativeCardinalityAggregation
_types.analysis.EdgeNGramTokenFilter
indices._types.SettingsSimilarityDfi
object
2 properties 2 required
_types.DFRAfterEffect
string
_types.query_dsl.SimpleQueryStringFlag
string
_types.query_dsl.WeightedTokensQuery
security._types.RoleTemplateInlineQuery
_types.Routing
Only to be used in query and path parameters, as the array form is actually a csv
_types.aggregations.BucketsPath
Buckets path can be expressed in different ways, and an aggregation may accept some or all of these forms depending on its type. Please refer to each aggregati…
_types.aggregations.MinBucketAggregation
_types.analysis.RussianAnalyzer
object
4 properties 1 required
indices._types.MappingLimitSettingsNestedObjects
object
1 property
_types.aggregations.GeoCentroidAggregation
_types.query_dsl.IntervalsRange
object
6 properties
_types.analysis.PathHierarchyTokenizer
_global.search._types.ScriptRescore
object
1 property 1 required
_types.analysis.ChineseAnalyzer
object
3 properties 1 required
_types.query_dsl.RankFeatureFunctionLogarithm
_types.query_dsl.GeoDistanceQuery
_types.analysis.SerbianAnalyzer
object
4 properties 1 required
_types.query_dsl.GeoDecayFunction
_types.aggregations.BucketCorrelationFunction
object
1 property 1 required
_types.analysis.PorterStemTokenFilter
_types.analysis.IcuTransformTokenFilter
_types.analysis.PhoneticTokenFilter
_types.aggregations.BucketsLongTermsBucket
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_types.IBLambda
string
_types.query_dsl.IntervalsMatch
object
6 properties 1 required
_types.aggregations.PercentilesBucketAggregation
_types.ChunkRescorer
object
2 properties
_types.analysis.SoraniAnalyzer
object
4 properties 1 required
inference._types.EmbeddingContentType
string
_types.aggregations.IpRangeAggregation
_types.analysis.KStemTokenFilter
_types.aggregations.AggregateOrder
security.get_user_profile.GetUserProfileErrors
object
2 properties 2 required
_types.aggregations.MinAggregation
_types.aggregations.CompositeAggregationSource
object
4 properties
_types.ErrorCause
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 th…
6 properties 1 required
_types.aggregations.HoltLinearModelSettings
object
2 properties
indices._types.MappingLimitSettingsNestedFields
object
1 property
_types.aggregations.MultiBucketAggregateBaseFiltersBucket
_types.UnitMillis
number
Time unit for milliseconds
_types.aggregations.MultiBucketAggregateBaseVoid
security.query_api_keys.ApiKeyAggregate
Kibana_HTTP_APIs_security_role_response
object
A Kibana role definition returned by the Roles API.
8 properties 3 required
Kibana_HTTP_APIs_security_role_kibana_application
object
A raw Elasticsearch application privilege entry tied to Kibana.
3 properties 3 required
Kibana_HTTP_APIs_security_query_roles_response
object
The response payload for a roles query.
3 properties 3 required
Kibana_HTTP_APIs_security_role_remote_indices_privileges
object
The remote indices privileges entry.
6 properties 3 required
Kibana_HTTP_APIs_security_role_elasticsearch
object
The Elasticsearch cluster, index, and remote cluster security privileges for the role.
5 properties
Kibana_HTTP_APIs_security_role_transform_error
object
Diagnostic information about a role whose Kibana privileges could not be transformed.
2 properties 1 required
Kibana_HTTP_APIs_security_query_roles_filters
object
The filter criteria for the query.
1 property
Kibana_HTTP_APIs_security_role_kibana_privilege_response
object
A Kibana privilege entry returned for a role.
4 properties 3 required
Kibana_HTTP_APIs_security_query_roles_sort
object
The sort criteria for the query.
2 properties 2 required
Kibana_HTTP_APIs_security_role_remote_cluster_privileges
object
The remote cluster privileges entry.
2 properties 2 required
Kibana_HTTP_APIs_security_role_indices_privileges
object
The indices privileges entry.
5 properties 2 required
Kibana_HTTP_APIs_security_query_roles_body
object
The request body for querying roles.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-security-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
AE Profile APIs.io
Elastic Stack (ELK Stack) Accounts API
AE Profile APIs.io
Elastic Stack (ELK Stack) Actions API
AE Profile APIs.io
Elastic Stack (ELK Stack) agent builder API
AE Profile APIs.io
Elastic Stack (ELK Stack) Alerting API
AE Profile APIs.io
Elastic Stack (ELK Stack) Alerting V2 API
AE Profile APIs.io
Elastic Stack (ELK Stack) Analytics API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM agent configuration API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM agent keys API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM annotations API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM server schema API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM sourcemaps API
AE Profile APIs.io
#Security
← Back to E APIs
API Details
ID
elk-stack:elk-stack-security-api
Base URL
https://{elasticsearch_endpoint}
Docs
https://www.elastic.co/docs/api/doc/elasticsearch/
Provider
Elastic Stack (ELK Stack)
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=elk-stack-security-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/elk-stack-security-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) Security API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.