A newer version of this documentation is available.

Public REST API

March 23, 2025

+ 12

Description of the Sync Gateway Rest API'

Related REST API topics: Admin REST API | Metrics REST API | Use the REST API?

Using the API Explorer

The API explorer below groups all the endpoints by functionality. You can click on a label to expand the list of endpoints.

You can also send a request to each endpoint against an instance of Sync Gateway. To use this optional feature, enable CORS by adding the following entry to the configuration file.

javascript
Copy
{
    ...
    "CORS": {
        "Origin":["*"],
        "LoginOrigin":["*"],
        "Headers":["Content-Type"],
        "MaxAge": 1728000
    },
    ...
}