{"id":14310,"date":"2023-04-21T12:48:48","date_gmt":"2023-04-21T19:48:48","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=14310"},"modified":"2024-01-31T10:02:41","modified_gmt":"2024-01-31T18:02:41","slug":"use-postman-with-couchbase-capella-public-api","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/","title":{"rendered":"Use Postman With Couchbase Capella Public API"},"content":{"rendered":"<p><strong>Important Update: Please note that the V3 API will be deprecated soon and will no longer receive updates or support beyond its end-of-life date. To benefit from enhanced features and improved performance, we strongly recommend transitioning to our new V4 API. We&#8217;ve prepared a <a href=\"https:\/\/www.couchbase.com\/blog\/programmatic-admin-capella-management-api\/\">comprehensive guide detailing the steps on how to start working with V4<\/a> to make the process as smooth as possible for you.<\/strong><\/p>\n<hr \/>\n<p><span style=\"font-weight: 400\">Couchbase Capella offers a public API which enables administrators and developers to integrate and interact with the Control Plane using a variety of programming languages and platforms<\/span><span style=\"font-weight: 400\">. <\/span><span style=\"font-weight: 400\">The RESTful APIs are intended to enable customers to integrate with Couchbase Capella and perform operations such as:<\/span><\/p>\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Onboarding and offboarding users<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Managing the lifecycle of a database<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Monitoring a database<\/span><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><span style=\"font-weight: 400\">This blog post will show you how to utilize the <\/span><a href=\"https:\/\/www.postman.com\/product\/api-client\/\"><span style=\"font-weight: 400\">Postman API client<\/span><\/a><span style=\"font-weight: 400\"> to interact with the Couchbase Capella Public API through the REST interface.<\/span><\/p>\n<p><span style=\"font-weight: 400\">Note that this tutorial uses v3 of the Capella Public API. A revamped version of the API is in the works that may introduce some breaking changes. As such, we discourage you to use this version of the API in production deployments as we do not make guarantees on backwards compatibility with this version. However, we encourage you to evaluate the API and invite feedback on capabilities you would like to see in the new version of public API.<\/span><\/p>\n<h2><span style=\"font-weight: 400\">Prerequisites<\/span><\/h2>\n<ol>\n<li style=\"list-style-type: none\">\n<ul>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Postman is a great tool to interact with a REST API. In the remainder of this tutorial I assume you have installed Postman locally and it is ready for use. You can download it from <a href=\"https:\/\/www.postman.com\/downloads\/\">postman.com\/downloads<\/a><\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">The next step is to download Couchbase Capella\u2019s OpenAPI file from the Capella <\/span><a href=\"https:\/\/docs.couchbase.com\/cloud\/reference\/rest-endpoints-all.html\"><span style=\"font-weight: 400\">documentation website<\/span><\/a><span style=\"font-weight: 400\">.\u00a0<\/span><\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter wp-image-14311\" src=\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/image2-1024x414.png\" alt=\"\" width=\"658\" height=\"266\" srcset=\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image2-1024x414.png 1024w, https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image2-300x121.png 300w, https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image2-768x311.png 768w, https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image2-1536x621.png 1536w, https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image2-1320x534.png 1320w, https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image2.png 1726w\" sizes=\"auto, (max-width: 658px) 100vw, 658px\" \/><\/p>\n<ol>\n<li style=\"list-style-type: none\">\n<ul>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">You will also need to create an access key and a secret key to use the Public API. See instructions on how to set up your keys <\/span><a href=\"https:\/\/docs.couchbase.com\/cloud\/public-api-guide\/using-cloud-public-api.html\"><span style=\"font-weight: 400\">here<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/li>\n<\/ul>\n<\/li>\n<\/ol>\n<h2><span style=\"font-weight: 400\">Create a new Postman environment<\/span><\/h2>\n<p><span style=\"font-weight: 400\">In this step you will set up a new Postman environment (a set of variables you can use in your Postman requests). Couchbase Capella\u2019s Public API will require your access and secret keys.<\/span><\/p>\n<p><span style=\"font-weight: 400\">Make sure you name the variables exactly as follows:<\/span><\/p>\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li style=\"font-weight: 400\"><b>accessKey<\/b><span style=\"font-weight: 400\"> containing your access key<\/span><\/li>\n<li style=\"font-weight: 400\"><b>secretKey<\/b><span style=\"font-weight: 400\"> containing your secret<\/span><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><span style=\"font-weight: 400\">It is probably best to set this new environment as the active one.<\/span><\/p>\n<p><a href=\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/image3.gif\"><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter wp-image-14312 size-full\" src=\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/image3.gif\" alt=\"\" width=\"1916\" height=\"824\" \/><\/a><\/p>\n<h2><span style=\"font-weight: 400\">Import the OpenAPI definition<\/span><\/h2>\n<p><span style=\"font-weight: 400\">The next step is to import the OpenAPI definition file that you downloaded earlier. This will create a new Postman collection.<\/span><\/p>\n<p><a href=\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/image1.gif\"><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter wp-image-14313 size-full\" src=\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/image1.gif\" alt=\"\" width=\"1920\" height=\"824\" \/><\/a><\/p>\n<p><span style=\"font-weight: 400\">At this point, you have the collection and environment set up in Postman.<\/span><\/p>\n<h2><span style=\"font-weight: 400\">Configure Authentication<\/span><\/h2>\n<p><span style=\"font-weight: 400\">The Couchbase Capella Public API uses a <em>Bearer<\/em> <em>token<\/em> mechanism for authentication; each call to the Public API must be authenticated. <\/span><span style=\"font-weight: 400\">You can find details on the two headers you must send with every request by consulting the <\/span><a href=\"https:\/\/docs.couchbase.com\/cloud\/public-api-guide\/using-cloud-public-api.html#header-values\"><span style=\"font-weight: 400\">official documentation<\/span><\/a><span style=\"font-weight: 400\"> on security headers.<\/span><\/p>\n<p><span style=\"font-weight: 400\">To help you get started, we have a Postman pre-request script that generates the necessary headers based on your access and secret keys.<\/span><\/p>\n<p><span style=\"font-weight: 400\">You must copy and paste this code into the <em>Pre-request Script<\/em> section of the collection. You can find more information about Pre-request scripts by visiting Postman&#8217;s <\/span><a href=\"https:\/\/learning.postman.com\/docs\/writing-scripts\/pre-request-scripts\/\"><span style=\"font-weight: 400\">documentation website<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/p>\n<p><a href=\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/image4.gif\"><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter wp-image-14314 size-full\" src=\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/image4.gif\" alt=\"\" width=\"1920\" height=\"824\" \/><\/a><\/p>\n<pre class=\"nums:false lang:js decode:true \">\/\/ Grab the current endpoint infro from the request\r\nconst url = pm.request.url.getPathWithQuery()\r\n\r\n\/\/ Grab the method from the request\r\nconst method = pm.request.method;\r\n\r\n\/\/ Create a timestamp\r\nconst now = new Date().getTime();\r\n\r\n\/\/ Datetime in the past\r\nconst yesterday = new Date();\r\nyesterday.setDate(yesterday.getDate() - 1);\r\n\r\n\/\/ SHA-256 hash\u00a0\r\nconst createHash = (payload, secret) =&gt; {\r\n\u00a0\u00a0\u00a0\u00a0return CryptoJS.HmacSHA256(payload, secret)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0.toString(CryptoJS.enc.Base64);\r\n}\r\n\r\n\/\/ Create the bearerToken\r\nconst setToken = (accessKey, hash) =&gt; {\r\n\u00a0\u00a0\u00a0\u00a0pm.environment.set(\"bearerToken\", accessKey + ':' + hash);\r\n}\r\n\r\n\/\/ Create the Timestamp header\r\nconst setTimestampheader = (date) =&gt; {\r\n\u00a0\u00a0\u00a0\u00a0pm.request.headers.add({\r\n\u00a0\u00a0\u00a0\u00a0key: \"Couchbase-Timestamp\",\r\n\u00a0\u00a0\u00a0\u00a0value: date\r\n\u00a0\u00a0\u00a0\u00a0});\u00a0\u00a0\u00a0\u00a0\r\n}\r\n\r\n\/\/ If accessKey and secretKey are defined, we can generate the hash\r\nif (pm.environment.has(\"accessKey\") &amp;&amp; pm.environment.has(\"secretKey\")) {\u00a0\u00a0\u00a0\u00a0\r\n\u00a0\u00a0\u00a0\u00a0\/\/ Replace variables in the URL\r\n\u00a0\u00a0\u00a0\u00a0const parsedURL = pm.variables.replaceIn(url);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\/\/ Generate the payload\r\n\u00a0\u00a0\u00a0\u00a0const payload = [method, parsedURL, now].join(\"\\n\");\r\n\u00a0\u00a0\u00a0\u00a0console.log(\"Payload\", payload);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\/\/ Generate the hash\r\n\u00a0\u00a0\u00a0\u00a0const hash = createHash(payload, pm.environment.get(\"secretKey\"))\r\n\r\n\u00a0\u00a0\u00a0\u00a0\/\/ Save the token to an env variable\u00a0\u00a0\u00a0\u00a0\r\n\u00a0\u00a0\u00a0\u00a0setToken(pm.environment.get(\"accessKey\"), hash);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\/\/ Add the timestamp header to the request\r\n\u00a0\u00a0\u00a0\u00a0setTimestampheader(now);\r\n}\r\n\r\npm.environment.set(\"yesterday\", yesterday.toJSON());\r\npm.environment.set(\"now\", new Date().toJSON());<\/pre>\n<p><span style=\"font-weight: 400\">At this point you are ready to run your queries. Next we will look at how to run some of the <\/span><a href=\"https:\/\/docs.couchbase.com\/cloud\/public-api-guide\/introducing-public-api.html\"><span style=\"font-weight: 400\">Public API queries<\/span><\/a><span style=\"font-weight: 400\">.<\/span><\/p>\n<h2><span style=\"font-weight: 400\">Run queries<\/span><\/h2>\n<p><span style=\"font-weight: 400\">As a first example, let\u2019s run the <em>List Users<\/em> call in the users folder.<\/span><\/p>\n<p><span style=\"font-weight: 400\">When you run this query, you will notice that the response is empty despite the fact that you have users in your system. This is because the query parameters were assigned default values that are incorrect.<\/span><\/p>\n<p><span style=\"font-weight: 400\">You must amend the following query parameters: <\/span><b>page<\/b><span style=\"font-weight: 400\"> and <\/span><b>perPage. <\/b><span style=\"font-weight: 400\">In the following example, I will change the <\/span><b>page<\/b><span style=\"font-weight: 400\"> to 1 and the <\/span><b>perPage<\/b><span style=\"font-weight: 400\"> to 100 to get the expected result from the API.<\/span><\/p>\n<p><a href=\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/image5.gif\"><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-14315\" src=\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/image5.gif\" alt=\"\" width=\"1920\" height=\"824\" \/><\/a><\/p>\n<p><span style=\"font-weight: 400\">That is it! Now you are ready to discover Couchbase Capella\u2019s Public API. I hope you find some interesting ways to use it in your project.<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Important Update: Please note that the V3 API will be deprecated soon and will no longer receive updates or support beyond its end-of-life date. To benefit from enhanced features and improved performance, we strongly recommend transitioning to our new V4 [&hellip;]<\/p>\n","protected":false},"author":84313,"featured_media":14316,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[2225,2201],"tags":[1948,1950],"ppma_author":[9812],"class_list":["post-14310","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-cloud","category-tools-sdks","tag-postman","tag-rest-api"],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v27.3 (Yoast SEO v27.3) - https:\/\/yoast.com\/product\/yoast-seo-premium-wordpress\/ -->\n<title>How to Use Postman with Couchbase Capella Public API<\/title>\n<meta name=\"description\" content=\"This blog post will show you how to utilize the Postman API client to interact with the Couchbase Capella Public API through the REST interface.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Use Postman With Couchbase Capella Public API\" \/>\n<meta property=\"og:description\" content=\"This blog post will show you how to utilize the Postman API client to interact with the Couchbase Capella Public API through the REST interface.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/\" \/>\n<meta property=\"og:site_name\" content=\"The Couchbase Blog\" \/>\n<meta property=\"article:published_time\" content=\"2023-04-21T19:48:48+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-01-31T18:02:41+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/image_2023-04-21_124804931.png\" \/>\n\t<meta property=\"og:image:width\" content=\"2105\" \/>\n\t<meta property=\"og:image:height\" content=\"1181\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Istvan Orban\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Istvan Orban\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/\"},\"author\":{\"name\":\"Istvan Orban, Principal Product Manager\",\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/#\\\/schema\\\/person\\\/da80693db66ef61daaabe98bc56afc26\"},\"headline\":\"Use Postman With Couchbase Capella Public API\",\"datePublished\":\"2023-04-21T19:48:48+00:00\",\"dateModified\":\"2024-01-31T18:02:41+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/\"},\"wordCount\":660,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/#organization\"},\"image\":{\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/wp-content\\\/uploads\\\/sites\\\/1\\\/2023\\\/04\\\/image_2023-04-21_124804931.png\",\"keywords\":[\"Postman\",\"REST API\"],\"articleSection\":[\"Couchbase Capella\",\"Tools &amp; SDKs\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/\",\"url\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/\",\"name\":\"How to Use Postman with Couchbase Capella Public API\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/wp-content\\\/uploads\\\/sites\\\/1\\\/2023\\\/04\\\/image_2023-04-21_124804931.png\",\"datePublished\":\"2023-04-21T19:48:48+00:00\",\"dateModified\":\"2024-01-31T18:02:41+00:00\",\"description\":\"This blog post will show you how to utilize the Postman API client to interact with the Couchbase Capella Public API through the REST interface.\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/#primaryimage\",\"url\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/wp-content\\\/uploads\\\/sites\\\/1\\\/2023\\\/04\\\/image_2023-04-21_124804931.png\",\"contentUrl\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/wp-content\\\/uploads\\\/sites\\\/1\\\/2023\\\/04\\\/image_2023-04-21_124804931.png\",\"width\":2105,\"height\":1181},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/use-postman-with-couchbase-capella-public-api\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Use Postman With Couchbase Capella Public API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/\",\"name\":\"The Couchbase Blog\",\"description\":\"Couchbase, the NoSQL Database\",\"publisher\":{\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/#organization\",\"name\":\"The Couchbase Blog\",\"url\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/wp-content\\\/uploads\\\/2023\\\/04\\\/admin-logo.png\",\"contentUrl\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/wp-content\\\/uploads\\\/2023\\\/04\\\/admin-logo.png\",\"width\":218,\"height\":34,\"caption\":\"The Couchbase Blog\"},\"image\":{\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/#\\\/schema\\\/person\\\/da80693db66ef61daaabe98bc56afc26\",\"name\":\"Istvan Orban, Principal Product Manager\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/wp-content\\\/uploads\\\/sites\\\/1\\\/2023\\\/04\\\/image_2023-04-25_205027722.pngc873b4cba9199faca7f2d3db2f443f81\",\"url\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/wp-content\\\/uploads\\\/sites\\\/1\\\/2023\\\/04\\\/image_2023-04-25_205027722.png\",\"contentUrl\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/wp-content\\\/uploads\\\/sites\\\/1\\\/2023\\\/04\\\/image_2023-04-25_205027722.png\",\"caption\":\"Istvan Orban, Principal Product Manager\"},\"description\":\"Istvan Orban is the Principal Product Manager for Couchbase and lives in the United Kingdom. Istvan has a wide range of experience as a Full stack Software Engineer, Team leader and Devops Engineer. His main focus is security and Single Sign On. Istvan has led several large scale projects of his 20 year professional career.\",\"url\":\"https:\\\/\\\/www.couchbase.com\\\/blog\\\/author\\\/istvanorban\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"How to Use Postman with Couchbase Capella Public API","description":"This blog post will show you how to utilize the Postman API client to interact with the Couchbase Capella Public API through the REST interface.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/","og_locale":"en_US","og_type":"article","og_title":"Use Postman With Couchbase Capella Public API","og_description":"This blog post will show you how to utilize the Postman API client to interact with the Couchbase Capella Public API through the REST interface.","og_url":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/","og_site_name":"The Couchbase Blog","article_published_time":"2023-04-21T19:48:48+00:00","article_modified_time":"2024-01-31T18:02:41+00:00","og_image":[{"width":2105,"height":1181,"url":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/image_2023-04-21_124804931.png","type":"image\/png"}],"author":"Istvan Orban","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Istvan Orban","Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/#article","isPartOf":{"@id":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/"},"author":{"name":"Istvan Orban, Principal Product Manager","@id":"https:\/\/www.couchbase.com\/blog\/#\/schema\/person\/da80693db66ef61daaabe98bc56afc26"},"headline":"Use Postman With Couchbase Capella Public API","datePublished":"2023-04-21T19:48:48+00:00","dateModified":"2024-01-31T18:02:41+00:00","mainEntityOfPage":{"@id":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/"},"wordCount":660,"commentCount":0,"publisher":{"@id":"https:\/\/www.couchbase.com\/blog\/#organization"},"image":{"@id":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/#primaryimage"},"thumbnailUrl":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image_2023-04-21_124804931.png","keywords":["Postman","REST API"],"articleSection":["Couchbase Capella","Tools &amp; SDKs"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/","url":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/","name":"How to Use Postman with Couchbase Capella Public API","isPartOf":{"@id":"https:\/\/www.couchbase.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/#primaryimage"},"image":{"@id":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/#primaryimage"},"thumbnailUrl":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image_2023-04-21_124804931.png","datePublished":"2023-04-21T19:48:48+00:00","dateModified":"2024-01-31T18:02:41+00:00","description":"This blog post will show you how to utilize the Postman API client to interact with the Couchbase Capella Public API through the REST interface.","breadcrumb":{"@id":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/#primaryimage","url":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image_2023-04-21_124804931.png","contentUrl":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image_2023-04-21_124804931.png","width":2105,"height":1181},{"@type":"BreadcrumbList","@id":"https:\/\/www.couchbase.com\/blog\/use-postman-with-couchbase-capella-public-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.couchbase.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Use Postman With Couchbase Capella Public API"}]},{"@type":"WebSite","@id":"https:\/\/www.couchbase.com\/blog\/#website","url":"https:\/\/www.couchbase.com\/blog\/","name":"The Couchbase Blog","description":"Couchbase, the NoSQL Database","publisher":{"@id":"https:\/\/www.couchbase.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.couchbase.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.couchbase.com\/blog\/#organization","name":"The Couchbase Blog","url":"https:\/\/www.couchbase.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.couchbase.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/admin-logo.png","contentUrl":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/2023\/04\/admin-logo.png","width":218,"height":34,"caption":"The Couchbase Blog"},"image":{"@id":"https:\/\/www.couchbase.com\/blog\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/www.couchbase.com\/blog\/#\/schema\/person\/da80693db66ef61daaabe98bc56afc26","name":"Istvan Orban, Principal Product Manager","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image_2023-04-25_205027722.pngc873b4cba9199faca7f2d3db2f443f81","url":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image_2023-04-25_205027722.png","contentUrl":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image_2023-04-25_205027722.png","caption":"Istvan Orban, Principal Product Manager"},"description":"Istvan Orban is the Principal Product Manager for Couchbase and lives in the United Kingdom. Istvan has a wide range of experience as a Full stack Software Engineer, Team leader and Devops Engineer. His main focus is security and Single Sign On. Istvan has led several large scale projects of his 20 year professional career.","url":"https:\/\/www.couchbase.com\/blog\/author\/istvanorban\/"}]}},"acf":[],"authors":[{"term_id":9812,"user_id":84313,"is_guest":0,"slug":"istvanorban","display_name":"Istvan Orban","avatar_url":{"url":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image_2023-04-25_205027722.png","url2x":"https:\/\/www.couchbase.com\/blog\/wp-content\/uploads\/sites\/1\/2023\/04\/image_2023-04-25_205027722.png"},"0":null,"1":"","2":"","3":"","4":"","5":"","6":"","7":"","8":""}],"_links":{"self":[{"href":"https:\/\/www.couchbase.com\/blog\/wp-json\/wp\/v2\/posts\/14310","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.couchbase.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.couchbase.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.couchbase.com\/blog\/wp-json\/wp\/v2\/users\/84313"}],"replies":[{"embeddable":true,"href":"https:\/\/www.couchbase.com\/blog\/wp-json\/wp\/v2\/comments?post=14310"}],"version-history":[{"count":0,"href":"https:\/\/www.couchbase.com\/blog\/wp-json\/wp\/v2\/posts\/14310\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.couchbase.com\/blog\/wp-json\/wp\/v2\/media\/14316"}],"wp:attachment":[{"href":"https:\/\/www.couchbase.com\/blog\/wp-json\/wp\/v2\/media?parent=14310"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.couchbase.com\/blog\/wp-json\/wp\/v2\/categories?post=14310"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.couchbase.com\/blog\/wp-json\/wp\/v2\/tags?post=14310"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/www.couchbase.com\/blog\/wp-json\/wp\/v2\/ppma_author?post=14310"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}