mirror of https://github.com/restic/restic.git
85 lines
2.4 KiB
ReStructuredText
85 lines
2.4 KiB
ReStructuredText
|
REST Backend
|
||
|
|
============
|
||
|
|
|
||
|
|
Restic can interact with HTTP Backend that respects the following REST
|
||
|
|
API. The following values are valid for ``{type}``: ``data``, ``keys``,
|
||
|
|
``locks``, ``snapshots``, ``index``, ``config``. ``{path}`` is a path to
|
||
|
|
the repository, so that multiple different repositories can be accessed.
|
||
|
|
The default path is ``/``.
|
||
|
|
|
||
|
|
POST {path}?create=true
|
||
|
|
-----------------------
|
||
|
|
|
||
|
|
This request is used to initially create a new repository. The server
|
||
|
|
responds with "200 OK" if the repository structure was created
|
||
|
|
successfully or already exists, otherwise an error is returned.
|
||
|
|
|
||
|
|
DELETE {path}
|
||
|
|
-------------
|
||
|
|
|
||
|
|
Deletes the repository on the server side. The server responds with "200
|
||
|
|
OK" if the repository was successfully removed. If this function is not
|
||
|
|
implemented the server returns "501 Not Implemented", if this it is
|
||
|
|
denied by the server it returns "403 Forbidden".
|
||
|
|
|
||
|
|
HEAD {path}/config
|
||
|
|
------------------
|
||
|
|
|
||
|
|
Returns "200 OK" if the repository has a configuration, an HTTP error
|
||
|
|
otherwise.
|
||
|
|
|
||
|
|
GET {path}/config
|
||
|
|
-----------------
|
||
|
|
|
||
|
|
Returns the content of the configuration file if the repository has a
|
||
|
|
configuration, an HTTP error otherwise.
|
||
|
|
|
||
|
|
Response format: binary/octet-stream
|
||
|
|
|
||
|
|
POST {path}/config
|
||
|
|
------------------
|
||
|
|
|
||
|
|
Returns "200 OK" if the configuration of the request body has been
|
||
|
|
saved, an HTTP error otherwise.
|
||
|
|
|
||
|
|
GET {path}/{type}/
|
||
|
|
------------------
|
||
|
|
|
||
|
|
Returns a JSON array containing the names of all the blobs stored for a
|
||
|
|
given type.
|
||
|
|
|
||
|
|
Response format: JSON
|
||
|
|
|
||
|
|
HEAD {path}/{type}/{name}
|
||
|
|
-------------------------
|
||
|
|
|
||
|
|
Returns "200 OK" if the blob with the given name and type is stored in
|
||
|
|
the repository, "404 not found" otherwise. If the blob exists, the HTTP
|
||
|
|
header ``Content-Length`` is set to the file size.
|
||
|
|
|
||
|
|
GET {path}/{type}/{name}
|
||
|
|
------------------------
|
||
|
|
|
||
|
|
Returns the content of the blob with the given name and type if it is
|
||
|
|
stored in the repository, "404 not found" otherwise.
|
||
|
|
|
||
|
|
If the request specifies a partial read with a Range header field, then
|
||
|
|
the status code of the response is 206 instead of 200 and the response
|
||
|
|
only contains the specified range.
|
||
|
|
|
||
|
|
Response format: binary/octet-stream
|
||
|
|
|
||
|
|
POST {path}/{type}/{name}
|
||
|
|
-------------------------
|
||
|
|
|
||
|
|
Saves the content of the request body as a blob with the given name and
|
||
|
|
type, an HTTP error otherwise.
|
||
|
|
|
||
|
|
Request format: binary/octet-stream
|
||
|
|
|
||
|
|
DELETE {path}/{type}/{name}
|
||
|
|
---------------------------
|
||
|
|
|
||
|
|
Returns "200 OK" if the blob with the given name and type has been
|
||
|
|
deleted from the repository, an HTTP error otherwise.
|