docs: document backup API endpoints based on code#5172
Draft
Conversation
Contributor
|
|
Co-authored-by: catalinaadam <94133018+catalinaadam@users.noreply.github.com> Agent-Logs-Url: https://github.com/percona/pmm/sessions/ab01d791-b5d4-430e-bfcf-8b39700d3b5a
Copilot
AI
changed the title
[WIP] Document backups in code
docs: document backup API endpoints based on code
Mar 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The backup API docs only covered
StartBackup,RestoreBackup, andListLocations. This PR fills in the remaining endpoints frombackup.proto,locations.proto,restores.proto, andartifacts.proto.New documentation files
manage-locations.md—AddLocation,ChangeLocation,RemoveLocation,TestLocationConfig(filesystem & S3 examples, force-remove, config test)schedule-backup.md—ScheduleBackup,ListScheduledBackups,ChangeScheduledBackup,RemoveScheduledBackup(cron, mode descriptions, retention)list-artifacts.md—ListArtifacts,DeleteArtifact(withremove_files),ListArtifactCompatibleServices,ListPitrTimeranges,GetLogs(backup job)list-restores.md—ListRestores(with status values),GetLogs(restore job)Updated
overview.md— Restructured into sections (Backup Locations, On-Demand and Scheduled Backups, Backup Artifacts, Restore) linking to all pages.API Docs updated
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.