kibana/api_docs/monitoring.json

{
  "id": "monitoring",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "monitoring",
        "id": "def-server.IBulkUploader",
        "type": "Interface",
        "tags": [],
        "label": "IBulkUploader",
        "description": [],
        "source": {
          "path": "x-pack/plugins/monitoring/server/types.ts",
          "lineNumber": 94
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "monitoring",
            "id": "def-server.IBulkUploader.getKibanaStats",
            "type": "Function",
            "tags": [],
            "label": "getKibanaStats",
            "description": [],
            "signature": [
              "() => any"
            ],
            "source": {
              "path": "x-pack/plugins/monitoring/server/types.ts",
              "lineNumber": 95
            },
            "deprecated": false,
            "returnComment": [],
            "children": []
          },
          {
            "parentPluginId": "monitoring",
            "id": "def-server.IBulkUploader.stop",
            "type": "Function",
            "tags": [],
            "label": "stop",
            "description": [],
            "signature": [
              "() => void"
            ],
            "source": {
              "path": "x-pack/plugins/monitoring/server/types.ts",
              "lineNumber": 96
            },
            "deprecated": false,
            "returnComment": [],
            "children": []
          },
          {
            "parentPluginId": "monitoring",
            "id": "def-server.IBulkUploader.start",
            "type": "Function",
            "tags": [],
            "label": "start",
            "description": [],
            "signature": [
              "(esClient: ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCorePluginApi",
                "section": "def-server.ElasticsearchClient",
                "text": "ElasticsearchClient"
              },
              ") => void"
            ],
            "source": {
              "path": "x-pack/plugins/monitoring/server/types.ts",
              "lineNumber": 97
            },
            "deprecated": false,
            "returnComment": [],
            "children": [
              {
                "parentPluginId": "monitoring",
                "id": "def-server.esClient",
                "type": "CompoundType",
                "tags": [],
                "label": "esClient",
                "description": [],
                "signature": [
                  "Pick<",
                  "KibanaClient",
                  ", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"helpers\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ",
                  "TransportRequestParams",
                  ", options?: ",
                  "TransportRequestOptions",
                  " | undefined): ",
                  "TransportRequestPromise",
                  "<",
                  "ApiResponse",
                  "<Record<string, any>, unknown>>; }; }"
                ],
                "source": {
                  "path": "x-pack/plugins/monitoring/server/types.ts",
                  "lineNumber": 97
                },
                "deprecated": false
              }
            ]
          },
          {
            "parentPluginId": "monitoring",
            "id": "def-server.IBulkUploader.handleNotEnabled",
            "type": "Function",
            "tags": [],
            "label": "handleNotEnabled",
            "description": [],
            "signature": [
              "() => void"
            ],
            "source": {
              "path": "x-pack/plugins/monitoring/server/types.ts",
              "lineNumber": 98
            },
            "deprecated": false,
            "returnComment": [],
            "children": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "monitoring",
        "id": "def-server.KibanaSettingsCollector",
        "type": "Type",
        "tags": [],
        "label": "KibanaSettingsCollector",
        "description": [],
        "signature": [
          {
            "pluginId": "usageCollection",
            "scope": "server",
            "docId": "kibUsageCollectionPluginApi",
            "section": "def-server.ICollector",
            "text": "ICollector"
          },
          "<EmailSettingData | undefined, {}> & ",
          "KibanaSettingsCollectorExtraOptions"
        ],
        "source": {
          "path": "x-pack/plugins/monitoring/server/kibana_monitoring/collectors/get_settings_collector.ts",
          "lineNumber": 53
        },
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "monitoring",
        "id": "def-server.MonitoringConfig",
        "type": "Type",
        "tags": [],
        "label": "MonitoringConfig",
        "description": [],
        "signature": [
          "{ ui: { elasticsearch: ",
          "MonitoringElasticsearchConfig",
          "; enabled: boolean; container: Readonly<{} & { logstash: Readonly<{} & { enabled: boolean; }>; elasticsearch: Readonly<{} & { enabled: boolean; }>; apm: Readonly<{} & { enabled: boolean; }>; }>; logs: Readonly<{} & { index: string; }>; metricbeat: Readonly<{} & { index: string; }>; ccs: Readonly<{} & { enabled: boolean; }>; max_bucket_size: number; min_interval_seconds: number; show_license_expiration: boolean; }; enabled: boolean; kibana: Readonly<{} & { collection: Readonly<{} & { enabled: boolean; interval: number; }>; }>; licensing: Readonly<{} & { api_polling_frequency: moment.Duration; }>; agent: Readonly<{} & { interval: string; }>; cluster_alerts: Readonly<{} & { enabled: boolean; allowedSpaces: string[]; email_notifications: Readonly<{} & { enabled: boolean; email_address: string; }>; }>; tests: Readonly<{} & { cloud_detector: Readonly<{} & { enabled: boolean; }>; }>; }"
        ],
        "source": {
          "path": "x-pack/plugins/monitoring/server/config.ts",
          "lineNumber": 93
        },
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "setup": {
      "parentPluginId": "monitoring",
      "id": "def-server.MonitoringPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "MonitoringPluginSetup",
      "description": [],
      "source": {
        "path": "x-pack/plugins/monitoring/server/types.ts",
        "lineNumber": 101
      },
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "monitoring",
          "id": "def-server.MonitoringPluginSetup.getKibanaStats",
          "type": "Function",
          "tags": [],
          "label": "getKibanaStats",
          "description": [],
          "signature": [
            "() => any"
          ],
          "source": {
            "path": "x-pack/plugins/monitoring/server/types.ts",
            "lineNumber": 102
          },
          "deprecated": false,
          "returnComment": [],
          "children": []
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}