Function BackupApiFp

Returns {
    createBackup(
        backupOptionsDto?: BackupOptionsDto,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BackupManifestDto>,
    >;
    getBackup(
        path: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BackupManifestDto>,
    >;
    listBackups(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BackupManifestDto[]>,
    >;
    startRestoreBackup(
        backupRestoreRequestDto: BackupRestoreRequestDto,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• createBackup: function

  • createBackup(
        backupOptionsDto?: BackupOptionsDto,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BackupManifestDto>,
    >

    Parameters

    • OptionalbackupOptionsDto: BackupOptionsDto

      The backup options.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BackupManifestDto>,
    >

    Throws

• getBackup: function

  • getBackup(
        path: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BackupManifestDto>,
    >

    Parameters

    • path: string

      The data to start a restore process.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BackupManifestDto>,
    >

    Throws

• listBackups: function

  • listBackups(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BackupManifestDto[]>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BackupManifestDto[]>,
    >

    Throws

• startRestoreBackup: function

  • startRestoreBackup(
        backupRestoreRequestDto: BackupRestoreRequestDto,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • backupRestoreRequestDto: BackupRestoreRequestDto

      The data to start a restore process.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws