openapi: 3.2.0 info: title: Elasticsearch Xpack API description: 'Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features. ## Documentation source and versions This documentation is derived from the main branch of the elasticsearch-specification repository. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International. This documentation contains work-in-progress information for future Elastic Stack releases.' license: name: Apache 2.0 url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE version: '' security: - apiKeyAuth: [] - basicAuth: [] - bearerAuth: [] tags: - name: xpack description: The usage API provides usage information about the installed X-Pack features. x-displayName: Usage paths: /_xpack: get: tags: - xpack summary: Get information description: 'The information provided by the API includes: * Build information including the build number and timestamp. * License information about the currently installed license. * Feature information for the features that are currently enabled and available under the current license.' operationId: xpack-info parameters: - in: query name: categories description: 'A comma-separated list of the information categories to include in the response. For example, `build,license,features`.' deprecated: false schema: type: array items: $ref: '#/components/schemas/xpack.info.XPackCategory' style: form - in: query name: accept_enterprise description: If used, this otherwise ignored parameter must be set to true deprecated: true schema: type: boolean style: form - in: query name: human description: 'Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line.' deprecated: false schema: type: boolean style: form responses: '200': description: '' content: application/json: schema: type: object properties: build: allOf: - $ref: '#/components/schemas/xpack.info.BuildInformation' features: allOf: - $ref: '#/components/schemas/xpack.info.Features' license: allOf: - $ref: '#/components/schemas/xpack.info.MinimalLicenseInformation' tagline: type: string required: - build - features - license - tagline examples: XPackInfoResponseExample1: description: A successful response from `GET /_xpack`. value: "{\n \"build\" : {\n \"hash\" : \"2798b1a3ce779b3611bb53a0082d4d741e4d3168\",\n \"date\" : \"2015-04-07T13:34:42Z\"\n },\n \"license\" : {\n \"uid\" : \"893361dc-9749-4997-93cb-xxx\",\n \"type\" : \"trial\",\n \"mode\" : \"trial\",\n \"status\" : \"active\",\n \"expiry_date_in_millis\" : 1542665112332\n },\n \"features\" : {\n \"ccr\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"aggregate_metric\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"analytics\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"archive\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"enrich\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"graph\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ilm\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"logstash\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ml\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"esql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"monitoring\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"rollup\": {\n \"available\": true,\n \"enabled\": true\n },\n \"searchable_snapshots\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"security\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"slm\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"spatial\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"eql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"sql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"transform\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"voting_only\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"watcher\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"data_streams\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"data_tiers\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"enterprise_search\": {\n \"available\": true,\n \"enabled\": true\n },\n \"universal_profiling\": {\n \"available\": true,\n \"enabled\": true\n },\n \"logsdb\": {\n \"available\": true,\n \"enabled\": false\n }\n },\n \"tagline\" : \"You know, for X\"\n}" x-state: Generally available x-variations: - "
\n GET\n /_xpack\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: info.xpack x-category: info x-codeSamples: - lang: Console source: 'GET /_xpack ' - lang: Python source: resp = client.xpack.info() - lang: JavaScript source: const response = await client.xpack.info(); - lang: Ruby source: response = client.xpack.info - lang: PHP source: $resp = $client->xpack()->info(); - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_xpack"' - lang: Java source: 'client.xpack().info(i -> i); ' x-metaTags: - content: Elasticsearch name: product_name /_xpack/usage: get: tags: - xpack summary: Get usage information description: 'Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics.' operationId: xpack-usage parameters: - in: query name: master_timeout description: 'The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`.' deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: object properties: aggregate_metric: allOf: - $ref: '#/components/schemas/xpack.usage.Base' analytics: allOf: - $ref: '#/components/schemas/xpack.usage.Analytics' archive: x-state: Generally available; Added in 8.2.0 allOf: - $ref: '#/components/schemas/xpack.usage.Archive' watcher: allOf: - $ref: '#/components/schemas/xpack.usage.Watcher' ccr: allOf: - $ref: '#/components/schemas/xpack.usage.Ccr' data_frame: allOf: - $ref: '#/components/schemas/xpack.usage.Base' data_science: allOf: - $ref: '#/components/schemas/xpack.usage.Base' data_streams: allOf: - $ref: '#/components/schemas/xpack.usage.DataStreams' data_tiers: allOf: - $ref: '#/components/schemas/xpack.usage.DataTiers' enrich: allOf: - $ref: '#/components/schemas/xpack.usage.Base' eql: allOf: - $ref: '#/components/schemas/xpack.usage.Eql' flattened: allOf: - $ref: '#/components/schemas/xpack.usage.Flattened' graph: allOf: - $ref: '#/components/schemas/xpack.usage.Base' health_api: allOf: - $ref: '#/components/schemas/xpack.usage.HealthStatistics' ilm: allOf: - $ref: '#/components/schemas/xpack.usage.Ilm' logstash: allOf: - $ref: '#/components/schemas/xpack.usage.Base' ml: allOf: - $ref: '#/components/schemas/xpack.usage.MachineLearning' monitoring: allOf: - $ref: '#/components/schemas/xpack.usage.Monitoring' rollup: allOf: - $ref: '#/components/schemas/xpack.usage.Base' runtime_fields: allOf: - $ref: '#/components/schemas/xpack.usage.RuntimeFieldTypes' spatial: allOf: - $ref: '#/components/schemas/xpack.usage.Base' searchable_snapshots: allOf: - $ref: '#/components/schemas/xpack.usage.SearchableSnapshots' security: allOf: - $ref: '#/components/schemas/xpack.usage.Security' slm: allOf: - $ref: '#/components/schemas/xpack.usage.Slm' sql: allOf: - $ref: '#/components/schemas/xpack.usage.Sql' transform: allOf: - $ref: '#/components/schemas/xpack.usage.Base' vectors: allOf: - $ref: '#/components/schemas/xpack.usage.Vector' voting_only: allOf: - $ref: '#/components/schemas/xpack.usage.Base' required: - aggregate_metric - analytics - archive - watcher - ccr - data_tiers - eql - graph - ilm - logstash - ml - monitoring - rollup - spatial - searchable_snapshots - security - slm - sql - transform - voting_only examples: XPackUsageResponseExample1: description: An abbreviated response from `GET /_xpack/usage`. value: "{\n \"security\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"monitoring\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"collection_enabled\" : false,\n \"enabled_exporters\" : {\n \"local\" : 1\n }\n },\n \"watcher\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"execution\" : {\n \"actions\" : {\n \"_all\" : {\n \"total\" : 0,\n \"total_time_in_ms\" : 0\n }\n }\n },\n \"watch\" : {\n \"input\" : {\n \"_all\" : {\n \"total\" : 0,\n \"active\" : 0\n }\n },\n \"trigger\" : {\n \"_all\" : {\n \"total\" : 0,\n \"active\" : 0\n }\n }\n },\n \"count\" : {\n \"total\" : 0,\n \"active\" : 0\n }\n },\n \"graph\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ml\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"jobs\" : {\n \"_all\" : {\n \"count\" : 0,\n \"detectors\" : { },\n \"created_by\" : { },\n \"model_size\" : { },\n \"forecasts\" : {\n \"total\" : 0,\n \"forecasted_jobs\" : 0\n }\n }\n },\n \"datafeeds\" : {\n \"_all\" : {\n \"count\" : 0\n }\n },\n \"data_frame_analytics_jobs\" : {\n \"_all\" : {\n \"count\" : 0\n },\n \"analysis_counts\": { },\n \"memory_usage\": {\n \"peak_usage_bytes\": {\n \"min\": 0.0,\n \"max\": 0.0,\n \"avg\": 0.0,\n \"total\": 0.0\n }\n }\n },\n \"inference\" : {\n \"ingest_processors\" : {\n \"_all\" : {\n \"num_docs_processed\" : {\n \"max\" : 0,\n \"sum\" : 0,\n \"min\" : 0\n },\n \"pipelines\" : {\n \"count\" : 0\n },\n \"num_failures\" : {\n \"max\" : 0,\n \"sum\" : 0,\n \"min\" : 0\n },\n \"time_ms\" : {\n \"max\" : 0,\n \"sum\" : 0,\n \"min\" : 0\n }\n }\n },\n \"trained_models\" : {\n \"_all\" : {\n \"count\": 1\n },\n \"count\": {\n \"total\": 1,\n \"prepackaged\": 1,\n \"other\": 0\n },\n \"model_size_bytes\": {\n \"min\": 0.0,\n \"max\": 0.0,\n \"avg\": 0.0,\n \"total\": 0.0\n },\n \"estimated_operations\": {\n \"min\": 0.0,\n \"max\": 0.0,\n \"avg\": 0.0,\n \"total\": 0.0\n }\n },\n \"deployments\": {\n \"count\": 0,\n \"inference_counts\": {\n \"total\": 0.0,\n \"min\": 0.0,\n \"avg\": 0.0,\n \"max\": 0.0\n },\n \"stats_by_model\": [],\n \"model_sizes_bytes\": {\n \"total\": 0.0,\n \"min\": 0.0,\n \"avg\": 0.0,\n \"max\": 0.0\n },\n \"time_ms\": {\n \"avg\": 0.0\n }\n }\n },\n \"node_count\" : 1,\n \"memory\": {\n anomaly_detectors_memory_bytes: 0,\n data_frame_analytics_memory_bytes: 0,\n pytorch_inference_memory_bytes: 0,\n total_used_memory_bytes: 0\n }\n },\n \"inference\": {\n \"available\" : true,\n \"enabled\" : true,\n \"models\" : [ ]\n },\n \"logstash\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"eql\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"esql\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"features\" : {\n \"eval\" : 0,\n \"stats\" : 0,\n \"dissect\": 0,\n \"grok\" : 0,\n \"limit\" : 0,\n \"where\" : 0,\n \"sort\" : 0,\n \"drop\" : 0,\n \"show\" : 0,\n \"rename\" : 0,\n \"mv_expand\" : 0,\n \"keep\" : 0,\n \"enrich\" : 0,\n \"from\" : 0,\n \"row\" : 0\n },\n \"queries\" : {\n \"rest\" : {\n \"total\" : 0,\n \"failed\" : 0\n },\n \"kibana\" : {\n \"total\" : 0,\n \"failed\" : 0\n },\n \"_all\" : {\n \"total\" : 0,\n \"failed\" : 0\n }\n }\n },\n \"sql\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"features\" : {\n \"having\" : 0,\n \"subselect\" : 0,\n \"limit\" : 0,\n \"orderby\" : 0,\n \"where\" : 0,\n \"join\" : 0,\n \"groupby\" : 0,\n \"command\" : 0,\n \"local\" : 0\n },\n \"queries\" : {\n \"rest\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"cli\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"canvas\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"odbc\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"jdbc\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"odbc32\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"odbc64\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"_all\" : {\n \"total\" : 0,\n \"paging\" : 0,\n \"failed\" : 0\n },\n \"translate\" : {\n \"count\" : 0\n }\n }\n },\n \"rollup\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ilm\" : {\n \"policy_count\" : 3,\n \"policy_stats\" : [ ]\n },\n \"slm\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"ccr\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"follower_indices_count\" : 0,\n \"auto_follow_patterns_count\" : 0\n },\n \"transform\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"voting_only\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"searchable_snapshots\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"indices_count\" : 0,\n \"full_copy_indices_count\" : 0,\n \"shared_cache_indices_count\" : 0\n },\n \"spatial\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"analytics\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"stats\": {\n \"boxplot_usage\" : 0,\n \"top_metrics_usage\" : 0,\n \"normalize_usage\" : 0,\n \"cumulative_cardinality_usage\" : 0,\n \"t_test_usage\" : 0,\n \"rate_usage\" : 0,\n \"string_stats_usage\" : 0,\n \"moving_percentiles_usage\" : 0,\n \"multi_terms_usage\" : 0\n }\n },\n \"data_streams\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"data_streams\" : 0,\n \"indices_count\" : 0\n },\n \"data_lifecycle\" : {\n \"available\": true,\n \"enabled\": true,\n \"count\": 0,\n \"default_rollover_used\": true,\n \"data_retention\": {\n \"configured_data_streams\": 0\n },\n \"effective_retention\": {\n \"retained_data_streams\": 0\n },\n \"global_retention\": {\n \"default\": {\n \"defined\": false\n },\n \"max\": {\n \"defined\": false\n }\n }\n },\n \"data_tiers\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"data_warm\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_frozen\" : {\n \"node_count\" : 1,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_cold\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_content\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n },\n \"data_hot\" : {\n \"node_count\" : 0,\n \"index_count\" : 0,\n \"total_shard_count\" : 0,\n \"primary_shard_count\" : 0,\n \"doc_count\" : 0,\n \"total_size_bytes\" : 0,\n \"primary_size_bytes\" : 0,\n \"primary_shard_size_avg_bytes\" : 0,\n \"primary_shard_size_median_bytes\" : 0,\n \"primary_shard_size_mad_bytes\" : 0\n }\n },\n \"aggregate_metric\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"archive\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"indices_count\" : 0\n },\n \"health_api\" : {\n \"available\" : true,\n \"enabled\" : true,\n \"invocations\": {\n \"total\": 0\n }\n },\n \"remote_clusters\": {\n \"size\": 0,\n \"mode\": {\n \"proxy\": 0,\n \"sniff\": 0\n },\n \"security\": {\n \"cert\": 0,\n \"api_key\": 0\n }\n },\n \"enterprise_search\" : {\n \"available\": true,\n \"enabled\": true,\n \"search_applications\" : {\n \"count\": 0\n },\n \"analytics_collections\": {\n \"count\": 0\n },\n \"query_rulesets\": {\n \"total_rule_count\": 0,\n \"total_count\": 0,\n \"min_rule_count\": 0,\n \"max_rule_count\": 0\n }\n },\n \"universal_profiling\" : {\n \"available\" : true,\n \"enabled\" : true\n },\n \"logsdb\": {\n \"available\": true,\n \"enabled\": false,\n \"indices_count\": 0,\n \"indices_with_synthetic_source\": 0,\n \"num_docs\": 0,\n \"size_in_bytes\": 0,\n \"has_custom_cutoff_date\": false\n }\n}" x-state: Generally available x-variations: - "
\n GET\n /_xpack/usage\n
\n " x-req-auth: - 'Cluster privileges: `monitor` ' x-api: usage.xpack x-category: info x-codeSamples: - lang: Console source: 'GET /_xpack/usage ' - lang: Python source: resp = client.xpack.usage() - lang: JavaScript source: const response = await client.xpack.usage(); - lang: Ruby source: response = client.xpack.usage - lang: PHP source: $resp = $client->xpack()->usage(); - lang: curl source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_xpack/usage"' - lang: Java source: 'client.xpack().usage(u -> u); ' x-metaTags: - content: Elasticsearch name: product_name components: schemas: xpack.usage.Realm: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: name: type: array items: type: string order: type: array items: type: number size: type: array items: type: number cache: type: array items: $ref: '#/components/schemas/xpack.usage.RealmCache' has_authorization_realms: type: array items: type: boolean has_default_username_pattern: type: array items: type: boolean has_truststore: type: array items: type: boolean is_authentication_delegated: type: array items: type: boolean xpack.usage.Vector: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: dense_vector_dims_avg_count: type: number dense_vector_fields_count: type: number sparse_vector_fields_count: type: number required: - dense_vector_dims_avg_count - dense_vector_fields_count license._types.LicenseStatus: type: string enum: - active - valid - invalid - expired xpack.usage.Ccr: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: auto_follow_patterns_count: type: number follower_indices_count: type: number required: - auto_follow_patterns_count - follower_indices_count xpack.usage.Flattened: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: field_count: type: number required: - field_count xpack.usage.Watcher: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: execution: allOf: - $ref: '#/components/schemas/xpack.usage.WatcherActions' watch: allOf: - $ref: '#/components/schemas/xpack.usage.WatcherWatch' count: allOf: - $ref: '#/components/schemas/xpack.usage.Counter' required: - execution - watch - count xpack.usage.MlInferenceTrainedModelsCount: type: object properties: total: type: number prepackaged: type: number other: type: number pass_through: type: number regression: type: number classification: type: number ner: type: number text_embedding: type: number required: - total - prepackaged - other xpack.usage.DataStreams: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: data_streams: type: number indices_count: type: number required: - data_streams - indices_count license._types.LicenseType: type: string enum: - missing - trial - basic - standard - dev - silver - gold - platinum - enterprise xpack.usage.WatcherActions: type: object properties: actions: type: object additionalProperties: $ref: '#/components/schemas/xpack.usage.WatcherActionTotals' required: - actions xpack.usage.Sql: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: features: type: object additionalProperties: type: number queries: type: object additionalProperties: $ref: '#/components/schemas/xpack.usage.Query' required: - features - queries _types.EpochTimeUnitMillis: allOf: - $ref: '#/components/schemas/_types.UnitMillis' _types.uint: type: number xpack.usage.Ilm: type: object properties: policy_count: type: number policy_stats: type: array items: $ref: '#/components/schemas/xpack.usage.IlmPolicyStatistics' required: - policy_count - policy_stats xpack.usage.Audit: allOf: - $ref: '#/components/schemas/xpack.usage.FeatureToggle' - type: object properties: outputs: type: array items: type: string xpack.usage.SearchableSnapshots: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: indices_count: type: number full_copy_indices_count: type: number shared_cache_indices_count: type: number required: - indices_count xpack.usage.SecurityRolesFile: type: object properties: dls: type: boolean fls: type: boolean size: type: number required: - dls - fls - size xpack.usage.DataTiers: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: data_warm: allOf: - $ref: '#/components/schemas/xpack.usage.DataTierPhaseStatistics' data_frozen: x-state: Generally available; Added in 7.13.0 allOf: - $ref: '#/components/schemas/xpack.usage.DataTierPhaseStatistics' data_cold: allOf: - $ref: '#/components/schemas/xpack.usage.DataTierPhaseStatistics' data_content: allOf: - $ref: '#/components/schemas/xpack.usage.DataTierPhaseStatistics' data_hot: allOf: - $ref: '#/components/schemas/xpack.usage.DataTierPhaseStatistics' required: - data_warm - data_cold - data_content - data_hot xpack.usage.RoleMapping: type: object properties: enabled: type: number size: type: number required: - enabled - size _types.ByteSize: oneOf: - type: number - type: string xpack.usage.MachineLearning: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: datafeeds: type: object additionalProperties: $ref: '#/components/schemas/xpack.usage.Datafeed' jobs: description: Job usage statistics. The `_all` entry is always present and gathers statistics for all jobs. type: object additionalProperties: $ref: '#/components/schemas/xpack.usage.JobUsage' node_count: type: number data_frame_analytics_jobs: allOf: - $ref: '#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobs' inference: allOf: - $ref: '#/components/schemas/xpack.usage.MlInference' required: - datafeeds - jobs - node_count - data_frame_analytics_jobs - inference xpack.info.BuildInformation: type: object properties: date: allOf: - $ref: '#/components/schemas/_types.DateTime' hash: type: string required: - date - hash _types.ulong: type: number _types.DurationValueUnitMillis: allOf: - $ref: '#/components/schemas/_types.UnitMillis' xpack.usage.MlInference: type: object properties: ingest_processors: type: object additionalProperties: $ref: '#/components/schemas/xpack.usage.MlInferenceIngestProcessor' trained_models: allOf: - $ref: '#/components/schemas/xpack.usage.MlInferenceTrainedModels' deployments: x-state: Generally available; Added in 8.0.0 allOf: - $ref: '#/components/schemas/xpack.usage.MlInferenceDeployments' required: - ingest_processors - trained_models xpack.usage.RuntimeFieldsType: type: object properties: chars_max: type: number chars_total: type: number count: type: number doc_max: type: number doc_total: type: number index_count: type: number lang: type: array items: type: string lines_max: type: number lines_total: type: number name: allOf: - $ref: '#/components/schemas/_types.Field' scriptless_count: type: number shadowed_count: type: number source_max: type: number source_total: type: number required: - chars_max - chars_total - count - doc_max - doc_total - index_count - lang - lines_max - lines_total - name - scriptless_count - shadowed_count - source_max - source_total xpack.usage.WatcherWatchTriggerSchedule: allOf: - $ref: '#/components/schemas/xpack.usage.Counter' - type: object properties: cron: allOf: - $ref: '#/components/schemas/xpack.usage.Counter' _all: allOf: - $ref: '#/components/schemas/xpack.usage.Counter' required: - cron - _all _types.Field: description: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields. type: string _types.DateTime: description: '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 accepts both as input, but will generally output a string representation.' oneOf: - type: string - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' xpack.usage.MlCounter: type: object properties: count: type: number required: - count _types.Duration: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#time-units description: '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 indicate an unspecified value.' oneOf: - type: string - type: string enum: - '-1' - type: string enum: - '0' xpack.usage.Query: type: object properties: count: type: number failed: type: number paging: type: number total: type: number xpack.usage.AnalyticsStatistics: type: object properties: boxplot_usage: type: number cumulative_cardinality_usage: type: number string_stats_usage: type: number top_metrics_usage: type: number t_test_usage: type: number moving_percentiles_usage: type: number normalize_usage: type: number rate_usage: type: number multi_terms_usage: type: number required: - boxplot_usage - cumulative_cardinality_usage - string_stats_usage - top_metrics_usage - t_test_usage - moving_percentiles_usage - normalize_usage - rate_usage xpack.usage.IlmPolicyStatistics: type: object properties: indices_managed: type: number phases: allOf: - $ref: '#/components/schemas/xpack.usage.Phases' required: - indices_managed - phases xpack.info.Feature: type: object properties: available: type: boolean description: type: string enabled: type: boolean native_code_info: allOf: - $ref: '#/components/schemas/xpack.info.NativeCodeInformation' required: - available - enabled xpack.info.NativeCodeInformation: type: object properties: build_hash: type: string version: allOf: - $ref: '#/components/schemas/_types.VersionString' required: - build_hash - version _types.Id: type: string slm._types.Statistics: type: object properties: retention_deletion_time: allOf: - $ref: '#/components/schemas/_types.Duration' retention_deletion_time_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' retention_failed: type: number retention_runs: type: number retention_timed_out: type: number policy: allOf: - $ref: '#/components/schemas/_types.Id' total_snapshots_deleted: type: number total_snapshot_deletion_failures: type: number total_snapshots_failed: type: number total_snapshots_taken: type: number xpack.usage.RealmCache: type: object properties: size: type: number required: - size xpack.usage.Ssl: type: object properties: http: allOf: - $ref: '#/components/schemas/xpack.usage.FeatureToggle' transport: allOf: - $ref: '#/components/schemas/xpack.usage.FeatureToggle' required: - http - transport xpack.usage.Slm: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: policy_count: type: number policy_stats: allOf: - $ref: '#/components/schemas/slm._types.Statistics' xpack.usage.Phase: type: object properties: actions: type: array items: type: string min_age: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - actions - min_age xpack.usage.MlDataFrameAnalyticsJobsAnalysis: type: object properties: classification: type: number outlier_detection: type: number regression: type: number xpack.usage.SecurityRolesDls: type: object properties: bit_set_cache: allOf: - $ref: '#/components/schemas/xpack.usage.SecurityRolesDlsBitSetCache' required: - bit_set_cache xpack.usage.MlInferenceIngestProcessorCount: type: object properties: max: type: number sum: type: number min: type: number required: - max - sum - min xpack.usage.DataTierPhaseStatistics: type: object properties: node_count: type: number index_count: type: number total_shard_count: type: number primary_shard_count: type: number doc_count: type: number total_size_bytes: type: number primary_size_bytes: type: number primary_shard_size_avg_bytes: type: number primary_shard_size_median_bytes: type: number primary_shard_size_mad_bytes: type: number required: - node_count - index_count - total_shard_count - primary_shard_count - doc_count - total_size_bytes - primary_size_bytes - primary_shard_size_avg_bytes - primary_shard_size_median_bytes - primary_shard_size_mad_bytes xpack.usage.Security: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: api_key_service: allOf: - $ref: '#/components/schemas/xpack.usage.FeatureToggle' anonymous: allOf: - $ref: '#/components/schemas/xpack.usage.FeatureToggle' audit: allOf: - $ref: '#/components/schemas/xpack.usage.Audit' fips_140: allOf: - $ref: '#/components/schemas/xpack.usage.FeatureToggle' ipfilter: allOf: - $ref: '#/components/schemas/xpack.usage.IpFilter' realms: type: object additionalProperties: $ref: '#/components/schemas/xpack.usage.Realm' role_mapping: type: object additionalProperties: $ref: '#/components/schemas/xpack.usage.RoleMapping' roles: allOf: - $ref: '#/components/schemas/xpack.usage.SecurityRoles' ssl: allOf: - $ref: '#/components/schemas/xpack.usage.Ssl' system_key: allOf: - $ref: '#/components/schemas/xpack.usage.FeatureToggle' token_service: allOf: - $ref: '#/components/schemas/xpack.usage.FeatureToggle' operator_privileges: allOf: - $ref: '#/components/schemas/xpack.usage.Base' required: - api_key_service - anonymous - audit - fips_140 - ipfilter - realms - role_mapping - roles - ssl - token_service - operator_privileges xpack.usage.Monitoring: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: collection_enabled: type: boolean enabled_exporters: type: object additionalProperties: type: number required: - collection_enabled - enabled_exporters xpack.info.Features: type: object properties: aggregate_metric: allOf: - $ref: '#/components/schemas/xpack.info.Feature' analytics: allOf: - $ref: '#/components/schemas/xpack.info.Feature' ccr: allOf: - $ref: '#/components/schemas/xpack.info.Feature' data_streams: allOf: - $ref: '#/components/schemas/xpack.info.Feature' data_tiers: allOf: - $ref: '#/components/schemas/xpack.info.Feature' enrich: allOf: - $ref: '#/components/schemas/xpack.info.Feature' enterprise_search: x-state: Generally available; Added in 8.8.0 allOf: - $ref: '#/components/schemas/xpack.info.Feature' eql: allOf: - $ref: '#/components/schemas/xpack.info.Feature' esql: x-state: Generally available; Added in 8.14.0 allOf: - $ref: '#/components/schemas/xpack.info.Feature' graph: allOf: - $ref: '#/components/schemas/xpack.info.Feature' ilm: allOf: - $ref: '#/components/schemas/xpack.info.Feature' logstash: allOf: - $ref: '#/components/schemas/xpack.info.Feature' logsdb: allOf: - $ref: '#/components/schemas/xpack.info.Feature' ml: allOf: - $ref: '#/components/schemas/xpack.info.Feature' monitoring: allOf: - $ref: '#/components/schemas/xpack.info.Feature' rollup: allOf: - $ref: '#/components/schemas/xpack.info.Feature' runtime_fields: allOf: - $ref: '#/components/schemas/xpack.info.Feature' searchable_snapshots: allOf: - $ref: '#/components/schemas/xpack.info.Feature' security: allOf: - $ref: '#/components/schemas/xpack.info.Feature' slm: allOf: - $ref: '#/components/schemas/xpack.info.Feature' spatial: allOf: - $ref: '#/components/schemas/xpack.info.Feature' sql: allOf: - $ref: '#/components/schemas/xpack.info.Feature' transform: allOf: - $ref: '#/components/schemas/xpack.info.Feature' universal_profiling: x-state: Generally available; Added in 8.7.0 allOf: - $ref: '#/components/schemas/xpack.info.Feature' voting_only: allOf: - $ref: '#/components/schemas/xpack.info.Feature' watcher: allOf: - $ref: '#/components/schemas/xpack.info.Feature' archive: x-state: Generally available; Added in 8.2.0 allOf: - $ref: '#/components/schemas/xpack.info.Feature' required: - aggregate_metric - analytics - ccr - data_streams - data_tiers - enrich - enterprise_search - eql - esql - graph - ilm - logstash - logsdb - ml - monitoring - rollup - searchable_snapshots - security - slm - spatial - sql - transform - universal_profiling - voting_only - watcher - archive ml._types.JobStatistics: type: object properties: avg: type: number max: type: number min: type: number total: type: number required: - avg - max - min - total xpack.usage.MlInferenceTrainedModels: type: object properties: estimated_operations: allOf: - $ref: '#/components/schemas/ml._types.JobStatistics' estimated_heap_memory_usage_bytes: allOf: - $ref: '#/components/schemas/ml._types.JobStatistics' count: allOf: - $ref: '#/components/schemas/xpack.usage.MlInferenceTrainedModelsCount' _all: allOf: - $ref: '#/components/schemas/xpack.usage.MlCounter' model_size_bytes: x-state: Generally available; Added in 8.0.0 allOf: - $ref: '#/components/schemas/ml._types.JobStatistics' required: - _all xpack.usage.MlDataFrameAnalyticsJobs: type: object properties: memory_usage: allOf: - $ref: '#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsMemory' _all: allOf: - $ref: '#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsCount' analysis_counts: allOf: - $ref: '#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsAnalysis' stopped: allOf: - $ref: '#/components/schemas/xpack.usage.MlDataFrameAnalyticsJobsCount' required: - _all _types.UnitMillis: description: Time unit for milliseconds type: number xpack.usage.FeatureToggle: type: object properties: enabled: type: boolean required: - enabled xpack.usage.EqlFeaturesSequences: type: object properties: sequence_queries_three: allOf: - $ref: '#/components/schemas/_types.uint' sequence_queries_four: allOf: - $ref: '#/components/schemas/_types.uint' sequence_queries_two: allOf: - $ref: '#/components/schemas/_types.uint' sequence_until: allOf: - $ref: '#/components/schemas/_types.uint' sequence_queries_five_or_more: allOf: - $ref: '#/components/schemas/_types.uint' sequence_maxspan: allOf: - $ref: '#/components/schemas/_types.uint' required: - sequence_queries_three - sequence_queries_four - sequence_queries_two - sequence_until - sequence_queries_five_or_more - sequence_maxspan _types.VersionString: type: string xpack.usage.EqlFeaturesPipes: type: object properties: pipe_tail: allOf: - $ref: '#/components/schemas/_types.uint' pipe_head: allOf: - $ref: '#/components/schemas/_types.uint' required: - pipe_tail - pipe_head xpack.info.XPackCategory: type: string enum: - build - features - license xpack.usage.MlInferenceDeploymentsTimeMs: type: object properties: avg: type: number required: - avg xpack.usage.MlInferenceIngestProcessor: type: object properties: num_docs_processed: allOf: - $ref: '#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount' pipelines: allOf: - $ref: '#/components/schemas/xpack.usage.MlCounter' num_failures: allOf: - $ref: '#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount' time_ms: allOf: - $ref: '#/components/schemas/xpack.usage.MlInferenceIngestProcessorCount' required: - num_docs_processed - pipelines - num_failures - time_ms xpack.usage.Invocations: type: object properties: total: type: number required: - total xpack.usage.RuntimeFieldTypes: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: field_types: type: array items: $ref: '#/components/schemas/xpack.usage.RuntimeFieldsType' required: - field_types xpack.usage.Analytics: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: stats: allOf: - $ref: '#/components/schemas/xpack.usage.AnalyticsStatistics' required: - stats xpack.usage.EqlFeatures: type: object properties: join: allOf: - $ref: '#/components/schemas/_types.uint' joins: allOf: - $ref: '#/components/schemas/xpack.usage.EqlFeaturesJoin' keys: allOf: - $ref: '#/components/schemas/xpack.usage.EqlFeaturesKeys' event: allOf: - $ref: '#/components/schemas/_types.uint' pipes: allOf: - $ref: '#/components/schemas/xpack.usage.EqlFeaturesPipes' sequence: allOf: - $ref: '#/components/schemas/_types.uint' sequences: allOf: - $ref: '#/components/schemas/xpack.usage.EqlFeaturesSequences' required: - join - joins - keys - event - pipes - sequence - sequences xpack.usage.WatcherWatchTrigger: type: object properties: schedule: allOf: - $ref: '#/components/schemas/xpack.usage.WatcherWatchTriggerSchedule' _all: allOf: - $ref: '#/components/schemas/xpack.usage.Counter' required: - _all xpack.info.MinimalLicenseInformation: type: object properties: expiry_date_in_millis: allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' mode: allOf: - $ref: '#/components/schemas/license._types.LicenseType' status: allOf: - $ref: '#/components/schemas/license._types.LicenseStatus' type: allOf: - $ref: '#/components/schemas/license._types.LicenseType' uid: type: string required: - expiry_date_in_millis - mode - status - type - uid xpack.usage.Phases: type: object properties: cold: allOf: - $ref: '#/components/schemas/xpack.usage.Phase' delete: allOf: - $ref: '#/components/schemas/xpack.usage.Phase' frozen: allOf: - $ref: '#/components/schemas/xpack.usage.Phase' hot: allOf: - $ref: '#/components/schemas/xpack.usage.Phase' warm: allOf: - $ref: '#/components/schemas/xpack.usage.Phase' xpack.usage.Eql: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: features: allOf: - $ref: '#/components/schemas/xpack.usage.EqlFeatures' queries: type: object additionalProperties: $ref: '#/components/schemas/xpack.usage.Query' required: - features - queries xpack.usage.EqlFeaturesJoin: type: object properties: join_queries_two: allOf: - $ref: '#/components/schemas/_types.uint' join_queries_three: allOf: - $ref: '#/components/schemas/_types.uint' join_until: allOf: - $ref: '#/components/schemas/_types.uint' join_queries_five_or_more: allOf: - $ref: '#/components/schemas/_types.uint' join_queries_four: allOf: - $ref: '#/components/schemas/_types.uint' required: - join_queries_two - join_queries_three - join_until - join_queries_five_or_more - join_queries_four xpack.usage.MlInferenceDeployments: type: object properties: count: type: number inference_counts: allOf: - $ref: '#/components/schemas/ml._types.JobStatistics' model_sizes_bytes: allOf: - $ref: '#/components/schemas/ml._types.JobStatistics' time_ms: allOf: - $ref: '#/components/schemas/xpack.usage.MlInferenceDeploymentsTimeMs' required: - count - inference_counts - model_sizes_bytes - time_ms xpack.usage.Base: type: object properties: available: type: boolean enabled: type: boolean required: - available - enabled xpack.usage.SecurityRoles: type: object properties: native: allOf: - $ref: '#/components/schemas/xpack.usage.SecurityRolesNative' dls: allOf: - $ref: '#/components/schemas/xpack.usage.SecurityRolesDls' file: allOf: - $ref: '#/components/schemas/xpack.usage.SecurityRolesFile' required: - native - dls - file xpack.usage.SecurityRolesDlsBitSetCache: type: object properties: count: description: Number of entries in the cache. type: number memory: description: Human-readable amount of memory taken up by the cache. allOf: - $ref: '#/components/schemas/_types.ByteSize' memory_in_bytes: description: Memory taken up by the cache in bytes. allOf: - $ref: '#/components/schemas/_types.ulong' hits: description: Total number of cache hits. x-state: Generally available; Added in 9.2.0 type: number misses: description: Total number of cache misses. x-state: Generally available; Added in 9.2.0 type: number evictions: description: Total number of cache evictions. x-state: Generally available; Added in 9.2.0 type: number hits_time_in_millis: description: Total combined time spent in cache for hits in milliseconds. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' misses_time_in_millis: description: Total combined time spent in cache for misses in milliseconds. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - count - memory_in_bytes - hits - misses - evictions - hits_time_in_millis - misses_time_in_millis xpack.usage.Archive: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: indices_count: type: number required: - indices_count xpack.usage.IpFilter: type: object properties: http: type: boolean transport: type: boolean required: - http - transport xpack.usage.WatcherActionTotals: type: object properties: total: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_in_ms: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - total - total_time_in_ms xpack.usage.MlDataFrameAnalyticsJobsCount: type: object properties: count: type: number required: - count xpack.usage.Counter: type: object properties: active: type: number total: type: number required: - active - total xpack.usage.HealthStatistics: allOf: - $ref: '#/components/schemas/xpack.usage.Base' - type: object properties: invocations: allOf: - $ref: '#/components/schemas/xpack.usage.Invocations' required: - invocations xpack.usage.SecurityRolesNative: type: object properties: dls: type: boolean fls: type: boolean size: type: number required: - dls - fls - size xpack.usage.JobUsage: type: object properties: count: type: number created_by: type: object additionalProperties: type: number detectors: allOf: - $ref: '#/components/schemas/ml._types.JobStatistics' forecasts: allOf: - $ref: '#/components/schemas/xpack.usage.MlJobForecasts' model_size: allOf: - $ref: '#/components/schemas/ml._types.JobStatistics' required: - count - created_by - detectors - forecasts - model_size xpack.usage.MlJobForecasts: type: object properties: total: type: number forecasted_jobs: type: number required: - total - forecasted_jobs xpack.usage.Datafeed: type: object properties: count: type: number required: - count xpack.usage.MlDataFrameAnalyticsJobsMemory: type: object properties: peak_usage_bytes: allOf: - $ref: '#/components/schemas/ml._types.JobStatistics' required: - peak_usage_bytes xpack.usage.EqlFeaturesKeys: type: object properties: join_keys_two: allOf: - $ref: '#/components/schemas/_types.uint' join_keys_one: allOf: - $ref: '#/components/schemas/_types.uint' join_keys_three: allOf: - $ref: '#/components/schemas/_types.uint' join_keys_five_or_more: allOf: - $ref: '#/components/schemas/_types.uint' join_keys_four: allOf: - $ref: '#/components/schemas/_types.uint' required: - join_keys_two - join_keys_one - join_keys_three - join_keys_five_or_more - join_keys_four xpack.usage.WatcherWatch: type: object properties: input: type: object additionalProperties: $ref: '#/components/schemas/xpack.usage.Counter' condition: type: object additionalProperties: $ref: '#/components/schemas/xpack.usage.Counter' action: type: object additionalProperties: $ref: '#/components/schemas/xpack.usage.Counter' trigger: allOf: - $ref: '#/components/schemas/xpack.usage.WatcherWatchTrigger' required: - input - trigger securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: "Elasticsearch APIs support key-based authentication.\nYou must create an API key and use the encoded value in the request header.\nFor example:\n\n```\ncurl -X GET \"${ES_URL}/_cat/indices?v=true\" \\\n -H \"Authorization: ApiKey ${API_KEY}\"\n```\n\nTo get API keys, use the `/_security/api_key` APIs." basicAuth: type: http scheme: basic bearerAuth: type: http scheme: bearer description: '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](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services)' x-tagGroups: - name: AI & Machine Learning tags: - analytics - graph - inference - ml - ml anomaly - ml data frame - ml trained model - query_rules - text_structure - name: Cluster Management tags: - ccr - cluster - connector - data stream - ilm - indices - rollup - script - search_application - searchable_snapshots - slm - snapshot - name: Data Processing tags: - enrich - fleet - ingest - logstash - synonyms - transform - name: Information & Monitoring tags: - cat - features - health_report - info - license - migration - tasks - watcher - xpack - name: Search & Document APIs tags: - document - eql - esql - search - sql - name: Security tags: - security