Meta tags:
Headings (most frequently used words):
endpoints, api, rest, key, result, pagination, system, config, cluster, folder, database, event, statistics, misc, services, debug, noauth, navigation, related, topics, quick, search, donate, support,
Text of the page (most frequently used words):
rest (67), get (38), #system (28), post (20), the (19), api (15), endpoints (12), key (9), syncthing (7), #folder (6), gui (5), cluster (5), config (5), and (5), used (5), http (4), for (4), this (4), svc (4), deprecated (4), pending (4), can (4), set (4), browse (3), release (3), services (3), page (3), noauth (3), that (3), not (3), folders (3), devices (3), error (3), use (3), curl (3), signing (2), development (2), documentation (2), event (2), device (2), introduction (2), version (2), calls (2), debug (2), stats (2), events (2), status (2), need (2), ignores (2), file (2), versions (2), delete (2), upgrade (2), ping (2), loglevels (2), log (2), discovery (2), pagination (2), result (2), entries (2), are (2), returned (2), perpage (2), expose (2), generated (2), configuration (2), header (2), with (2), localhost (2), 8384 (2), abc123 (2), bearer (2), authorization (2), interface (2), donate, support, quick, search, next, previous, overview, related, topics, specifications, utility, creating, issue, management, infrastructure, understanding, ids, automatic, crash, reporting, developers, debugging, building, working, web, usage, navigation, written, gf020590, edit, github, health, require, authentication, report, random, string, lang, deviceid, misc, statistics, disk, scan, revert, remoteneed, prio, override, localchanged, completion, database, pullerrors, errors, runtime, state, individual, shared, concerns, mesh, network, structure, shutdown, resume, restart, reset, pause, paths, txt, clear, connections, insync, some, take, optional, arguments, more, than, defaults, 65536, given, array, access, further, passing, parameter, will, advance, results, many, pages, actually, parameters, always, attributes, response, object, one, exception, requirement, you, those, way, third, party, simple, don, sensitive, information, without, having, your, must, element, request, value, token, example, invoke, add, flag, when, using, https, self, signed, certificate, apikey, exposes, over, port, from, javascript, other, processes, wishing, control, most, cases, both, input, output, data, json, format, subject, change,
Text of the page (random words):
rest api syncthing documentation rest api syncthing exposes a rest interface over http on the gui port this is used by the gui from javascript and can be used by other processes wishing to control syncthing in most cases both the input and output data is in json format the interface is subject to change api key to use the rest api an api key must be set and used the api key can be generated in the gui or set in the configuration gui apikey element in the configuration file to use an api key set the request header x api key to the api key value or set it as a bearer token in the authorization header for example curl x post h x api key abc123 http localhost 8384 rest or curl x post h authorization bearer abc123 http localhost 8384 rest can be used to invoke with curl add k flag when using https with a syncthing generated or self signed certificate one exception to this requirement is rest noauth you do not need an api key to use those endpoints this way third party devices and services can do simple calls that don t expose sensitive information without having to expose your api key result pagination some get endpoints take optional page and perpage arguments for pagination no more than perpage defaults to 65536 if not given result entries are returned in an array to access further entries passing the page parameter will advance in the results by that many pages the actually used parameters are always returned as attributes in the response object system endpoints get rest system browse get rest system config deprecated get rest system config insync deprecated post rest system config deprecated get rest system connections get rest system discovery post rest system discovery post rest system error clear get rest system error post rest system error get rest system log get rest system log txt get rest system loglevels post rest system loglevels get rest system paths post rest system pause get rest system ping post rest system ping post rest system reset post rest system restart post rest system resume post rest system shutdown get rest system status get rest system upgrade post rest system upgrade get rest system version config endpoints rest config cluster endpoints concerns the mesh network structure delete rest cluster pending devices get rest cluster pending devices delete rest cluster pending folders get rest cluster pending folders folder endpoints runtime state of the individual shared folders get rest folder errors get rest folder pullerrors deprecated get rest folder versions post rest folder versions database endpoints get rest db browse get rest db completion get rest db file get rest db ignores post rest db ignores get rest db localchanged get rest db need post rest db override post rest db prio get rest db remoteneed post rest db revert post rest db scan get rest db status event endpoints get rest events get rest events disk statistics endpoints get rest stats device get rest stats folder misc services endpoints get rest svc deviceid get rest svc lang get rest svc random string get rest svc report debug endpoints rest debug noauth endpoints calls that do not require authentication get rest noauth health edit this page on github version v2 1 0 26 gf020590 written for v2 1 0 navigation introduction usage development introduction working on the web gui building syncthing debugging syncthing automatic crash reporting for developers understanding device ids syncthing infrastructure issue management creating a release release signing rest api event api http utility services api specifications related topics documentation overview development previous release signing next get rest system browse quick search donate support
|