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.
The table below lists all available Xopero ONE API endpoints, along with a short description and a link to the full API request documentation.
An access token must be used to authorize all API requests (except for sign-in). For more information on API authentication, see .
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.
ltecontainsicontainsstartswithvalueoperatorpropertyidnamedisplayNamedriverdefaultWorkerIdautoAssignLicencessyncIntervalregistrationDateisReadOnlyprotectedRepositoriestotalGroupstotalProjectsltecontainsicontainsstartswithvalueoperatorpropertyidprojectIdserverIdorganizationIdnameslugprojectlicenceIdlicenceAssigmentAvailabilityisProtectedlastBackupDatelastSuccessfulBackupDatenextBackupstatuslastBackupTaskStatusemail
Xopero ONE username (email address).
String
password
Xopero ONE password.
String
rememberMe
Specifies whether to remember the session.
Boolean
{
"email":"admin@company.com",
"password":"admin123",
"rememberMe":true
}{
"userId":"a4ac78431-30c2-4d65-bd3e-eb6416784c", "accessToken":"yMDA1LzA1L2lka4acXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6ImZiODZiNDMxLTMwYzItNGQ2NS1iZDNlLWViNjQxzL25hbWUiOiJhjm1lbG9uQHhvcGVyby5jb20iLCJodHRwOhjvc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2a4aclbWFpbGFkZHJlc3MiOiJtLm1lbG9uQHhvcGVyby5jb20iLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiU3l50IiwiVXNlck1hbmFnZW1lbnQiXSwiZXhwIjoxNjU0NjkwNhj4LCJpc3MiOiJodHRa4acxob3N0OjUwMDAiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0OjUwMDAifQ.eHVRw1KqYi3SOqN-AJUXoEIFKxGVokhoMp910L1LkzA"
}limit
Number of organizations per page.
Integer
orderby
Specifies the field and sort direction for returned results.
String
ordertype
Specifies the sort order.
String
{
"limit": 2,
"orderby": "Name",
"ordertype": "asc",
"thenOrderBy": "",
"thenOrderByType": "",
"Page": 2,
"filters": []
}{
"currentPage": 2,
"pageCount": 2,
"totalEntries": 4,
"result": [
{
"id": "a4ac2cd0-ed2f-4ced-be39-60c631e033ff",
"driver": 1,
"name": "OrgName",
"apiUrl": null,
"isReadOnly": false,
"protectedRepositories": 43,
"totalRepositories": 58,
"missingLicences": 58,
"removedRepositories": 15,
"defaultWorkerId": "a4ac11eb-bbe7-406e-b3da-24fb4df5642a",
"isCreatedByMarketplace": false,
"synchronizationInProgress": false,
"plans": [
{
"id": "a4acff69-266e-4771-b47b-fd5e4fae6a40",
"name": "name1",
"backupType": 5,
"includeMetadata": true,
"repoCount": 1,
"lastStatus": {
"successes": 0,
"warnings": 0,
"errors": 1
},
"planFinishedTime": 1643754961233,
"isRunning": false
},
{
"id": "a4ac8dd-6bf4-4c6c-8bc3-7305a9cc4dad",
"name": "name2",
"backupType": 5,
"includeMetadata": true,
"repoCount": 1,
"lastStatus": {
"successes": 0,
"warnings": 0,
"errors": 1
},
"planFinishedTime": 1643754482141,
"isRunning": false
},
{
"id": "a4ac8001-1d3f-45ae-bb7a-49e86286ad6b",
"name": "name3",
"backupType": 5,
"includeMetadata": true,
"repoCount": 1,
"lastStatus": {
"successes": 0,
"warnings": 0,
"errors": 1
},
"planFinishedTime": 1643754482453,
"isRunning": false
}
]
},
{
"id": "a4ac6bff8-0000-0000-0000-000000000000",
"driver": 2,
"name": "xopero",
"apiUrl": null,
"isReadOnly": false,
"protectedRepositories": 1,
"totalRepositories": 775,
"missingLicences": 676,
"removedRepositories": 0,
"defaultWorkerId": "a4ac0f30-6641-a4ac7-ac26-fd7e47abf8f3",
"isCreatedByMarketplace": false,
"synchronizationInProgress": false,
"plans": [
{
"id": "3a4ac5-fdd1-4a4ac1-9415-66d0fbedb0e0",
"name": "name1",
"backupType": 5,
"includeMetadata": true,
"repoCount": 1,
"lastStatus": {
"successes": 1,
"warnings": 0,
"errors": 0
},
"planFinishedTime": 1645136722019,
"isRunning": false
},
{
"id": "a4aca5252-2d02-a4ac-8a24-e2be4598c8ce",
"name": "name2",
"backupType": 5,
"includeMetadata": true,
"repoCount": 1,
"lastStatus": {
"successes": 0,
"warnings": 1,
"errors": 0
},
"planFinishedTime": 1645115366992,
"isRunning": false
},
{
"id": "a4acb8c-7b2a-a4ac83-8167-44a9a1e14272",
"name": "name3",
"backupType": 5,
"includeMetadata": true,
"repoCount": 1,
"lastStatus": {
"successes": 0,
"warnings": 1,
"errors": 0
},
"planFinishedTime": 1645115380587,
"isRunning": false
}
]
}
]
}limit
Specifies the maximum number of results to return in a single API response.
Integer
page
Page number.
Integer
organizationid
Organization ID.
Guid
{
"limit":5,
"page":5,
"organizationid":"a4a4acgd0-eg78f-4a4ac-kl39-99ka4ac1e777ff"
}{
"currentPage": 5,
"pageCount": 5,
"totalEntries": 23,
"result": [
{
"id": "ea6a260b-a4ac-4204-a92d-918e6940b136",
"name": "example1",
"includeAllRepositories": false,
"repositoryIds": [
"c1961c1c-a425-a4ac-8757-32d5b6fc9aeb"
]
},
{
"id": "fba158dd-6bf4-a4ac-8bc3-7305a9cc4dad",
"name": "example2",
"includeAllRepositories": false,
"repositoryIds": [
"de5c5995-b422-43c4-90b7-7ee182480dbb"
]
},
{
"id": "fdb48001-1d3f-45ae-bb7a-49e86286ad6b",
"name": "example3",
"includeAllRepositories": false,
"repositoryIds": [
"a4ac5995-b422-43c4-a4ac-7ee182480dbb"
]
}
]
}planid
Backup plan ID*.
Guid
repositoryid
Repository ID.
Guid
{
"planid":"hjkhkj60b-baac-4564-a92d-918e6940b136",
"repositoryid":"ca4ac8f1c-a425-4869-8757-32c6567gc9aeb"
}200 OKplanId
Backup plan ID*.
Guid
projectId
Project ID.
Guid
{
"planId":"ea6a260b-brrc-4204-a56c-918e6940b136",
"projectId": "c1961r1e-a425-4769-8757-32d6b6fc7aeb"
}200 OKplanid
Backup plan ID*.
Guid
repositoryid
Repository ID.
Guid
{
"planid":"hjkhkj60b-baac-4564-a92d-918e6940b136",
"repositoryid":"a4ac8f1c-a425-48hj-8757-32hj567gchjeb"
}200 OKplanId
Backup plan ID*.
Guid
projectId
Project ID.
Guid
{
"planId": "05d46e44-f026-4cf9-a64a-1dd97328808c",
"projectId": "022056bd-0044-0000-0000-004400000003"
}200 OKid
Backup plan ID*.
Guid
isActive
Indicates whether the schedule is currently enabled (true) or disabled (false).
Boolean
name
Backup plan name.
String
{
"id":"a4acc15-b08b-40cb-a4ac-5e40ea4ac54",
"isActive":true,
"name":"example",
"backupType":5,
"schedule":{
"id":"a4ac21-6da6-4c8c-a4ac5-f2ffca4ac516",
"scheme":3,
"delay":0,
"preventSystemSleep":false,
"options":[
{
"type":1,
"trigger":1,
"frequency":1,
"days":[
1
],
"startAt":[
{
"hour":17,
"minute":25
}
],
"interval":0,
"nthDayOfWeek":0
},
{
"type":3,
"trigger":1,
"frequency":3,
"days":[
1,
2,
3,
4,
5
],
"startAt":[
{
"hour":17,
"minute":25
}
],
"interval":0,
"nthDayOfWeek":0
}
],
"backupWindow":
[
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
],
"retention":{
"id":"00000000-0000-0000-0000-000000000000",
"rule":1,
"options":null,
"order":0
}
},
"compressionSettings":{
"codec":2,
"level":2
},
"encryptionSettings":null,
"customActions":{
"preBackupAction":null,
"postSnapshotAction":null,
"postBackupAction":null
},
"advancedOptions":{
"useVss":"True",
"maxTaskRetriesCount":"3",
"taskRetriesFrequency":"60000",
"maxConcurrentTasks":"5",
"processorProperties_PartSize":"1048576"
},
"deltaSettings":null,
"workerId":"a4ac1eb-bbe7-a4ac-b3da-a4acf5642a",
"filteringSettings":null,
"organizationId":"a4ac2cd0-ea4ac-4ced-be39-6a4ace033ff",
"repositoriesIds":[
"c1961c1c-a425-4769-8757-32d5b6fc9aeb"
],
"includeAllRepositories":false,
"includeMetadata":true,
"storageId":"a4ac74ac-7a4ac-4fec-9448-a4ace9267d7"
}200 OKid
Backup plan ID*.
Guid
isActive
Indicates whether the schedule is currently enabled (true) or disabled (false).
Boolean
name
Backup plan name.
String
{
"id":"f4b99db4-c0e9-4111-9292-ffc5812aad2c",
"isActive":true,
"name":"Plan DevOps",
"backupType":10,
"schedule":{
"scheme":5,
"options":[
{
"type":0,
"trigger":1,
"frequency":3,
"days":[
0,
1,
2,
3,
4,
5,
6
],
"startAt":[
{
"hour":9,
"minute":29
}
],
"nthDayOfWeek":0,
"interval":0
}
],
"retention":{
"rule":3,
"options":[
{
"number":3,
"period":1,
"type":0
}
],
"order":0
},
"backupWindow":[
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
]
},
"compressionSettings":{
"codec":2,
"level":2
},
"encryptionSettings":null,
"customActions":{
"preBackupAction":{
"windows":{
"enabled":true,
"scriptType":0,
"command":"C:\\Users\\Name\\Desktop\\test.bat",
"passwordId":"00000000-0000-0000-0000-000000000000",
"arguments":null
},
"unix":{
"enabled":false
},
"waitForExecution":true,
"waitingInterval":0
},
"postSnapshotAction":null,
"postBackupAction":null
},
"advancedOptions":{
"useVss":"True",
"maxTaskRetriesCount":3,
"taskRetriesFrequency":60000,
"maxConcurrentTasks":5,
"largeResourcesBufferSize":134217728
},
"deltaSettings":null,
"notificationSettings":{
"enabled":false,
"planNotificationsConfiguration":null,
"recipients":[
]
},
"workerId":"758fa497-f93b-436f-9571-2a3f7d496ac1",
"filteringSettings":null,
"ignoreCorruptedAttachments":false,
"organizationId":"017f210e-0edd-6645-82a8-f9c9c3cae4d6",
"gitChoiceMode":3,
"repositoriesIds":[
],
"excludedRepositoriesIds":[
],
"projectsIds":[
],
"wikisIds":[
],
"additionalCredentials":[
],
"rules":[
{
"choiceMode":2,
"type":2,
"ruleChoice":{
"meetAllRules":false,
"rules":[
]
}
},
{
"choiceMode":2,
"type":1,
"ruleChoice":{
"meetAllRules":false,
"rules":[
]
}
}
],
"storageId":"718fgta6-fo5c-4194-8d4e-13e91cd68a70",
"type":1
}200 OKid
Organization ID.
Guid
limit
Defines the number of repositories returned per page.
Integer
orderby
Specifies the field used to sort the returned results.
String
{
"id": "a4ac2cd0-a4ac-4ced-be39-a4ac31e033ff",
"limit": 2,
"orderby": "Name",
"ordertype": "asc",
"thenOrderBy": "",
"thenOrderByType": "",
"page": 1,
"filters":[
{
"operator": "eq",
"value": true,
"property": "IsRemoved"
}
]
}{
"currentPage": 1,
"pageCount": 1,
"totalEntries": 2,
"result": {
"synchronizationInProgress": false,
"lastSynchronizationRepositoriesStartTime": 1645546071481,
"repositories": [
{
"id": "a4ac3ac7d-99e4-a4ac-b5a4-a4acdeee5",
"serverId": "a4acac7d-99e4-a4ac-b5a4-ea4ac2deee5",
"name": "org/repo1",
"lastBackup": 0,
"lastSuccessfulBackup": 0,
"nextBackup": 0,
"isProtected": true,
"isRemoved": true,
"status": 2,
"lastBackupTaskStatus": 0,
"isPublic": false
},
{
"id": "a4acf294-b30e-a4ac-aabb-6a4ac6578686",
"serverId": "a4ac294-b30e-a4ac-aabb-63a4ac578686",
"name": "org/repo2",
"lastBackup": 0,
"lastSuccessfulBackup": 0,
"nextBackup": 1645556400000,
"isProtected": true,
"isRemoved": true,
"status": 2,
"lastBackupTaskStatus": 0,
"isPublic": false
}
],
"removedRepositories": 15
}Ids
Repository IDs to be activated.
Array<Guid>
{
"Ids":[
"a4ac979e-0000-0000-0000-000000000000",
"a4acca07-0000-0000-0000-000000000000",
"a4ac7c5-0000-0000-0000-000000000000",
"a4ac9d7a-0000-0000-0000-000000000000",
"1a4ac9bc9-0000-0000-0000-000000000000",
"a4ac79fe9-0000-0000-0000-000000000000",
"a4ac3f220-0000-0000-0000-000000000000",
"a4aca817-0000-0000-0000-000000000000"
]
}{
"success": [],
"error": [
{
"id": "a4ac7979e-0000-0000-0000-000000000000",
"errorCode": "LI5020"
},
{
"id": "a4acdca07-0000-0000-0000-000000000000",
"errorCode": "LI5020"
},
{
"id": "a4ac797c5-0000-0000-0000-000000000000",
"errorCode": "LI5020"
},
{
"id": "a4ac79d7a-0000-0000-0000-000000000000",
"errorCode": "LI5020"
},
{
"id": "a4ac79bc9-0000-0000-0000-000000000000",
"errorCode": "LI5020"
},
{
"id": "a4ac79fe9-0000-0000-0000-000000000000",
"errorCode": "LI5020"
},
{
"id": "a4ac3f220-0000-0000-0000-000000000000",
"errorCode": "LI5020"
},
{
"id": "a4acea817-0000-0000-0000-000000000000",
"errorCode": "LI5020"
}
]
}Ids
Repository IDs to be deactivated.
Array<Guid>
{
"Ids":[
"a4ac7979e-0000-0000-0000-000000000000",
"a4acdca07-0000-0000-0000-000000000000",
"a4ac797c5-0000-0000-0000-000000000000",
"a4ac79d7a-0000-0000-0000-000000000000",
"a4ac79bc9-0000-0000-0000-000000000000",
"a4ac79fe9-0000-0000-0000-000000000000",
"a4ac3f220-0000-0000-0000-000000000000",
"a4acea817-0000-0000-0000-000000000000"
]
}{
"success": [],
"error": [
{
"id": "a4ac7979e-0000-0000-0000-000000000000",
"errorCode": "GT1001"
},
{
"id": "a4acdca07-0000-0000-0000-000000000000",
"errorCode": "GT1001"
},
{
"id": "a4ac797c5-0000-0000-0000-000000000000",
"errorCode": "GT1001"
},
{
"id": "a4ac79d7a-0000-0000-0000-000000000000",
"errorCode": "GT1001"
},
{
"id": "a4ac79bc9-0000-0000-0000-000000000000",
"errorCode": "GT1001"
},
{
"id": "a4ac79fe9-0000-0000-0000-000000000000",
"errorCode": "GT1001"
},
{
"id": "a4ac3f220-0000-0000-0000-000000000000",
"errorCode": "GT1001"
},
{
"id": "a4acea817-0000-0000-0000-000000000000",
"errorCode": "GT1001"
}
]
}id
Repository IDs to be deleted.
Guid
removedata
If true, the system also deletes the backup data of the selected repository.
Boolean
{
"id": "a4acd28-eee0-404a-a4ac0-6ca4ac260ca",
"removedata": true
}{
"succeededIds": [
"a4ac8d28-eee0-a4ac-a070-6a4ac76260ca"
],
"failedIds": [],
"errors": []
}id
Organization ID.
Guid
{
"id": "a4ac2cd0-a4ac-4ced-a4ac-60ca4ac3ff"
}200 OKpage
Page number.
Integer
filters
Data filters*.
Array<filters>
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
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>
ordertype
Defines the sorting order: ascending (asc) or descending (desc).
String
page
Page number.
Integer
filters
Data filters*.
Array<filters>