{"id":12845,"date":"2022-03-07T11:03:12","date_gmt":"2022-03-07T19:03:12","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=12845"},"modified":"2023-05-23T00:55:27","modified_gmt":"2023-05-23T07:55:27","slug":"postman-collections-for-sync-gateway-administration","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/postman-collections-for-sync-gateway-administration\/","title":{"rendered":"Postman Collections for Sync Gateway Administration"},"content":{"rendered":"

Web-based clients can administer, monitor and interact with Couchbase Sync Gateway using a <\/span>RESTful interface<\/span><\/a>. With the <\/span>Sync Gateway 3.0 release<\/span><\/a>, database administration is done exclusively through the <\/span>admin <\/span><\/i>REST endpoint. <\/span>Postman<\/span><\/a> is an API test, development and documentation tool that allows you to test and use these endpoints.<\/span><\/p>\n

This blog post shows you how to use the <\/span>Postman API client<\/span><\/a> to configure, administer, and interact with Sync Gateway via the REST interface.<\/span><\/p>\n

Postman Collections for Sync Gateway<\/span><\/h4>\n

A Postman <\/span>Collection <\/span><\/i>is a group of saved requests organized in folders and subfolders. You can use collections as a starting point and customize them to your environment and needs.\u00a0<\/span><\/p>\n

We have produced a reference set of <\/span>Postman<\/span><\/a> collections and corresponding environment variable definition files for the REST interface of Sync Gateway 3.0. These files are available on <\/span>Github<\/span><\/a> and designed to get you up and running quickly with the following steps.<\/span><\/p>\n

First, clone the repository<\/span><\/p>\n

git clone \r\nhttps:\/\/github.com\/couchbaselabs\/Couchbase-Sync-Gateway-Postman-Collection.git<\/pre>\n
The repository also contains a <\/span>travel-sample<\/span><\/i> folder and a custom collection for the Travel Sample application, as we discuss a little later.<\/span><\/p>\n
Now let\u2019s explore the other contents of the cloned repo. There are three Postman Collection JSON files with the suffix <\/span>postman_collection.json <\/span><\/i>included and a Postman Environment settings file as described in this table:<\/span><\/p>\n\n\n\n\n\n\n\n
File \/ Github link<\/b><\/td>\nAPI interface used \/ Docs link<\/b><\/td>\nPurpose<\/b><\/td>\n<\/tr>\n
Sync-Gateway\u20133.0-Admin-API<\/span><\/a>\u00a0<\/span><\/td>\nSync Gateway Admin interface<\/span><\/a>\u00a0<\/span><\/td>\nRequests for database management, administration, access controls and end-user management.<\/span><\/td>\n<\/tr>\n
Sync-Gateway\u20133.0-Public-API<\/span><\/a><\/td>\nSync Gateway Public interface<\/span><\/a><\/td>\nAllows end users to read and write application data.<\/span><\/td>\n<\/tr>\n
Sync-Gateway\u20133.0-Metrics-API<\/span><\/a><\/td>\nSync Gateway Metrics interface<\/span><\/a>\u00a0<\/span><\/td>\nAllows access to cluster-level stats in Prometheus and custom JSON format.<\/span><\/td>\n<\/tr>\n
Sync-Gateway\u20133.0-Environment<\/span><\/a><\/td>\nEnvironment Definitions file that defines the variables. The variables will have to be customized with values corresponding to your environment.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Using the Postman Client<\/span><\/h4>\n