Przegląd

Ten artykuł zawiera przegląd interfejsu programistycznego REST (API) w Xopero ONE.

Informacje ogólne

Ogólnie rzecz biorąc, RESTful API to styl architektoniczny interfejsu programowania aplikacji (API), który wykorzystuje żądania HTTP do uzyskiwania dostępu do danych i ich używania — dane te można odczytywać, aktualizować, tworzyć lub usuwać za pomocą metod GET, PUT, POST i DELETE.

circle-info

Dowiesz się więcej o dostępnych metodach REST API w tym artykule.

REST API Xopero ONE umożliwia użytkownikom wykonywanie działań powszechnie kojarzonych z integracją z usługami Git (takimi jak GitHub, GitLab i Bitbucket). Za pomocą REST API możesz wyświetlić listę swoich organizacji Git, sprawdzić status najnowszego planu backupu, modyfikować plany backupu, dołączać licencje do wybranych repozytoriów i nie tylko.

REST API może być używane przez każdego użytkownika z rolą Administratora Systemu, który jest zarejestrowany w danej instancji Xopero ONE.


Punkty końcowe API (endpoints)

Korzystając z dostępnych metod, możesz uzyskać dostęp do następujących punktów końcowych REST API:

circle-exclamation
Endpoint
Description

/account/login

Uwierzytelnienie użytkownika i uzyskanie tokenu dostępu.

/git/organizations/getmany

Wyświetlenie listy organizacji Git powiązanych z Twoim kontem.

/plans/attachgitrepository

Dołączenie repozytorium Git do planu backupu.

/plans/detachgitrepository

Odłączenie repozytorium Git od planu backupu.

/plans/listassignedtoorganization

Wyświetlenie listy wszystkich planów backupu przypisanych do określonej organizacji Git.

/plans/modifygitplan

Modyfikacja ustawień istniejącego planu backupu Git.

/git/repositories/activate

Aktywacja repozytorium Git do backupu.

/git/repositories/deactivate

Dezaktywacja repozytorium Git w celu wstrzymania backupu.

/git/repositories/getmany

Pobranie informacji o wielu repozytoriach Git.

/git/repositories/remove

Usunięcie repozytorium Git z systemu.

/git/repositories/sync

Synchronizacja danych repozytorium z systemem Xopero ONE.

Last updated