Usage API

Provides usage information about the installed X-Pack features.

Request

GET /_xpack/usage

Description

This API provides information about which features are currently enabled and available under the current license and some usage statistics.

Query parameters

master_timeout

(Optional, time units) Specifies the period of time 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. Defaults to 30s.

Examples

  1. GET /_xpack/usage
  1. {
  2.   "security" : {
  3.     "available" : true,
  4.     "enabled" : false,
  5.     "ssl" : {
  6.       "http" : {
  7.         "enabled" : false
  8.       },
  9.       "transport" : {
  10.         "enabled" : false
  11.       }
  12.     }
  13.   },
  14.   "monitoring" : {
  15.     "available" : true,
  16.     "enabled" : true,
  17.     "collection_enabled" : false,
  18.     "enabled_exporters" : {
  19.       "local" : 1
  20.     }
  21.   },
  22.   "watcher" : {
  23.     "available" : true,
  24.     "enabled" : true,
  25.     "execution" : {
  26.       "actions" : {
  27.         "_all" : {
  28.           "total" : 0,
  29.           "total_time_in_ms" : 0
  30.         }
  31.       }
  32.     },
  33.     "watch" : {
  34.       "input" : {
  35.         "_all" : {
  36.           "total" : 0,
  37.           "active" : 0
  38.         }
  39.       },
  40.       "trigger" : {
  41.         "_all" : {
  42.           "total" : 0,
  43.           "active" : 0
  44.         }
  45.       }
  46.     },
  47.     "count" : {
  48.       "total" : 0,
  49.       "active" : 0
  50.     }
  51.   },
  52.   "graph" : {
  53.     "available" : true,
  54.     "enabled" : true
  55.   },
  56.   "ml" : {
  57.     "available" : true,
  58.     "enabled" : true,
  59.     "jobs" : {
  60.       "_all" : {
  61.         "count" : 0,
  62.         "detectors" : {
  63.           ...
  64.         },
  65.         "created_by" : { },
  66.         "model_size" : {
  67.           ...
  68.         },
  69.         "forecasts" : {
  70.           "total" : 0,
  71.           "forecasted_jobs" : 0
  72.         }
  73.       }
  74.     },
  75.     "datafeeds" : {
  76.       "_all" : {
  77.         "count" : 0
  78.       }
  79.     },
  80.     "data_frame_analytics_jobs" : {
  81.       "_all" : {
  82.         "count" : 0
  83.       }
  84.     },
  85.     "inference" : {
  86.       "ingest_processors" : {
  87.         "_all" : {
  88.           "num_docs_processed" : {
  89.             "max" : 0,
  90.             "sum" : 0,
  91.             "min" : 0
  92.           },
  93.           "pipelines" : {
  94.             "count" : 0
  95.           },
  96.           "num_failures" : {
  97.             "max" : 0,
  98.             "sum" : 0,
  99.             "min" : 0
  100.           },
  101.           "time_ms" : {
  102.             "max" : 0,
  103.             "sum" : 0,
  104.             "min" : 0
  105.           }
  106.         }
  107.       },
  108.       "trained_models" : {
  109.         "_all" : {
  110.           "count" : 0
  111.         }
  112.       }
  113.     },
  114.     "node_count" : 1
  115.   },
  116.   "logstash" : {
  117.     "available" : true,
  118.     "enabled" : true
  119.   },
  120.   "eql" : {
  121.     "available" : true,
  122.     "enabled" : true
  123.   },
  124.   "sql" : {
  125.     "available" : true,
  126.     "enabled" : true,
  127.     "features" : {
  128.       "having" : 0,
  129.       "subselect" : 0,
  130.       "limit" : 0,
  131.       "orderby" : 0,
  132.       "where" : 0,
  133.       "join" : 0,
  134.       "groupby" : 0,
  135.       "command" : 0,
  136.       "local" : 0
  137.     },
  138.     "queries" : {
  139.       "rest" : {
  140.         "total" : 0,
  141.         "paging" : 0,
  142.         "failed" : 0
  143.       },
  144.       "cli" : {
  145.         "total" : 0,
  146.         "paging" : 0,
  147.         "failed" : 0
  148.       },
  149.       "canvas" : {
  150.         "total" : 0,
  151.         "paging" : 0,
  152.         "failed" : 0
  153.       },
  154.       "odbc" : {
  155.         "total" : 0,
  156.         "paging" : 0,
  157.         "failed" : 0
  158.       },
  159.       "jdbc" : {
  160.         "total" : 0,
  161.         "paging" : 0,
  162.         "failed" : 0
  163.       },
  164.       "odbc32" : {
  165.         "total" : 0,
  166.         "paging" : 0,
  167.         "failed" : 0
  168.       },
  169.       "odbc64" : {
  170.         "total" : 0,
  171.         "paging" : 0,
  172.         "failed" : 0
  173.       },
  174.       "_all" : {
  175.         "total" : 0,
  176.         "paging" : 0,
  177.         "failed" : 0
  178.       },
  179.       "translate" : {
  180.         "count" : 0
  181.       }
  182.     }
  183.   },
  184.   "rollup" : {
  185.     "available" : true,
  186.     "enabled" : true
  187.   },
  188.   "ilm" : {
  189.     "policy_count" : 3,
  190.     "policy_stats" : [
  191.       ...
  192.     ]
  193.   },
  194.   "slm" : {
  195.     "available" : true,
  196.     "enabled" : true
  197.   },
  198.   "ccr" : {
  199.     "available" : true,
  200.     "enabled" : true,
  201.     "follower_indices_count" : 0,
  202.     "auto_follow_patterns_count" : 0
  203.   },
  204.   "enrich" : {
  205.     "available" : true,
  206.     "enabled" : true
  207.   },
  208.   "transform" : {
  209.     "available" : true,
  210.     "enabled" : true
  211.   },
  212.   "flattened" : {
  213.     "available" : true,
  214.     "enabled" : true,
  215.     "field_count" : 0
  216.   },
  217.   "vectors" : {
  218.     "available" : true,
  219.     "enabled" : true,
  220.     "dense_vector_fields_count" : 0,
  221.     "dense_vector_dims_avg_count" : 0,
  222.     "sparse_vector_fields_count" : 0
  223.   },
  224.   "voting_only" : {
  225.     "available" : true,
  226.     "enabled" : true
  227.   },
  228.   "searchable_snapshots" : {
  229.     "available" : true,
  230.     "enabled" : true,
  231.     "indices_count" : 0
  232.   },
  233.   "frozen_indices" : {
  234.     "available" : true,
  235.     "enabled" : true,
  236.     "indices_count" : 0
  237.   },
  238.   "spatial" : {
  239.     "available" : true,
  240.     "enabled" : true
  241.   },
  242.   "analytics" : {
  243.     "available" : true,
  244.     "enabled" : true,
  245.     ...
  246.   },
  247.   "data_streams" : {
  248.     "available" : true,
  249.     "enabled" : true,
  250.     "data_streams" : 0,
  251.     "indices_count" : 0
  252.   }
  253. }