Overview

This article provides an overview of the Xopero ONE REST application programming interface (API).

General information

In general, a RESTful API is an architectural style for an application programming interface (API) that uses HTTP requests to access and use data— it can be read, updated, created, or deleted using the GET, PUT, POST, and DELETE methods.

Learn more about all available REST API methods in this article.

The Xopero ONE REST API allows users to perform actions commonly associated with Git services (such as GitHub, GitLab, and Bitbucket) integration. With REST API, you can list your Git organizations, check the status of your latest backup plan, modify backup plans, attach licenses to selected repositories, and more.

REST API can be used by any user with the System Administrator role who is registered in the specific Xopero ONE instance.

---

API endpoints

You can access the following REST API endpoints using the available methods:

All of the following REST API endpoints use the POST method.

Endpoint	Description
/account/login	Authenticate a user and obtain an access token.
/git/organizations/getmany	List Git organizations associated with your account.
/plans/attachgitrepository	Attach a Git repository to a backup plan.
/plans/detachgitrepository	Detach a Git repository from a backup plan.
/plans/listassignedtoorganization	List all backup plans assigned to a specific Git organization.
/plans/modifygitplan	Modify the settings of an existing Git backup plan.
/git/repositories/activate	Activate a Git repository for backup.
/git/repositories/deactivate	Deactivate a Git repository to stop backup.
/git/repositories/getmany	Retrieve information about multiple Git repositories.
/git/repositories/remove	Remove a Git repository from the system.
/git/repositories/sync	Synchronize repository data with the Xopero ONE system.