All pages
Powered by GitBook
1 of 5

Loading...

Loading...

Loading...

Loading...

Loading...

Backup

Cover
Process overview
Cover
Protected resources
Cover
API rate limits
Cover
Creating a backup plan

Process overview

Learn more about the backup process for GitHub.

General information

GitProtect is designed to protect DevOps ecosystems, including GitHub.

To ensure your entire GitHub environment is reliably backed up, make sure to include all repositories along with their related metadata — the best practice is to create a backup plan for critical repositories and metadata that change daily (or even more frequently), for example, using the recommended Grandfather-Father-Son (GFS) rotation scheme.

Additionally, create a separate backup plan for unused repositories that you need to keep for future reference. This type of backup primarily serves GitHub archival purposes, and with unlimited retention, you can store your copies for as long as needed — even indefinitely.

You can also delete repositories from your GitHub account while keeping a copy in storage, which helps bypass GitHub limits.


Backup type

Incremental and differential backups help save storage space. In GitProtect you can define different retention and performance settings for each type of backup (full, incremental, and differential). For example, our software allows you to include only the parts of GitHub data that have changed since the last backup, reducing storage usage, speeding up the process, and limiting bandwidth.


Use different types of storage to replicate backups, minimize the risk of outages or disasters, and comply with the 3-2-1 backup rule (which means having at least three copies of your data on two different storage types, with at least one copy stored in the cloud).

GitProtect is a multi-storage system that allows you to store your data:

API rate limits

Learn about GitHub API rate limits.

Rate limits are enforced for security reasons to prevent a large number of requests from blocking or destabilizing the application.


GitHub limits the number of API requests that you can make within a specific time period to prevent abuse, protect against denial-of-service conditions, and maintain platform stability. Primary rate limit thresholds are determined by your authentication method, though specific resource-intensive endpoints—such as search APIs—enforce stricter request quotas.

You can learn more about GitHub API rate limits in the official GitHub documentation.


Adding multiple storage instances

General information

Useful links and items

Creating a backup plan

This article contains information on how to set up a GitHub backup plan.

Backup plan setup

1

Login to GitProtect Management Service, open the Plans > Backup tab and click the Add plan button in the top bar.

2

Select GitHub from the list.

3

Select (or add) the GitHub environment you want to include in the backup process, and choose the repositories to back up.

4

Specify a name for the backup plan.

5

Select the appropriate metadata that you want to back up. Here, you can also change the default worker, which is the device directly responsible for the backup process of your repositories.

6

Select one of the locations assigned to your GitProtect instance as storage.

7

Customize the scheduler and specify how long your data should be retained. If needed, adjust the advanced settings to suit your needs.

8

If necessary, adjust the advanced settings such as encryption, error handling, or bandwidth limits to fit your requirements.

9

Double-check your data and click Save to create the backup plan.


In GitProtect, you can select repositories based on custom properties, but these properties must be configured at the organization level in GitHub. During synchronization, GitProtect retrieves the property definitions from the organization and the assigned values from the repositories. After synchronization, the panel displays a list of all properties fetched from every organization on the GitHub side that was added to Management Service. For the feature to work correctly, the token used for authorization must also include the read:org permission.

Optionally, GitProtect allows you to protect the entire GitHub environment.

You can have multiple workers and assign different workers to each backup plan.

It is worth noting that the cloud worker (a cloud-installed GitProtect worker) allows you to perform cloud-to-cloud backups if you want to store your backups in the cloud.

Useful links and items

Cloud storage
Scheduler & retention
Rate limits for the REST API - GitHub DocsGitHub Docs

Protected resources

Overview of protected GitHub resources, including repositories, wikis, and metadata secured by backup.

GitHub protected resources define which repositories and data GitProtect can access, secure, and restore.


The following list includes all GitHub resources covered by backup.

Backup coverage

Support for backing up projects (classic) has been removed. It is now available only for restoring previously backed-up projects (classic). When restored, projects (classic) are automatically converted to projects v2. Protected metadata for projects (classic) includes cards, issues assigned to cards, pull requests assigned to cards, columns, and notes.

The list is presented in alphabetical order.

ACTIONS AND PIPELINES
BRANCH PROTECTION RULES
COLLABORATORS
DEPENDABOT
ISSUES
LABELS
MILESTONES
PROJECTS (V2)
PULL REQUESTS
REPOSITORY
TEAMS
RELEASES
Automatically delete head branches
  • Logo