Backups

Update backup properties

Updates specific properties of a backup such as notes. This endpoint allows you to add or modify notes for your backups to help organize and document your backup history. Notes are useful for tracking the purpose of a backup, what changes were included, or any other relevant information.

Key Parameters:

  • id: The unique identifier of the backup to update
  • notes: Optional text field to add or update notes for the backup

NOTE: Changes are applied immediately to the backup record.

patch/backups/{id}

Request

  • Base URL: https://api.cloudpepper.io
  • URL: https://api.cloudpepper.io/backups/{id}
  • Auth: HTTP bearer

Request body

notesstring

Notes to add or update for the backup

Example request

{
  "notes": "Pre-migration backup with custom modules installed"
}

Response

Backup updated successfully

string required

Example response

"ok"

Changes

No recorded changes to this operation across all 1 revision of this API.