Class BackupsAPI

Handles basic server backup tasks, such as creating, restoring, and deleting backups

Constructors

constructor

Properties

core

Methods

Create Delete Deploy GetDownloadURL List ToggleLock

Constructors

constructor

Properties

Private core

core: WispAPICore

Methods

Create

  • Create(name): Promise<CreateBackupResponse>

  • Creates a new backup for the server

    Parameters

    • name: string

      The name of the Backup

    Returns Promise<CreateBackupResponse>

    Remarks

    ⚠️ This can fail to create a Backup even if the function completes successfully For example, if the backup would exceed the size limit (and the limit is not 0), the system wouldn't know it failed until it hit the limit.

    ⚠️ "It is recomended to stop your server before starting a backup. Backups created while the server is on can contain corupted data."

    Multiple Backups can exist with the same name.

    Throws

    BackupErrorCode If the server returns an error code, it will be thrown verbatim here

Delete

  • Delete(id): Promise<void>

  • Deletes the Backup

    Parameters

    • id: string

      The ID of the Backup

    Returns Promise<void>

Deploy

  • Deploy(id): Promise<Response>

  • Deploys the Backup to the Server

    Parameters

    • id: string

      The ID of the Backup

    Returns Promise<Response>

    Remarks

    ⚠️ This can be dangerous! The Backup will overwrite the entire Server, erasing any new data since the Backup's creation

GetDownloadURL

  • GetDownloadURL(id): Promise<string>

  • Retrieves a URL from which the Backup can be downloaded

    Parameters

    • id: string

      The ID of the Backup

    Returns Promise<string>

    The download URL

List

ToggleLock

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc