diff options
| author | zotlabs <mike@macgirvin.com> | 2017-06-11 23:28:55 -0700 |
|---|---|---|
| committer | Mario Vavti <mario@mariovavti.com> | 2017-06-14 16:43:35 +0200 |
| commit | 36cfdd529b51997977340b0de0375af2025bd6d4 (patch) | |
| tree | 98a551951a6b9a23ea4a210bb7a3909878b30b9d /doc | |
| parent | 3e13568f916d22c8016c479cbc4beca2b455072e (diff) | |
| download | volse-hubzilla-36cfdd529b51997977340b0de0375af2025bd6d4.tar.gz volse-hubzilla-36cfdd529b51997977340b0de0375af2025bd6d4.tar.bz2 volse-hubzilla-36cfdd529b51997977340b0de0375af2025bd6d4.zip | |
doco for the channel basic export api call
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/api_zot.bb | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/developer/api_zot.bb b/doc/developer/api_zot.bb index a114c7c44..b2c19d7a1 100644 --- a/doc/developer/api_zot.bb +++ b/doc/developer/api_zot.bb @@ -4,7 +4,20 @@ The API endpoints detailed below are relative to [code]api/z/1.0[/code], meaning [h3]channel/export/basic[/h3] -Export channel data +Export basic channel data + +Options: + - sections + comma-separated list of data types to export + + - posts + if true, return default sections plus 3 months of posts + + If no sections are requested, the following sections are returned: + channel, connections, config, apps, chatrooms, events, webpages, mail, wikis + + Files and large collections of posts may run into memory limits; these must generally be + requested separately. [h3]channel/stream[/h3] |