v1
Double column
API
CLI
JS Client

Addons /

Abort backup restore

Aborts an in-progress backup restore.

Required permission

Project > Addons > General > Update

Path parameters

    • projectId

      string required
      ID of the project
    • addonId

      string required
      ID of the addon
    • backupId

      string required
      ID of the backup

Query parameters

    • sourceProjectId

      string
      Specify the source projectId when referring to a global backup.
    • sourceAddonId

      string
      Specify the source addonId when referring to a global backup.

Request body

  • {object}
    • restoreId

      string required
      ID of the restore to abort.

Response body

  • {object}
    Response object.
    • data

      {object} required
      Result data.
    API
    CLI
    JS Client

    POST /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}/abort-restore

    Example request

    Request body
    curl
    curl --header "Content-Type: application/json" \
      --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
      --request POST \
      --data '{"restoreId":"66845073ce75649ad18635f0"}' \
      https://api.northflank.com/v1/projects/{projectId}/addons/{addonId}/backups/{backupId}/abort-restore

    Example response

    200 OK

    The operation was performed successfully.

    JSON

    {
      "data": {}
    }

    © 2024 Northflank Ltd. All rights reserved.