For the complete documentation index, see llms.txt. This page is also available as Markdown.

Available API requests

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

Xopero ONE 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 Xopero ONE API endpoints, along with a short description and a link to the full API request documentation.

HTTP method and path
Description

Log in to Xopero ONE Management Service and obtain an access token.

List Git organizations integrated with Xopero ONE.

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 Xopero ONE system.

Synchronize organization data with the Xopero ONE system.


Account

POST /account/login

Log in to Xopero ONE Management Service.

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

API endpoint:

Parameters:

Key
Value description
Value type

email

Xopero ONE username (email address).

String

password

Xopero ONE password.

String

rememberMe

Specifies whether to remember the session.

Boolean

Request example:

Response example:


Organization

POST /git/organizations/getmany

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>

*Each object in filters must contain values for three properties: operator, value, and property. Supported operator values include: notin, eq, neq, gt, gte, lt, lte, contains, icontains, and startswith. value specifies the value used for filtering in combination with the selected operator. The available property values depend on the resource being filtered — for organizations, the supported values are: id, name, displayName, driver, defaultWorkerId, autoAssignLicences, syncInterval, registrationDate, isReadOnly, protectedRepositories, totalGroups, and totalProjects.

Request example:

Response example:


Backup

POST /plans/listassignedtoorganization

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:

POST /plans/attachgitrepository

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:

POST plans/AttachAzureProject

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

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:

POST /plans/detachgitrepository

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:

POST plans/DetachAzureProject

Remove an Azure DevOps project from a backup plan.

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:

POST /plans/modifygitplan

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:

POST plans/ModifyAzurePlanAsync

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

POST /git/repositories/getmany

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>

*Each object in filters must contain values for three properties: operator, value, and property. Supported operator values include: notin, eq, neq, gt, gte, lt, lte, contains, icontains, and startswith. value specifies the value used for filtering in combination with the selected operator. The available property values depend on the resource being filtered — for repositories, the supported values are: id, projectId, serverId, organizationId, name, slug, project, licenceId, licenceAssigment, Availability, isProtected, lastBackupDate, lastSuccessfulBackupDate, nextBackup, status, and lastBackupTaskStatus.

Request example:

Response example:

POST /git/repositories/activate

Activate licenses for selected Git repositories.

API endpoint:

Parameters:

Key
Value description
Value type

Ids

Repository IDs to be activated.

Array<Guid>

Request example:

Response example:

POST /git/repositories/deactivate

Deactivate licenses for selected Git repositories.

API endpoint:

Parameters:

Key
Value description
Value type

Ids

Repository IDs to be deactivated.

Array<Guid>

Request example:

Response example:

POST /git/repositories/remove

Delete a repository data from the Xopero ONE system.

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:

POST /git/repositories/sync

Run synchronization for the selected Git organization.

API endpoint:

Parameters:

Key
Value description
Value type

id

Organization ID.

Guid

Request example:

Response example:

Last updated

Was this helpful?