REST API

This article describes use cases for the REST API available in GitProtect.

With GitProtect REST API for DevOps ecosystems, you can automate backup and restore tasks, integrating them seamlessly into your development workflows.

---

Getting the latest backup plan status

The following guide applies to GitHub, Bitbucket & GitLab only.

First, use the authorization method to obtain a token, which allows you to perform further operations. After obtaining the token, select the appropriate authentication method as described in the API authentication article.

Once authorized, you can use the getMany method to list all your organizations along with their backup plans and most recent statuses.

---

Activating a license for the repository

First, use the authorization method to obtain a token, which allows you to perform further operations. After getting the token, select the appropriate authentication method as described in the API authentication article.

Once authorized, use the getMany method to find the repository names and IDs required for the next step. After collecting the repository IDs, use the Activate method with an array of the selected repository IDs to activate the license.

---

Deactivating the license for the repository

First, use the authorization method to obtain a token, which allows you to perform further operations. After getting the token, select the appropriate authentication method as described in the API authentication article.

Once authorized, use the getMany method to find the repository names and IDs required for the next step. After collecting the repository IDs, use the Deactivate method with an array of the selected repository IDs to deactivate the license.

---

Attach repository to a backup plan

First, use the authorization method to obtain a token, which allows you to perform further operations. After getting the token, select the appropriate authentication method as described in the API authentication article.

Once authorized, use the getMany method (GitOrganizationController) to find the backup plan ID and the getMany method (GitRepositoryController) to obtain the repository ID. After collecting the repository and plan IDs, use the Attach method with the selected repository ID and plan ID pair.