Backstage
Docs
Github
Preparing search index...
@backstage/backend-plugin-api
index
Module index
Core API used by Backstage backend plugins.
Namespaces
coreServices
Interfaces
AuditorService
AuthService
BackendFeature
BackendModuleRegistrationPoints
BackendPluginRegistrationPoints
BackstageUserInfo
CacheService
CreateBackendFeatureLoaderOptions
CreateBackendModuleOptions
CreateBackendPluginOptions
CreateExtensionPointOptions
DatabaseService
DiscoveryService
HttpAuthService
HttpRouterService
HttpRouterServiceAuthPolicy
LifecycleService
LifecycleServiceShutdownOptions
LifecycleServiceStartupOptions
LoggerService
PermissionsRegistryService
PermissionsService
PermissionsServiceRequestOptions
PluginMetadataService
PluginServiceFactoryOptions
RootConfigService
RootHealthService
RootHttpRouterService
RootInstanceMetadataService
RootInstanceMetadataServicePluginInfo
RootLifecycleService
RootLoggerService
RootServiceFactoryOptions
SchedulerService
SchedulerServiceTaskInvocationDefinition
SchedulerServiceTaskRunner
SchedulerServiceTaskScheduleDefinition
SchedulerServiceTaskScheduleDefinitionConfig
ServiceFactory
ServiceRefOptions
UrlReaderService
UserInfoService
Type Aliases
AuditorServiceCreateEventOptions
AuditorServiceEvent
AuditorServiceEventSeverityLevel
BackstageCredentials
BackstageNonePrincipal
BackstagePrincipalAccessRestrictions
BackstagePrincipalTypes
BackstageServicePrincipal
BackstageUserPrincipal
CacheServiceOptions
CacheServiceSetOptions
ExtensionPoint
LifecycleServiceShutdownHook
LifecycleServiceStartupHook
PermissionsRegistryServiceAddResourceTypeOptions
SchedulerServiceTaskDescriptor
SchedulerServiceTaskFunction
ServiceRef
UrlReaderServiceReadTreeOptions
UrlReaderServiceReadTreeResponse
UrlReaderServiceReadTreeResponseDirOptions
UrlReaderServiceReadTreeResponseFile
UrlReaderServiceReadUrlOptions
UrlReaderServiceReadUrlResponse
UrlReaderServiceSearchOptions
UrlReaderServiceSearchResponse
UrlReaderServiceSearchResponseFile
Functions
createBackendFeatureLoader
createBackendModule
createBackendPlugin
createExtensionPoint
createServiceFactory
createServiceRef
isChildPath
isDatabaseConflictError
readSchedulerServiceTaskScheduleDefinitionFromConfig
resolvePackagePath
resolveSafeChildPath
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Namespaces
core
Services
Interfaces
Auditor
Service
Auth
Service
Backend
Feature
Backend
Module
Registration
Points
Backend
Plugin
Registration
Points
Backstage
User
Info
Cache
Service
Create
Backend
Feature
Loader
Options
Create
Backend
Module
Options
Create
Backend
Plugin
Options
Create
Extension
Point
Options
Database
Service
Discovery
Service
Http
Auth
Service
Http
Router
Service
Http
Router
Service
Auth
Policy
Lifecycle
Service
Lifecycle
Service
Shutdown
Options
Lifecycle
Service
Startup
Options
Logger
Service
Permissions
Registry
Service
Permissions
Service
Permissions
Service
Request
Options
Plugin
Metadata
Service
Plugin
Service
Factory
Options
Root
Config
Service
Root
Health
Service
Root
Http
Router
Service
Root
Instance
Metadata
Service
Root
Instance
Metadata
Service
Plugin
Info
Root
Lifecycle
Service
Root
Logger
Service
Root
Service
Factory
Options
Scheduler
Service
Scheduler
Service
Task
Invocation
Definition
Scheduler
Service
Task
Runner
Scheduler
Service
Task
Schedule
Definition
Scheduler
Service
Task
Schedule
Definition
Config
Service
Factory
Service
Ref
Options
Url
Reader
Service
User
Info
Service
Type Aliases
Auditor
Service
Create
Event
Options
Auditor
Service
Event
Auditor
Service
Event
Severity
Level
Backstage
Credentials
Backstage
None
Principal
Backstage
Principal
Access
Restrictions
Backstage
Principal
Types
Backstage
Service
Principal
Backstage
User
Principal
Cache
Service
Options
Cache
Service
Set
Options
Extension
Point
Lifecycle
Service
Shutdown
Hook
Lifecycle
Service
Startup
Hook
Permissions
Registry
Service
Add
Resource
Type
Options
Scheduler
Service
Task
Descriptor
Scheduler
Service
Task
Function
Service
Ref
Url
Reader
Service
Read
Tree
Options
Url
Reader
Service
Read
Tree
Response
Url
Reader
Service
Read
Tree
Response
Dir
Options
Url
Reader
Service
Read
Tree
Response
File
Url
Reader
Service
Read
Url
Options
Url
Reader
Service
Read
Url
Response
Url
Reader
Service
Search
Options
Url
Reader
Service
Search
Response
Url
Reader
Service
Search
Response
File
Functions
create
Backend
Feature
Loader
create
Backend
Module
create
Backend
Plugin
create
Extension
Point
create
Service
Factory
create
Service
Ref
is
Child
Path
is
Database
Conflict
Error
read
Scheduler
Service
Task
Schedule
Definition
From
Config
resolve
Package
Path
resolve
Safe
Child
Path
Docs
Github
Backstage
Loading...
Core API used by Backstage backend plugins.