Backstage
    Preparing search index...

    An API to interact with the scaffolder backend.

    interface ScaffolderApi {
        autocomplete?(
            request: {
                context: Record<string, string>;
                provider: string;
                resource: string;
                token: string;
            },
            options?: ScaffolderRequestOptions,
        ): Promise<{ results: { id: string; title?: string }[] }>;
        cancelTask(
            taskId: string,
            options?: ScaffolderRequestOptions,
        ): Promise<{ status?: ScaffolderTaskStatus }>;
        dryRun?(
            request: ScaffolderDryRunOptions,
            options?: ScaffolderRequestOptions,
        ): Promise<ScaffolderDryRunResponse>;
        getIntegrationsList(
            options: ScaffolderGetIntegrationsListOptions,
        ): Promise<ScaffolderGetIntegrationsListResponse>;
        getTask(
            taskId: string,
            options?: ScaffolderRequestOptions,
        ): Promise<ScaffolderTask>;
        getTemplateParameterSchema(
            templateRef: string,
            options?: ScaffolderRequestOptions,
        ): Promise<TemplateParameterSchema>;
        listActions(
            options?: ScaffolderRequestOptions,
        ): Promise<ListActionsResponse>;
        listTasks?(
            request: {
                filterByOwnership: "owned" | "all";
                limit?: number;
                offset?: number;
            },
            options?: ScaffolderRequestOptions,
        ): Promise<{ tasks: ScaffolderTask[]; totalTasks?: number }>;
        listTemplatingExtensions?(
            options?: ScaffolderRequestOptions,
        ): Promise<ListTemplatingExtensionsResponse>;
        retry?(
            taskId: string,
            options?: ScaffolderRequestOptions,
        ): Promise<{ id: string }>;
        scaffold(
            request: ScaffolderScaffoldOptions,
            options?: ScaffolderRequestOptions,
        ): Promise<ScaffolderScaffoldResponse>;
        streamLogs(
            request: ScaffolderStreamLogsOptions,
            options?: ScaffolderRequestOptions,
        ): Observable<LogEvent>;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • request: {
            context: Record<string, string>;
            provider: string;
            resource: string;
            token: string;
        }
      • Optionaloptions: ScaffolderRequestOptions

      Returns Promise<{ results: { id: string; title?: string }[] }>