1 of 3

REST API for DevOps ecosystems

Learn about the Xopero ONE REST API for DevOps organizations and how to use it effectively.

Overview & authentication

Overview of Xopero ONE REST API for DevOps ecosystems, including authentication methods and key endpoints for managing backup operations.

The REST API in Xopero ONE exposes programmatic endpoints tailored for DevOps ecosystems — using standard HTTP requests and structured responses, external systems, scripts, and automation tools can retrieve information about protected resources, backup jobs, repositories, and storage configuration, as well as trigger selected management actions.

General information

REST (Representational State Transfer) is an architectural style for designing application programming interfaces (APIs) that use HTTP requests to interact with and perform operations on resources identified by URLs. With a REST API, data can be created, read, updated, or deleted using the HTTP methods such as POST, GET, PUT, and DELETE.

The Xopero ONE REST API allows users to manage backups for Git services such as GitHub, GitLab, Azure DevOps, and Bitbucket. With the REST API, you can list Git organizations, check the status of an organization’s backup plans, modify backup plans, activate licenses for selected repositories, and perform other related operations.

The REST API can be used by any user with the System Administrator role who is registered in the same Xopero ONE instance. Some requests require accounts with additional permissions, which are specified in the request description.

Xopero ONE REST API endpoints use the POST HTTP method.

Xopero ONE REST API requires API authentication and API authorization.

Authentication is done by sending a POST sign-in request. The sign-in request generates an access token, which is required to authorize all subsequent API requests.

For example, to use an access token in a POST getMany request in Postman, open the Authorization tab, select Bearer Token as the authorization type, and paste the access token in the Token field. Then, adjust the required parameters and send the request. The access token includes the necessary permissions to perform the endpoint’s operation.

Requests can be sent to the following API endpoints.

HTTP method and path

Description

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.

An access token must be used to authorize all API requests (except for sign-in). For more information on API authentication, see .

HTTP method and path

Description

Overview & authentication

Overview of Xopero ONE REST API for DevOps ecosystems, including authentication methods and key endpoints for managing backup operations.

General information

Xopero ONE REST API endpoints use the POST HTTP method.

Xopero ONE REST API requires API authentication and API authorization.

Authentication is done by sending a POST sign-in request. The sign-in request generates an access token, which is required to authorize all subsequent API requests.

Requests can be sent to the following API endpoints.

HTTP method and path

Description

Available API requests

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

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.

An access token must be used to authorize all API requests (except for sign-in). For more information on API authentication, see .

HTTP method and path

Description

POST /account/login

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

The access token generated with the POST sign-in request is valid for 30 days.

API endpoint:

POST https://server_address/account/login

Parameters:

Key

Value description

Value type

Request example:

Response example:

POST /git/organizations/getmany

Retrieve a list of Git organizations.

API endpoint:

POST https://server_address/git/organizations/getmany

Parameters:

This API request now requires additional keys: filters, thenOrderBy, and thenOrderByType. By default, all of them should contain empty values, although filters can be adjusted as needed.

Key

Value description

Value type

_*_{Each object in}_filters_{must contain values for three properties:}_operator_,_value_{, and}_property_{. Supported}_operator_{values include:}_notin_,_eq_,_neq_,_gt_,_gte

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:

POST https://server_address/plans/attachgitrepository

Parameters:

Key

Value description

Value type

_*_{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.

Works only for plans with individual project selection.

API endpoint:

POST https://server_address/plans/attachazureproject

Parameters:

Key

Value description

Value type

_*_{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:

POST https://server_address/plans/detachgitrepository

Parameters:

Key

Value description

Value type

_*_{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.

Works only for plans with individual project selection.

API endpoint:

POST https://server_address/plans/detachazureproject

Parameters:

Key

Value description

Value type

_*_{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:

POST https://server_address/plans/modifygitplan

Parameters:

Key

Value description

Value type

_*_{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:

POST https://server_address/plans/modifyazureplanasync

Parameters:

Key

Value description

Value type

_*_{You can use the}_getMany_{request to find the specific backup plan ID.}

Request example:

Response example:

POST /git/repositories/getmany

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

API endpoint:

POST https://server_address/git/repositories/getmany

Parameters:

This API request now requires additional keys: filters, thenOrderBy, and thenOrderByType. By default, all of them should contain empty values, although filters can be adjusted as needed.

Key

Value description

Value type

_*_{Each object in}_filters_{must contain values for three properties:}_operator_,_value_{, and}_property_{. Supported}_operator_{values include:}_notin_,_eq_,_neq_,_gt_,_gte

Request example:

Response example:

POST /git/repositories/activate

Activate licenses for selected Git repositories.

Authorization requires a user account with one of the following roles: DataRemoveManagement or GitManagement.

API endpoint:

POST https://server_address/git/repositories/activate

Parameters:

Key

Value description

Value type

Request example:

Response example:

POST /git/repositories/deactivate

Deactivate licenses for selected Git repositories.

Authorization requires a user account with one of the following roles: DataRemoveManagement or GitManagement.

API endpoint:

POST https://server_address/git/repositories/deactivate

Parameters:

Key

Value description

Value type

Request example:

Response example:

POST /git/repositories/remove

Delete a repository data from the Xopero ONE system.

Authorization requires a user account with one of the following roles: DataRemoveManagement or GitManagement.

API endpoint:

POST https://server_address/git/repositories/remove

Parameters:

Key

Value description

Value type

Request example:

Response example:

{
    "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
                }
            ]
        }
    ]
}

JSON

{
   "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"
}

JSON

{
  "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
}

{
    "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
}

REST API for DevOps ecosystems

Overview & authentication

General information

Available API requests

API endpoint list

Overview & authentication

General information

Authentication

API endpoints

Useful links and items

REST API for DevOps ecosystems

Available API requests

API endpoint list

Account

Organization

Backup

Repository