Skip to main content

coreServices

Home > @backstage/backend-plugin-api > coreServices

All core services references

Signature:

namespace coreServices 

Variables

Variable

Description

auth

Handles token authentication and credentials management.

See AuthService and the service docs for more information.

cache

Key-value store for caching data.

See CacheService and the service docs for more information.

database

Database access and management via knex.

See DatabaseService and the service docs for more information.

discovery

Service discovery for inter-plugin communication.

See DiscoveryService and the service docs for more information.

httpAuth

Authentication of HTTP requests.

See HttpAuthService and the service docs for more information.

httpRouter

HTTP route registration for plugins.

See HttpRouterService and the service docs for more information.

lifecycle

Registration of plugin startup and shutdown lifecycle hooks.

See LifecycleService and the service docs for more information.

logger

Plugin-level logging.

See LoggerService and the service docs for more information.

permissions

Permission system integration for authorization of user actions.

See PermissionsService and the service docs for more information.

pluginMetadata

Built-in service for accessing metadata about the current plugin.

See PluginMetadataService and the service docs for more information.

rootConfig

Access to static configuration.

See RootConfigService and the service docs for more information.

rootHealth

The service reference for the plugin scoped RootHealthService.

rootHttpRouter

HTTP route registration for root services.

See RootHttpRouterService and the service docs for more information.

rootLifecycle

Registration of backend startup and shutdown lifecycle hooks.

See RootLifecycleService and the service docs for more information.

rootLogger

Root-level logging.

See RootLoggerService and the service docs for more information.

scheduler

Scheduling of distributed background tasks.

See SchedulerService and the service docs for more information.

urlReader

Reading content from external systems.

See UrlReaderService and the service docs for more information.

userInfo

Authenticated user information retrieval.

See UserInfoService and the service docs for more information.