diff options
Diffstat (limited to 'core/api-sync.rst')
| -rw-r--r-- | core/api-sync.rst | 29 |
1 files changed, 23 insertions, 6 deletions
diff --git a/core/api-sync.rst b/core/api-sync.rst index 759a4c3f..c2c86c23 100644 --- a/core/api-sync.rst +++ b/core/api-sync.rst @@ -18,7 +18,7 @@ .. _sync-api: ====================================== -Backup and Synchronization Service API +Backup and Synchronization RESTful API ====================================== The backup and synchronization service uses an EdDSA key @@ -102,14 +102,20 @@ over TLS, and that the synchronization service is trusted to not build user's location profiles by linking client IP addresses and client keys. +.. contents:: Table of Contents + :local: --------------------------- -Receiving Terms of Service --------------------------- + +.. include:: tos.rst + +----------------------- +Receiving Configuration +----------------------- .. http:get:: /config - Obtain the terms of service provided by the storage service. + Obtain the key configuration settings of the storage service. + This specification corresponds to ``current`` protocol being version **2**. **Response:** @@ -135,11 +141,18 @@ Receiving Terms of Service // The format is "current:revision:age". version: string; - } + // URN of the implementation (needed to interpret 'revision' in version). + // @since v2, may become mandatory in the future. + implementation?: string; + } .. _sync: +---------------------- +Recovering Backup Data +---------------------- + .. http:get:: /backups/${ACCOUNT-KEY} Download latest version of the backup. @@ -200,6 +213,10 @@ Receiving Terms of Service signature validation. +--------------------- +Uploading Backup Data +--------------------- + .. http:post:: /backups/${ACCOUNT-KEY} Upload a new version of the account's database, or download the |