Available API requests

List of GitProtect REST API requests for backup operations, including repository management, metadata handling, and organization synchronization.

GitProtect REST API provides a compact set of DevOps-oriented endpoints (implemented as POST methods) for authenticating clients, discovering and managing Git organizations and repositories, and automating backup operations such as attaching or detaching repositories, initiating synchronization, and querying organization status.


API endpoint list

The table below lists all available GitProtect API endpoints, along with a short description and a link to the full API request documentation.

circle-exclamation
HTTP method and path
Description

Log in to GitProtect Management Service and obtain an access token.

List Git organizations integrated with GitProtect.

List all backup plans assigned to the selected Git organization.

Attach a repository to a backup plan.

Attach an Azure DevOps project to a backup plan.

Remove a repository from a backup plan.

Remove an Azure DevOps project from a backup plan.

Edit settings of an existing backup plan.

Edit settings of an existing Azure DevOps backup plan.

Retrieve a list of the selected Git organization's repositories.

Activate licenses for selected repositories.

Deactivate licenses for selected repositories.

Remove a repository from the GitProtect system.

Synchronize organization data with the GitProtect system.


Account

chevron-rightPOST /account/loginhashtag

Log in to GitProtect Management Service.

circle-info

This request returns an access token, which is required for all subsequent API requests.

circle-exclamation

API endpoint:

Parameters:

Key
Value description
Value type

email

GitProtect username (email address).

String

password

GitProtect password.

String

rememberMe

Specifies whether to remember the session.

Boolean

Request example:

Response example:


Organization

chevron-rightPOST /git/organizations/getmanyhashtag

Retrieve a list of Git organizations.

API endpoint:

Parameters:

Key
Value description
Value type

limit

Number of repositories per page.

Integer

orderby

Specifies the field and sort direction for returned results.

String

ordertype

Specifies the sort order.

String

page

Page number.

Integer

filters

Data filters.

Array<filters>

Request example:

Response example:


Backup

chevron-rightPOST /plans/listassignedtoorganizationhashtag

List all backup plans to which the selected Git organization's repositories are assigned.

API endpoint:

Parameters:

Key
Value description
Value type

limit

Specifies the maximum number of results to return in a single API response.

Integer

page

Page number.

Integer

organizationid

Organization ID.

Guid

Request example:

Response example:

chevron-rightPOST /plans/attachgitrepositoryhashtag

Add a repository to a backup plan, provided that both the repository and the plan already exist.

API endpoint:

Parameters:

Key
Value description
Value type

planid

Backup plan ID*.

Guid

repositoryid

Repository ID.

Guid

*You can use the getMany request to find the specific backup plan ID.

Request example:

Response example:

chevron-rightPOST plans/AttachAzureProjecthashtag

Add an Azure DevOps project to a backup plan, provided that both the project and the plan already exist.

triangle-exclamation

API endpoint:

Parameters:

Key
Value description
Value type

planId

Backup plan ID*.

Guid

projectId

Project ID.

Guid

*You can use the getMany request to find the specific backup plan ID.

Request example:

Response example:

chevron-rightPOST /plans/detachgitrepositoryhashtag

Remove a repository from a backup plan.

API endpoint:

Parameters:

Key
Value description
Value type

planid

Backup plan ID*.

Guid

repositoryid

Repository ID.

Guid

*You can use the getMany request to find the specific backup plan ID.

Request example:

Response example:

chevron-rightPOST plans/DetachAzureProjecthashtag

Remove an Azure DevOps project from a backup plan.

triangle-exclamation

API endpoint:

Parameters:

Key
Value description
Value type

planId

Backup plan ID*.

Guid

projectId

Project ID.

Guid

*You can use the getMany request to find the specific backup plan ID.

Request example:

Response example:

chevron-rightPOST /plans/modifygitplanhashtag

Edit an existing Git backup plan.

API endpoint:

Parameters:

Key
Value description
Value type

id

Backup plan ID*.

Guid

isActive

Indicates whether the schedule is currently enabled (true) or disabled (false).

Boolean

name

Backup plan name.

String

type

Specifies the type of the backup plan.

EPlanType

backupType

Backup type.

EBackupType

storageId

Backup storage ID.

Guid

repositoriesIds

Repository ID table.

