ScaffolderApi

Home > @backstage/plugin-scaffolder-common > ScaffolderApi

An API to interact with the scaffolder backend.

Signature:

export interface ScaffolderApi 

Methods

Method	Description
autocomplete(request, options)?	(Optional)
cancelTask(taskId, options)	Sends a signal to a task broker to cancel the running task by taskId.
dryRun(request, options)?	(Optional)
getIntegrationsList(options)
getTask(taskId, options)
getTemplateParameterSchema(templateRef, options)
listActions(options)	Returns a list of all installed actions.
listTasks(request, options)?	(Optional)
listTemplatingExtensions(options)?	(Optional) Returns a structure describing the available templating extensions.
retry(taskId, options)?	(Optional) Starts the task again from the point where it failed.
scaffold(request, options)	Executes the scaffolding of a component, given a template and its parameter values.
streamLogs(request, options)