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 3.1
OAS3
_attachments/bundled-public.yaml Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server
http://localhost:4984Server variables
| protocol | |
| hostname |
AuthenticationManage OpenID Connect Authentication
Manage OpenID Connect Authentication
Database ManagementCreate and manage Sync Gateway databases
Create and manage Sync Gateway databases
DocumentCreate and manage documents
Create and manage documents
Document AttachmentCreate and manage document attachments
Create and manage document attachments
ReplicationCreate and manage inter-Sync Gateway replications
Create and manage inter-Sync Gateway replications
ServerManage server activities
Manage server activities
SessionManage user sessions
Manage user sessions
UnsupportedEndpoints that are not supported by Sync Gateway
Endpoints that are not supported by Sync Gateway