Back to Kibana

Kibana Core API [kibana-platform-api]

docs/extend/kibana-platform-api.md

9.4.01.5 KB
Original Source

Kibana Core API [kibana-platform-api]

::::{warning} This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. ::::

{{kib}} Core provides a set of low-level API’s required to run all {{kib}} plugins. These API’s are injected into your plugin’s lifecycle methods and may be invoked during that lifecycle only:

typescript
import type { PluginInitializerContext, CoreSetup, CoreStart } from '@kbn/core/server';

export class MyPlugin {
  constructor(initializerContext: PluginInitializerContext) {}

  public setup(core: CoreSetup) {
    // called when plugin is setting up during Kibana's startup sequence
  }

  public start(core: CoreStart) {
    // called after all plugins are set up
  }

  public stop() {
    // called when plugin is torn down during Kibana's shutdown sequence
  }
}

The services that core provides are:

::::{note} Core provides the {{kib}} building blocks for plugins and is implemented as a collection of packages. ::::