IEnumerable<Guid>

workerId

The unique identifier of the agent (worker) performing the backup operation.

Guid

schedule

Backup schedule.

BackupScheduleDTO

advancedOptions

Advanced options.

Dictionary<string, string>

compressionSettings

Compression settings.

CompressionSettingsEntry

encryptionSettings

Encryption settings.

EncryptionSettingsEntry

customActions

User defined actions.

BackupCustomActionsEntry

inculdeAllReposistories

If true, the plan ignores selected repositories and includes all repositories from the organization.

Boolean

organizationId

Organization ID.

Guid

includeMetadata

If true, backup includes metadata.

Boolean

*You can use the getMany request to find the specific backup plan ID.

Request example:

Response example:

chevron-rightPOST plans/ModifyAzurePlanAsynchashtag

Edit an existing Azure DevOps backup plan.

API endpoint:

Parameters:

Key
Value description
Value type

id

Backup plan ID*.

Guid

isActive

Indicates whether the schedule is currently enabled (true) or disabled (false).

Boolean

name

Backup plan name.

String

type

Specifies the type of the backup plan.

EPlanType

backupType

Backup type.

EBackupType

storageId

Backup storage ID.

Guid

repositoriesIds

Repository IDs to backup.

IEnumerable<Guid>

excludedRepositoriesIds

Excluded repository IDs.

IEnumerable<Guid>

projectsIds

Project IDs to backup.

IEnumerable<Guid>

wikisIds

Wiki IDs to backup.

IEnumerable<Guid>

workerId

The unique identifier of the agent (worker) performing the operation.

Guid

schedule

Backup schedule.

BackupScheduleDTO

advancedOptions

Advanced backup plan options.

Dictionary<string, string>

compressionSettings

Compression settings.

CompressionSettingsEntry

encryptionSettings

Encryption settings.

EncryptionSettingsEntry

customActions

User defined actions.

BackupCustomActionsEntry

notificationSettings

Notification settings.

NotificationSettingsEntry

organizationId

Azure DevOps organization ID.

Guid

includeMetadata

If true, the backup includes metadata.

Boolean

useExtraCredentials

Indicates whether additional credentials are used during backup of cloud organization.

Boolean

additionalCredentials

Collection of additional credentials.

Guid[]

resourceKindsToIgnore

Resource kinds to ignore.

List<int>

gitChoiceMode

Repository choice mode.

[EGitChoiceMode](Classes/EGitChoiceMode.md)

rules

Rule-based choice settings for each element: project, wiki, repository.

List<AzureDevOpsRule>

*You can use the getMany request to find the specific backup plan ID.

Request example:

Response example:


Repository

chevron-rightPOST /git/repositories/getmanyhashtag

Retrieve a list of the selected Git organization's repositories.

API endpoint:

Parameters:

Key
Value description
Value type

id

Organization ID.

Guid

limit

Defines the number of repositories returned per page.

Integer

orderby

Specifies the field used to sort the returned results.

String

ordertype

Defines the sorting order: ascending (asc) or descending (desc).

String

page

Page number.

Integer

filters

Data filters.

Array<filters>

Request example:

Response example:

chevron-rightPOST /git/repositories/activatehashtag

Activate licenses for selected Git repositories.

triangle-exclamation

API endpoint:

Parameters:

Key
Value description
Value type

Ids

Repository IDs to be activated.

Array<Guid>

Request example:

Response example:

chevron-rightPOST /git/repositories/deactivatehashtag

Deactivate licenses for selected Git repositories.

triangle-exclamation

API endpoint:

Parameters:

Key
Value description
Value type

Ids

Repository IDs to be deactivated.

Array<Guid>

Request example:

Response example:

chevron-rightPOST /git/repositories/removehashtag

Delete a repository data from the Xopero ONE system.

triangle-exclamation

API endpoint:

Parameters:

Key
Value description
Value type

id

Repository IDs to be deleted.

Guid

removedata

If true, the system also deletes the backup data of the selected repository.

Boolean

Request example:

Response example:

chevron-rightPOST /git/repositories/synchashtag

Run synchronization for the specified Git organization.

API endpoint:

Parameters:

Key
Value description
Value type

id

Organization ID.

Guid

Request example:

Response example:

Last updated

Was this helpful?