Elastic Stack (ELK Stack) Xpack API is one of 133 APIs that Elastic Stack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include xpack. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
2 operations
across 2 paths,
and defines 98 schemas.
It is described by OpenAPI 3.2.0.
Requests are made against the base URL https://{elasticsearch_endpoint}.
The identity and technical contract details declared by the specification.
xpack.usage.MlInferenceDeployments
object
4 properties
4 required
xpack.usage.SearchableSnapshots
xpack.usage.MlInference
object
3 properties
2 required
slm._types.Statistics
object
10 properties
xpack.usage.DataStreamLifecycleEffectiveRetentionStats
xpack.info.Feature
object
4 properties
2 required
xpack.usage.EqlFeaturesPipes
object
2 properties
2 required
xpack.usage.GpuNodeStats
object
Per-node GPU statistics for vector indexing.
4 properties
4 required
xpack.usage.Base
object
2 properties
2 required
xpack.info.MinimalLicenseInformation
object
5 properties
5 required
xpack.usage.IpFilter
object
2 properties
2 required
xpack.usage.FeatureToggle
object
1 property
1 required
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
xpack.usage.QueryLoggingConfig
object
4 properties
3 required
xpack.usage.Query
object
4 properties
xpack.usage.MlInferenceIngestProcessor
object
4 properties
4 required
xpack.usage.MlInferenceDeploymentsTimeMs
object
1 property
1 required
xpack.usage.WatcherActions
object
1 property
1 required
xpack.usage.MlJobForecasts
object
2 properties
2 required
xpack.info.XPackCategory
string
_types.EpochTimeUnitMillis
xpack.info.NativeCodeInformation
object
2 properties
2 required
xpack.usage.MlDataFrameAnalyticsJobsMemory
object
1 property
1 required
xpack.usage.RoleMapping
object
2 properties
2 required
xpack.usage.DataTierPhaseStatistics
object
10 properties
10 required
xpack.usage.DataStreamLifecycleThresholdStats
object
The minimummillis, maximummillis, and averagemillis fields are only present when at least one data stream contributes to these statistics.
3 properties
xpack.usage.EsqlLoggingConfig
object
3 properties
2 required
_types.VersionString
string
_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…
xpack.usage.SecurityRolesNative
object
3 properties
3 required
xpack.usage.RuntimeFieldsType
object
14 properties
14 required
xpack.usage.SecurityRoles
object
3 properties
3 required
_types.UnitMillis
number
Time unit for milliseconds
xpack.usage.DataStreamLifecycleGlobalRetentionStats
object
The affecteddatastreams and retentionmillis fields are only present when this global retention is defined.
3 properties
1 required
xpack.usage.MlDataFrameAnalyticsJobs
object
4 properties
1 required
xpack.usage.MlDataFrameAnalyticsJobsCount
object
1 property
1 required
xpack.usage.EqlFeaturesJoin
object
5 properties
5 required
xpack.usage.AnalyticsStatistics
object
9 properties
8 required
xpack.usage.JobUsage
object
5 properties
5 required
xpack.usage.MlInferenceIngestProcessorCount
object
3 properties
3 required
xpack.usage.RuntimeFieldTypes
xpack.usage.SecurityRolesDlsBitSetCache
object
8 properties
7 required
xpack.usage.WatcherWatchTriggerSchedule
_types.DurationValueUnitMillis
xpack.usage.SecurityRolesDls
object
1 property
1 required
xpack.usage.MlInferenceTrainedModelsCount
object
8 properties
3 required
xpack.usage.RealmCache
object
1 property
1 required
xpack.usage.VectorDbDocument
Usage statistics for indices using the vectordbdocument index mode.
license._types.LicenseStatus
string
xpack.usage.SecurityRolesFile
object
3 properties
3 required
xpack.usage.MachineLearning
xpack.usage.MlDataFrameAnalyticsJobsAnalysis
object
3 properties
xpack.info.Features
object
28 properties
27 required
xpack.usage.GpuVectorIndexing
GPU vector indexing usage statistics.
xpack.usage.IlmPolicyStatistics
object
2 properties
2 required
xpack.info.BuildInformation
object
2 properties
2 required
xpack.usage.DataStreamLifecycleRetentionStats
xpack.usage.Ilm
object
2 properties
2 required
xpack.usage.Datafeed
object
1 property
1 required
xpack.usage.EqlFeaturesSequences
object
6 properties
6 required
xpack.usage.EqlFeatures
object
7 properties
7 required
license._types.LicenseType
string
xpack.usage.DataStreamLifecycleGlobalRetention
object
2 properties
2 required
xpack.usage.Phase
object
2 properties
2 required
xpack.usage.Counter
object
2 properties
2 required
xpack.usage.EqlFeaturesKeys
object
5 properties
5 required
xpack.usage.WatcherActionTotals
object
2 properties
2 required
ml._types.JobStatistics
object
4 properties
4 required
xpack.usage.MlInferenceTrainedModels
object
5 properties
1 required
xpack.usage.MlCounter
object
1 property
1 required
xpack.usage.HealthStatistics
xpack.usage.Invocations
object
1 property
1 required
_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…
xpack.usage.DataStreamLifecycleUsage
Usage statistics for data stream lifecycle (DLM), reported by xpack/usage under datalifecycle. Besides available and enabled, all the following statistics are…
xpack.usage.Ssl
object
2 properties
2 required
xpack.usage.Phases
object
5 properties
xpack.usage.Logging
object
Usage statistics about logging configuration reported by xpack/usage.
2 properties
2 required
xpack.usage.WatcherWatch
object
4 properties
2 required
xpack.usage.WatcherWatchTrigger
object
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Elastic Stack publishes across the network.
