Public REST API
Description of the Sync Gateway Rest API'
Related REST API topics: Admin REST API | Metrics REST API | Use the REST API?
|
Content Blocking
Couchbase Mobile’s API documentation utilizes Swagger UI to deliver an interactive and dynamic user experience. The page will not function correctly if your organization’s security policies restricts access to this type of content — instead see the alternate statics page Public REST API (Static Page) |
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{
...
"CORS": {
"Origin":["*"],
"LoginOrigin":["*"],
"Headers":["Content-Type"],
"MaxAge": 1728000
},
...
}
API Explorer
Sync Gateway 2.0
[ Base URL: localhost:4984/ ]_attachments/rest-api-public.yaml
This yaml API spec documents the Sync Gateway Public REST API.
The swagger spec isn’t officially supported or actively maintained.
It is offered as a convenient starting point for developers.
AttachmentWork with attachments
Work with attachments
AuthenticationWork with authentication
Work with authentication
DatabaseWork with databases
Work with databases
DocumentWork with documents
Work with documents
Document (local)Work with local documents
Work with local documents
ServerWork with the server
Work with the server
SessionWork with sessions
Work with sessions