{ "info": { "_postman_id": "e33e38a8-0892-40a3-b9c8-47e6dbae0061", "name": "Zuplo Developer API", "description": "The Zuplo Developer API (ZAPI) enables developers to programmatically manage API keys, consumers, buckets, tunnels, deployments, metering, audit logs, and more.\n\nContact Support:\n Name: Zuplo\n Email: support@zuplo.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:41.000Z", "lastUpdatedBy": "35240", "uid": "35240-e33e38a8-0892-40a3-b9c8-47e6dbae0061" }, "item": [ { "name": "mcp", "item": [ { "name": "docs", "item": [ { "name": "Docs MCP Server", "id": "dd4da8e6-92c4-4337-b019-b7914f1c9bcb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mcp/docs", "host": [ "{{baseUrl}}" ], "path": [ "mcp", "docs" ] }, "description": "The Zuplo Documentation MCP server" }, "response": [ { "id": "28a08ce9-2c97-4bf9-9cbb-337b66a93b4e", "name": "The request has succeeded.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/mcp/docs", "host": [ "{{baseUrl}}" ], "path": [ "mcp", "docs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-28a08ce9-2c97-4bf9-9cbb-337b66a93b4e" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-dd4da8e6-92c4-4337-b019-b7914f1c9bcb" } ], "id": "8d4818f8-d241-42e6-b427-385f16242682", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-8d4818f8-d241-42e6-b427-385f16242682" } ], "id": "1732f9a4-9ff5-4b0e-b458-ddb54c7193f1", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-1732f9a4-9ff5-4b0e-b458-ddb54c7193f1" }, { "name": "openapi", "item": [ { "name": "OpenAPI Specification", "id": "0454d42a-8530-4480-b03f-a6da120a64f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/openapi", "host": [ "{{baseUrl}}" ], "path": [ "openapi" ] }, "description": "Returns the OpenAPI V3 spec for Zuplo's Developer API" }, "response": [ { "id": "bf6f555a-ea23-48ff-b20e-4531d6483fcc", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/openapi", "host": [ "{{baseUrl}}" ], "path": [ "openapi" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-bf6f555a-ea23-48ff-b20e-4531d6483fcc" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0454d42a-8530-4480-b03f-a6da120a64f5" } ], "id": "57f8d41b-e3b3-4ac1-a9d5-6f0e887d4818", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-57f8d41b-e3b3-4ac1-a9d5-6f0e887d4818" }, { "name": "v1", "item": [ { "name": "accounts", "item": [ { "name": "{accountName}", "item": [ { "name": "audit-logs", "item": [ { "name": "Query Audit Logs", "id": "3d7b86a3-ae0f-44cf-97aa-d93f0e52e227", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/audit-logs?limit=20&offset=0&action=&startDate=&endDate=&actor=&success=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "audit-logs" ], "query": [ { "description": "Maximum number of results to return (1-100)", "key": "limit", "value": "20" }, { "description": "Number of results to skip for pagination", "key": "offset", "value": "0" }, { "description": "Filter by specific action (e.g., 'account.create')", "key": "action", "value": "" }, { "description": "Filter events after this date (ISO 8601 format)", "key": "startDate", "value": "" }, { "description": "Filter events before this date (ISO 8601 format)", "key": "endDate", "value": "" }, { "description": "Filter by actor email address or subject identifier", "key": "actor", "value": "" }, { "description": "Filter by success status (true for successful, false for failed)", "key": "success", "value": "" } ], "variable": [ { "id": "7c4b04cc-05a5-40d5-bc10-71d3c8131445", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." } ] }, "description": "Retrieves audit logs with optional filtering and pagination." }, "response": [ { "id": "345c4571-1fce-4202-8f2c-e0505cedc10d", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/audit-logs?limit=20&offset=0&action=&startDate=&endDate=&actor=&success=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "audit-logs" ], "query": [ { "description": "Maximum number of results to return (1-100)", "key": "limit", "value": "20" }, { "description": "Number of results to skip for pagination", "key": "offset", "value": "0" }, { "description": "Filter by specific action (e.g., 'account.create')", "key": "action", "value": "" }, { "description": "Filter events after this date (ISO 8601 format)", "key": "startDate", "value": "" }, { "description": "Filter events before this date (ISO 8601 format)", "key": "endDate", "value": "" }, { "description": "Filter by actor email address or subject identifier", "key": "actor", "value": "" }, { "description": "Filter by success status (true for successful, false for failed)", "key": "success", "value": "" } ], "variable": [ { "key": "accountName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"action\": \"\",\n \"metadata\": {\n \"nulla_4\": {}\n },\n \"actor\": {\n \"sub\": \"\",\n \"email\": \"\",\n \"type\": \"\",\n \"connection\": \"\",\n \"actingAs\": {\n \"sub\": \"\",\n \"email\": \"\"\n },\n \"metadata\": {}\n },\n \"resources\": [\n {\n \"type\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"dofc\": {},\n \"tempor06\": {},\n \"incididunt_1\": {}\n }\n },\n {\n \"type\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"adipisicing27\": {}\n }\n }\n ],\n \"context\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"country\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"metroCode\": \"\",\n \"asOrg\": \"\"\n },\n \"route\": {\n \"source\": \"\",\n \"url\": \"\",\n \"method\": \"\"\n },\n \"timestamp\": \"\",\n \"requestId\": \"\",\n \"success\": \"\",\n \"error\": \"\"\n },\n {\n \"action\": \"\",\n \"metadata\": {\n \"commodo_43\": {},\n \"culpa_3\": {}\n },\n \"actor\": {\n \"sub\": \"\",\n \"email\": \"\",\n \"type\": \"\",\n \"connection\": \"\",\n \"actingAs\": {\n \"sub\": \"\",\n \"email\": \"\"\n },\n \"metadata\": {}\n },\n \"resources\": [\n {\n \"type\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"dolor_b9\": {}\n }\n },\n {\n \"type\": \"\",\n \"id\": \"\",\n \"metadata\": {\n \"iruree_\": {},\n \"velita\": {}\n }\n }\n ],\n \"context\": {\n \"ipAddress\": \"\",\n \"userAgent\": \"\",\n \"country\": \"\",\n \"region\": \"\",\n \"city\": \"\",\n \"postalCode\": \"\",\n \"metroCode\": \"\",\n \"asOrg\": \"\"\n },\n \"route\": {\n \"source\": \"\",\n \"url\": \"\",\n \"method\": \"\"\n },\n \"timestamp\": \"\",\n \"requestId\": \"\",\n \"success\": \"\",\n \"error\": \"\"\n }\n ],\n \"pagination\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\",\n \"hasMore\": \"\"\n }\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-345c4571-1fce-4202-8f2c-e0505cedc10d" }, { "id": "15f1906b-1082-4ed7-ac51-451f579ad376", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/audit-logs?limit=20&offset=0&action=&startDate=&endDate=&actor=&success=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "audit-logs" ], "query": [ { "description": "Maximum number of results to return (1-100)", "key": "limit", "value": "20" }, { "description": "Number of results to skip for pagination", "key": "offset", "value": "0" }, { "description": "Filter by specific action (e.g., 'account.create')", "key": "action", "value": "" }, { "description": "Filter events after this date (ISO 8601 format)", "key": "startDate", "value": "" }, { "description": "Filter events before this date (ISO 8601 format)", "key": "endDate", "value": "" }, { "description": "Filter by actor email address or subject identifier", "key": "actor", "value": "" }, { "description": "Filter by success status (true for successful, false for failed)", "key": "success", "value": "" } ], "variable": [ { "key": "accountName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-15f1906b-1082-4ed7-ac51-451f579ad376" }, { "id": "ee678c07-670b-42fc-ad4a-f4735a21d31b", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/audit-logs?limit=20&offset=0&action=&startDate=&endDate=&actor=&success=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "audit-logs" ], "query": [ { "description": "Maximum number of results to return (1-100)", "key": "limit", "value": "20" }, { "description": "Number of results to skip for pagination", "key": "offset", "value": "0" }, { "description": "Filter by specific action (e.g., 'account.create')", "key": "action", "value": "" }, { "description": "Filter events after this date (ISO 8601 format)", "key": "startDate", "value": "" }, { "description": "Filter events before this date (ISO 8601 format)", "key": "endDate", "value": "" }, { "description": "Filter by actor email address or subject identifier", "key": "actor", "value": "" }, { "description": "Filter by success status (true for successful, false for failed)", "key": "success", "value": "" } ], "variable": [ { "key": "accountName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ee678c07-670b-42fc-ad4a-f4735a21d31b" }, { "id": "b73ca752-8227-4592-88c1-6f3df114ee4d", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/audit-logs?limit=20&offset=0&action=&startDate=&endDate=&actor=&success=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "audit-logs" ], "query": [ { "description": "Maximum number of results to return (1-100)", "key": "limit", "value": "20" }, { "description": "Number of results to skip for pagination", "key": "offset", "value": "0" }, { "description": "Filter by specific action (e.g., 'account.create')", "key": "action", "value": "" }, { "description": "Filter events after this date (ISO 8601 format)", "key": "startDate", "value": "" }, { "description": "Filter events before this date (ISO 8601 format)", "key": "endDate", "value": "" }, { "description": "Filter by actor email address or subject identifier", "key": "actor", "value": "" }, { "description": "Filter by success status (true for successful, false for failed)", "key": "success", "value": "" } ], "variable": [ { "key": "accountName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-b73ca752-8227-4592-88c1-6f3df114ee4d" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3d7b86a3-ae0f-44cf-97aa-d93f0e52e227" } ], "id": "5d553156-4938-4b22-b4db-ba4b3f3324b7", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-5d553156-4938-4b22-b4db-ba4b3f3324b7" }, { "name": "custom-domains", "item": [ { "name": "Get Custom Domains", "id": "ddc28b46-e651-4ea2-8335-56b2e076bac1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "id": "afacea76-632f-4283-9325-bb3b400bfe89", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." } ] }, "description": "Gets the account custom domains" }, "response": [ { "id": "d210b2a5-82b3-4f09-a32b-dc2147bfa1de", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"accountName\": \"\",\n \"projectName\": \"\",\n \"deployments\": [\n {\n \"deploymentName\": \"\",\n \"branch\": \"\",\n \"environmentType\": \"WORKING_COPY\",\n \"isDefault\": \"\",\n \"stage\": \"dev-portal\",\n \"cname\": \"\"\n },\n {\n \"deploymentName\": \"\",\n \"branch\": \"\",\n \"environmentType\": \"WORKING_COPY\",\n \"isDefault\": \"\",\n \"stage\": \"dev-portal\",\n \"cname\": \"\"\n }\n ],\n \"hostname\": \"\",\n \"provider\": \"cloudflare\"\n },\n {\n \"id\": \"\",\n \"accountName\": \"\",\n \"projectName\": \"\",\n \"deployments\": [\n {\n \"deploymentName\": \"\",\n \"branch\": \"\",\n \"environmentType\": \"PRODUCTION\",\n \"isDefault\": \"\",\n \"stage\": \"api\",\n \"cname\": \"\"\n },\n {\n \"deploymentName\": \"\",\n \"branch\": \"\",\n \"environmentType\": \"PRODUCTION\",\n \"isDefault\": \"\",\n \"stage\": \"dev-portal\",\n \"cname\": \"\"\n }\n ],\n \"hostname\": \"\",\n \"provider\": \"alias\"\n }\n ],\n \"offset\": \"\",\n \"limit\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-d210b2a5-82b3-4f09-a32b-dc2147bfa1de" }, { "id": "f45ab47c-2fcb-4c34-aa36-edae24e551a2", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f45ab47c-2fcb-4c34-aa36-edae24e551a2" }, { "id": "da6fbcdc-067f-4e63-a7e4-a09134275466", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-da6fbcdc-067f-4e63-a7e4-a09134275466" }, { "id": "ea6d2f93-dbb6-4431-a9a9-b82c0b6219fd", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ea6d2f93-dbb6-4431-a9a9-b82c0b6219fd" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ddc28b46-e651-4ea2-8335-56b2e076bac1" }, { "name": "Create Custom Domain", "id": "f9a451b6-4193-4e3d-99b6-81d2a7a84653", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"hostname\": \"\",\n \"deploymentName\": \"\",\n \"stage\": \"api\",\n \"isDefault\": \"\",\n \"isAlias\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "id": "24673326-2132-4acc-8901-9c446e55810d", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." } ] }, "description": "Creates a custom domain" }, "response": [ { "id": "58c0c5aa-7ae7-4ed9-96ab-c80544763ad7", "name": "The request has succeeded.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"hostname\": \"\",\n \"deploymentName\": \"\",\n \"stage\": \"api\",\n \"isDefault\": \"\",\n \"isAlias\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deploymentName\": \"\",\n \"hostname\": \"\",\n \"stage\": \"api\",\n \"ownershipVerification\": {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n \"cname\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-58c0c5aa-7ae7-4ed9-96ab-c80544763ad7" }, { "id": "c1a5569e-1b0a-4eb9-a6a0-2ba94700bbb2", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"hostname\": \"\",\n \"deploymentName\": \"\",\n \"stage\": \"api\",\n \"isDefault\": \"\",\n \"isAlias\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c1a5569e-1b0a-4eb9-a6a0-2ba94700bbb2" }, { "id": "85f5e729-6974-4210-af09-e77bf36e0489", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"hostname\": \"\",\n \"deploymentName\": \"\",\n \"stage\": \"api\",\n \"isDefault\": \"\",\n \"isAlias\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-85f5e729-6974-4210-af09-e77bf36e0489" }, { "id": "f5df5293-4d80-4004-a962-41178a23aa50", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"hostname\": \"\",\n \"deploymentName\": \"\",\n \"stage\": \"api\",\n \"isDefault\": \"\",\n \"isAlias\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f5df5293-4d80-4004-a962-41178a23aa50" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f9a451b6-4193-4e3d-99b6-81d2a7a84653" }, { "name": "Update a Custom Domain", "id": "0e615cbd-45f7-427a-838c-977d5bd0148e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"hostname\": \"\",\n \"deploymentName\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "id": "1292a2de-090f-4d28-8c73-3c18c4b609bc", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." } ] }, "description": "Updates a custom domain" }, "response": [ { "id": "01488241-eb1a-4f31-8c81-9bbb979cf98d", "name": "The request has succeeded.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"hostname\": \"\",\n \"deploymentName\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deploymentName\": \"\",\n \"hostname\": \"\",\n \"stage\": \"api\",\n \"ownershipVerification\": {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n \"cname\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-01488241-eb1a-4f31-8c81-9bbb979cf98d" }, { "id": "e89ad0cd-ed03-4681-91d1-f08a7d711e17", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"hostname\": \"\",\n \"deploymentName\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-e89ad0cd-ed03-4681-91d1-f08a7d711e17" }, { "id": "6b39498b-4784-48b8-944a-3326f93bc4cc", "name": "Access is unauthorized.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"hostname\": \"\",\n \"deploymentName\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6b39498b-4784-48b8-944a-3326f93bc4cc" }, { "id": "09ed268e-f0d5-4034-b61c-06954de48424", "name": "Server error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"hostname\": \"\",\n \"deploymentName\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "variable": [ { "key": "accountName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-09ed268e-f0d5-4034-b61c-06954de48424" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0e615cbd-45f7-427a-838c-977d5bd0148e" }, { "name": "Delete a Custom Domain", "id": "62b25ffd-50f7-470e-bae1-0c8cc754b940", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains?hostname=&deploymentName=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "query": [ { "description": "(Required) The hostname of the custom domain to delete.", "key": "hostname", "value": "" }, { "description": "The deployment associated with the hostname, when deleting a deployment-specific mapping.", "key": "deploymentName", "value": "" } ], "variable": [ { "id": "ce5bf986-55d9-4d38-b09e-3bf496932b8b", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." } ] }, "description": "Delete a custom domain" }, "response": [ { "id": "e3c6344a-1bf8-4357-9ce4-7376dfca9b43", "name": "The request has succeeded.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains?hostname=&deploymentName=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "query": [ { "description": "(Required) The hostname of the custom domain to delete.", "key": "hostname", "value": "" }, { "description": "The deployment associated with the hostname, when deleting a deployment-specific mapping.", "key": "deploymentName", "value": "" } ], "variable": [ { "key": "accountName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-e3c6344a-1bf8-4357-9ce4-7376dfca9b43" }, { "id": "2b46f1ad-67d9-40c0-ae3a-90e7b1ea1478", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains?hostname=&deploymentName=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "query": [ { "description": "(Required) The hostname of the custom domain to delete.", "key": "hostname", "value": "" }, { "description": "The deployment associated with the hostname, when deleting a deployment-specific mapping.", "key": "deploymentName", "value": "" } ], "variable": [ { "key": "accountName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-2b46f1ad-67d9-40c0-ae3a-90e7b1ea1478" }, { "id": "2edd2c6e-c0cd-449b-847a-db6e6aa79484", "name": "Access is unauthorized.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains?hostname=&deploymentName=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "query": [ { "description": "(Required) The hostname of the custom domain to delete.", "key": "hostname", "value": "" }, { "description": "The deployment associated with the hostname, when deleting a deployment-specific mapping.", "key": "deploymentName", "value": "" } ], "variable": [ { "key": "accountName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-2edd2c6e-c0cd-449b-847a-db6e6aa79484" }, { "id": "3e24fd33-67fe-437c-838c-ab447e395555", "name": "Server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/custom-domains?hostname=&deploymentName=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "custom-domains" ], "query": [ { "description": "(Required) The hostname of the custom domain to delete.", "key": "hostname", "value": "" }, { "description": "The deployment associated with the hostname, when deleting a deployment-specific mapping.", "key": "deploymentName", "value": "" } ], "variable": [ { "key": "accountName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3e24fd33-67fe-437c-838c-ab447e395555" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-62b25ffd-50f7-470e-bae1-0c8cc754b940" } ], "id": "6401cd1c-5497-4af3-9ca7-2deb3abf652d", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6401cd1c-5497-4af3-9ca7-2deb3abf652d" }, { "name": "key-buckets", "item": [ { "name": "{bucketName}", "item": [ { "name": "consumers", "item": [ { "name": "{consumerName}", "item": [ { "name": "keys", "item": [ { "name": "$bulk", "item": [ { "name": "Creates Multiple API Keys", "id": "72060fa0-5eb8-4ef5-91d5-048ec90f1a53", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/$bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", "$bulk" ], "variable": [ { "id": "43317e0e-14e6-47cb-89a3-dc5f7d1724ce", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "95b13b8b-9386-4f75-97a3-e0c85dc53d0a", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "fe3c1aac-4d65-44f9-bbb6-10d4fa6cb158", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." } ] }, "description": "Creates multiple new API keys for this consumer." }, "response": [ { "id": "f4f89cd5-7519-4aac-b5fa-fcbbcc0d03a6", "name": "The request has succeeded.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/$bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", "$bulk" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f4f89cd5-7519-4aac-b5fa-fcbbcc0d03a6" }, { "id": "f4c532fa-a1d4-4464-a33b-796fe9629a0b", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/$bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", "$bulk" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f4c532fa-a1d4-4464-a33b-796fe9629a0b" }, { "id": "0f253dd4-0bdd-45fa-ae59-b1b91ec5e875", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/$bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", "$bulk" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0f253dd4-0bdd-45fa-ae59-b1b91ec5e875" }, { "id": "c0811415-afaf-4d4e-9f62-db2dd56588a1", "name": "Rate Limiting Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/$bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", "$bulk" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c0811415-afaf-4d4e-9f62-db2dd56588a1" }, { "id": "c21a622b-d594-46fa-adb0-e85925423afe", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "[\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/$bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", "$bulk" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c21a622b-d594-46fa-adb0-e85925423afe" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-72060fa0-5eb8-4ef5-91d5-048ec90f1a53" } ], "id": "879a3d95-0523-460e-959c-b006f5a2923d", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-879a3d95-0523-460e-959c-b006f5a2923d" }, { "name": "{keyId}", "item": [ { "name": "Gets an API Key", "id": "04166afa-6298-42f8-b705-fe237f8d438a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?key-format=none&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "id": "6e2ee1d6-a711-4638-92fd-baa77def1965", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "df346ca8-bc62-4bfc-80fb-058af85ac3e6", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "2522ccaa-3d8c-4156-a452-79a25faa0d8b", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." }, { "id": "e246bf73-ee5a-437e-85fa-0b7e7c382f39", "key": "keyId", "value": "", "description": "(Required) The key id." } ] }, "description": "Retrieves an API key for this consumer." }, "response": [ { "id": "ccc550e1-f14f-4ebb-b81b-9b8f18c011a6", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?key-format=none&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ccc550e1-f14f-4ebb-b81b-9b8f18c011a6" }, { "id": "8b6a6249-b0cf-42cd-b1a6-36bab9b7b7ff", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?key-format=none&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-8b6a6249-b0cf-42cd-b1a6-36bab9b7b7ff" }, { "id": "5ba9c87d-0b74-4e6f-845c-a0daf6738d89", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?key-format=none&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-5ba9c87d-0b74-4e6f-845c-a0daf6738d89" }, { "id": "fa5b07b0-e4cc-4325-8946-e464e01152ca", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?key-format=none&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-fa5b07b0-e4cc-4325-8946-e464e01152ca" }, { "id": "d164f028-6714-4adf-8405-65f7db25feb0", "name": "Rate Limiting Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?key-format=none&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-d164f028-6714-4adf-8405-65f7db25feb0" }, { "id": "dc5bb550-8d31-4acb-8547-3f572b37d94a", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?key-format=none&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-dc5bb550-8d31-4acb-8547-3f572b37d94a" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-04166afa-6298-42f8-b705-fe237f8d438a" }, { "name": "Updates an API Key", "id": "0873ff0e-e933-4c01-b9fd-f32dbc816140", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "id": "77e66f9b-d9dc-44ec-abb9-63c3edb08961", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "4ebee43f-ddde-4c96-85ba-ec18b47a474b", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "646a9387-21e1-4942-8882-59f7f9473856", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." }, { "id": "1334c3e5-ac5e-4b1b-bfcd-7e2f1b65b76d", "key": "keyId", "value": "", "description": "(Required) The key id." } ] }, "description": "Updates an API key for this consumer." }, "response": [ { "id": "56b92264-fd82-45d2-a3cd-621e6e87365b", "name": "The request has succeeded.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-56b92264-fd82-45d2-a3cd-621e6e87365b" }, { "id": "aa1db371-d692-4516-98e3-a3b074bf1029", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-aa1db371-d692-4516-98e3-a3b074bf1029" }, { "id": "23a4f3dc-af82-4e2d-bc95-8365f12dcf75", "name": "Access is unauthorized.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-23a4f3dc-af82-4e2d-bc95-8365f12dcf75" }, { "id": "dbdd0de7-38cf-4c79-80dc-8b47dd640503", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-dbdd0de7-38cf-4c79-80dc-8b47dd640503" }, { "id": "afec71ec-38f3-403f-9fa0-8f52594de9ad", "name": "Rate Limiting Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-afec71ec-38f3-403f-9fa0-8f52594de9ad" }, { "id": "89ee8de4-e918-4158-bfa0-1104d7fc8ed6", "name": "Server error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-89ee8de4-e918-4158-bfa0-1104d7fc8ed6" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0873ff0e-e933-4c01-b9fd-f32dbc816140" }, { "name": "Deletes an API Key", "id": "d201fc25-768b-435d-a88a-3833ee0aac39", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "id": "4a2ed90b-cc81-46bc-a98a-15ce0e762410", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "2471538f-74dc-4efa-aeae-7914d76175ed", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "020d6fb7-2c2d-48f9-8a2c-7f330e3061e3", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." }, { "id": "3afb5ae3-9452-42e5-897c-f87cbd6d24e7", "key": "keyId", "value": "", "description": "(Required) The key id." } ] }, "description": "Deletes an API key for this consumer." }, "response": [ { "id": "17a77820-d48c-4da9-9403-0d8d4b429b37", "name": "There is no content to send for this request, but the headers may be useful.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-17a77820-d48c-4da9-9403-0d8d4b429b37" }, { "id": "d41d9d21-c87a-42f5-b2c0-a4540ee217e2", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-d41d9d21-c87a-42f5-b2c0-a4540ee217e2" }, { "id": "10534001-0f50-4592-847c-5eee2baad579", "name": "Access is unauthorized.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-10534001-0f50-4592-847c-5eee2baad579" }, { "id": "8abc3f68-799c-43fe-81c0-e87f95c0d11e", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-8abc3f68-799c-43fe-81c0-e87f95c0d11e" }, { "id": "33e8eda4-09d7-453c-8d36-f9b06206ad53", "name": "Rate Limiting Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-33e8eda4-09d7-453c-8d36-f9b06206ad53" }, { "id": "1c86de49-e58d-439e-af4f-bdf26e15fef1", "name": "Server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys/:keyId?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys", ":keyId" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "keyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-1c86de49-e58d-439e-af4f-bdf26e15fef1" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-d201fc25-768b-435d-a88a-3833ee0aac39" } ], "id": "271dc401-53a1-4569-8b7b-901663a48b16", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-271dc401-53a1-4569-8b7b-901663a48b16" }, { "name": "Lists Keys", "id": "67183a04-cea3-4775-b853-9cb34ba8cfea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys?limit=&offset=&key-format=none", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" } ], "variable": [ { "id": "1c21684a-08bb-4dd7-944f-e8b665bdaf82", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "7e395ba9-9481-4ebb-9aed-f9a4ca49e082", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "88fc677b-aee1-48ae-838a-099066952226", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." } ] }, "description": "Lists all keys for this consumer." }, "response": [ { "id": "585f7dcd-a737-449e-bca8-9a67b004b2fb", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys?limit=&offset=&key-format=none", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-585f7dcd-a737-449e-bca8-9a67b004b2fb" }, { "id": "4943b02f-793a-4bde-88c2-36088d727ffb", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys?limit=&offset=&key-format=none", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-4943b02f-793a-4bde-88c2-36088d727ffb" }, { "id": "c9ae5b4a-b691-44b6-bf11-18b8ea481a90", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys?limit=&offset=&key-format=none", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c9ae5b4a-b691-44b6-bf11-18b8ea481a90" }, { "id": "8272711f-912e-42d3-9138-bd2ece09ca8d", "name": "Rate Limiting Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys?limit=&offset=&key-format=none", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-8272711f-912e-42d3-9138-bd2ece09ca8d" }, { "id": "aff6b9ac-4c25-4e4e-8676-3b61becda060", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys?limit=&offset=&key-format=none", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-aff6b9ac-4c25-4e4e-8676-3b61becda060" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-67183a04-cea3-4775-b853-9cb34ba8cfea" }, { "name": "Creates an API Key", "id": "908cb6fb-014c-4530-9258-bcaf0e14a96f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "variable": [ { "id": "37c3f07e-f1d1-4b31-bd26-fb991133f547", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "3e6e77c6-9625-4f69-89c4-b3603eddc7b8", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "fbe28a54-2c45-4af0-9700-e6415d7b954d", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." } ] }, "description": "Creates a new API key for this consumer. New API keys will automatically have [API Key Leak Detection](https://zuplo.com/docs/articles/api-key-leak-detection) enabled." }, "response": [ { "id": "0e185251-7750-4f1b-8f08-2765c433c69e", "name": "The request has succeeded.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0e185251-7750-4f1b-8f08-2765c433c69e" }, { "id": "fe09c9f4-637c-4388-8b48-c76bad08fa26", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-fe09c9f4-637c-4388-8b48-c76bad08fa26" }, { "id": "140394b3-0858-4708-bafe-2a7f071e9e38", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-140394b3-0858-4708-bafe-2a7f071e9e38" }, { "id": "1b889a23-8c57-426a-991a-9976aec2e4ba", "name": "Rate Limiting Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-1b889a23-8c57-426a-991a-9976aec2e4ba" }, { "id": "6e58495a-e96f-4046-9ceb-767ca6a149ee", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "keys" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6e58495a-e96f-4046-9ceb-767ca6a149ee" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-908cb6fb-014c-4530-9258-bcaf0e14a96f" } ], "id": "8e33275e-b64f-47c4-8a4f-ac91e428e1d8", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-8e33275e-b64f-47c4-8a4f-ac91e428e1d8" }, { "name": "managers", "item": [ { "name": "{managerId}", "item": [ { "name": "Deletes a Manager", "id": "8aa94e8b-399d-4fa3-94c6-7f75f28cce55", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers/:managerId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers", ":managerId" ], "variable": [ { "id": "6d846a3b-4313-4ee2-a75d-77589e8ebd0d", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "83ba75c5-e619-4998-88c8-b9cd6e1ae095", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "57400167-925a-4597-8e4d-2a9bcad63c94", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." }, { "id": "614195e5-7bb1-4fb4-8e75-5aef506a3371", "key": "managerId", "value": "", "description": "(Required) The manager id" } ] }, "description": "Deletes a manager record" }, "response": [ { "id": "3d9bb84d-6888-4e38-9f44-e51136f95d1a", "name": "There is no content to send for this request, but the headers may be useful.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers/:managerId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers", ":managerId" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "managerId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3d9bb84d-6888-4e38-9f44-e51136f95d1a" }, { "id": "35e95b6e-5879-42e3-a27c-8adda17b0da9", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers/:managerId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers", ":managerId" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "managerId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-35e95b6e-5879-42e3-a27c-8adda17b0da9" }, { "id": "777352e4-5a3b-42b9-beb5-a1a7414d98f0", "name": "Access is unauthorized.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers/:managerId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers", ":managerId" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "managerId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-777352e4-5a3b-42b9-beb5-a1a7414d98f0" }, { "id": "728d6d07-5fed-4e8c-b292-3297f14df4ee", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers/:managerId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers", ":managerId" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "managerId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-728d6d07-5fed-4e8c-b292-3297f14df4ee" }, { "id": "7d3aef15-bc41-4df2-bee0-13bfbbe36ace", "name": "Rate Limiting Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers/:managerId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers", ":managerId" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "managerId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-7d3aef15-bc41-4df2-bee0-13bfbbe36ace" }, { "id": "ff45bddd-aa10-4b60-b576-9ab7bf6a8214", "name": "Server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers/:managerId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers", ":managerId" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" }, { "key": "managerId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ff45bddd-aa10-4b60-b576-9ab7bf6a8214" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-8aa94e8b-399d-4fa3-94c6-7f75f28cce55" } ], "id": "250e85ad-b576-4642-ab79-2cdc06caeb76", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-250e85ad-b576-4642-ab79-2cdc06caeb76" }, { "name": "Lists Managers", "id": "3d72d4bc-0b5f-47e4-8095-8206dd065d5e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" } ], "variable": [ { "id": "2fdae68a-a77c-48f4-8592-6f881b71b11b", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "2fa4f2fc-91d3-4b9d-be2f-c2844ced9227", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "54e8998b-53e4-46a4-a1c3-4c2fcd822516", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." } ] }, "description": "Lists all managers belonging to a consumer." }, "response": [ { "id": "f5f23797-a4f2-4638-a9d9-a2763aa04817", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"email\": \"\",\n \"sub\": \"\",\n \"createdOn\": 56271866.28313279,\n \"id\": false\n },\n {\n \"email\": \"\",\n \"sub\": \"\",\n \"createdOn\": 70724808,\n \"id\": -86715846.4657598\n }\n ],\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f5f23797-a4f2-4638-a9d9-a2763aa04817" }, { "id": "dd4b11e2-1287-447f-b6d9-0e2f88a685e5", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-dd4b11e2-1287-447f-b6d9-0e2f88a685e5" }, { "id": "891c223d-f17f-4092-b067-ee5cb25d726b", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-891c223d-f17f-4092-b067-ee5cb25d726b" }, { "id": "dc83893b-effe-42c5-bca6-9b0ae769a789", "name": "Rate Limiting Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-dc83893b-effe-42c5-bca6-9b0ae769a789" }, { "id": "0121e507-1077-4b90-84b5-dab6618ea942", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0121e507-1077-4b90-84b5-dab6618ea942" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3d72d4bc-0b5f-47e4-8095-8206dd065d5e" }, { "name": "Creates a Manager", "id": "c74f33f5-bd9f-4165-8bd4-f590b10eb814", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"sub\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "variable": [ { "id": "9f57c1a5-4fe8-4049-8370-5b03d53e1104", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "dc6440e1-b82f-45ce-9a60-104da7dfafe7", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "64353383-23c1-4d7e-9ae5-882909044306", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." } ] }, "description": "Creates a new manager for a consumer." }, "response": [ { "id": "61ae5ae6-845d-4b0b-a505-cf2eb72f73c2", "name": "The request has succeeded.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"sub\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"email\": \"\",\n \"sub\": \"\",\n \"createdOn\": -88072047,\n \"id\": false\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-61ae5ae6-845d-4b0b-a505-cf2eb72f73c2" }, { "id": "a5ccb835-c38b-43f2-ac4e-5138b7870488", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"sub\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-a5ccb835-c38b-43f2-ac4e-5138b7870488" }, { "id": "cde92dc1-0fd3-468f-984e-ca63986ae755", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"sub\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-cde92dc1-0fd3-468f-984e-ca63986ae755" }, { "id": "1afa6d49-8413-4eb1-8368-baf7dc7c6b0f", "name": "Rate Limiting Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"sub\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-1afa6d49-8413-4eb1-8368-baf7dc7c6b0f" }, { "id": "125454cf-3dee-47ee-8847-930c659d8aba", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"sub\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/managers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "managers" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-125454cf-3dee-47ee-8847-930c659d8aba" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c74f33f5-bd9f-4165-8bd4-f590b10eb814" } ], "id": "b5b00bc4-cde1-4b9d-8620-df1261c45321", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-b5b00bc4-cde1-4b9d-8620-df1261c45321" }, { "name": "roll-key", "item": [ { "name": "Roll Consumer Keys", "id": "23e49863-3591-4db3-8ec1-ac25c31c011c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/roll-key?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "roll-key" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "id": "c4807836-8f1c-4783-85ed-106bea4e9999", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "7e64e76b-21d3-439b-b006-8f104597dc98", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "5924261c-e6b2-4648-8600-ba5220bb679f", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." } ] }, "description": "Set expiration for keys with no expiration date and creates a new key." }, "response": [ { "id": "a8da45d8-848f-4f69-869e-ce4a585d1d16", "name": "There is no content to send for this request, but the headers may be useful.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/roll-key?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "roll-key" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-a8da45d8-848f-4f69-869e-ce4a585d1d16" }, { "id": "6774cc12-9fc7-40f7-bdb3-ae4557ce198b", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/roll-key?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "roll-key" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6774cc12-9fc7-40f7-bdb3-ae4557ce198b" }, { "id": "87e60871-9589-4153-b261-c87889c0cbfc", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/roll-key?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "roll-key" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-87e60871-9589-4153-b261-c87889c0cbfc" }, { "id": "3c3dc6c1-617f-4e0d-ab2b-2bc9dcdb89ba", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/roll-key?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "roll-key" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3c3dc6c1-617f-4e0d-ab2b-2bc9dcdb89ba" }, { "id": "5522cb39-1d35-4d41-9725-3a7f0d4cc74d", "name": "Rate Limiting Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/roll-key?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "roll-key" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-5522cb39-1d35-4d41-9725-3a7f0d4cc74d" }, { "id": "808e47a5-903a-4dbd-9300-e73d18f2255e", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"expiresOn\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName/roll-key?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName", "roll-key" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-808e47a5-903a-4dbd-9300-e73d18f2255e" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-23e49863-3591-4db3-8ec1-ac25c31c011c" } ], "id": "78b62215-ca18-4358-9057-a081636ebcb1", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-78b62215-ca18-4358-9057-a081636ebcb1" }, { "name": "Gets a Consumer", "id": "a0ed77d9-263c-4275-96c5-6b065e8df4f1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?include-api-keys=&key-format=none&include-managers=&include-manager-invites=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "id": "dbe01d91-8edf-4129-b6d0-33787f44718c", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "c3dceaf3-d2ac-45e6-816d-7fa8ac0a91fe", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "c1caf705-b17e-4453-9513-678948ee001c", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." } ] }, "description": "Gets a consumer given a bucket name and consumer name." }, "response": [ { "id": "fa2e1b08-1ca6-4915-b543-5139d4ce21b3", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?include-api-keys=&key-format=none&include-managers=&include-manager-invites=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"name\": \"qcyqrvhz1ybs9zsoo2plmx-ogwkdhh5amx8shy0e04chod-pfmrdvib-ftoqc0ejdqx2v47ivc1c003unyo5imu7juihxhic\",\n \"apiKeys\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"description\": \"\",\n \"tags\": {\n \"voluptate_3\": \"\",\n \"fugiatc\": \"\",\n \"dolorba_\": \"\",\n \"nulla9\": \"\"\n },\n \"metadata\": {\n \"sunta67\": \"\"\n }\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-fa2e1b08-1ca6-4915-b543-5139d4ce21b3" }, { "id": "fb070994-7a2b-48cf-a8e3-3350a11517ea", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?include-api-keys=&key-format=none&include-managers=&include-manager-invites=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-fb070994-7a2b-48cf-a8e3-3350a11517ea" }, { "id": "972fa543-55dd-4942-b9c4-8b8c27e95ba6", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?include-api-keys=&key-format=none&include-managers=&include-manager-invites=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-972fa543-55dd-4942-b9c4-8b8c27e95ba6" }, { "id": "5a47e23c-2760-438c-b705-833e8f02a0b6", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?include-api-keys=&key-format=none&include-managers=&include-manager-invites=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-5a47e23c-2760-438c-b705-833e8f02a0b6" }, { "id": "55b36abb-8dc9-4af5-9b68-6ade6ed05af5", "name": "Rate Limiting Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?include-api-keys=&key-format=none&include-managers=&include-manager-invites=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-55b36abb-8dc9-4af5-9b68-6ade6ed05af5" }, { "id": "6d530418-fcc2-4d88-9bc6-7245f64027ae", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?include-api-keys=&key-format=none&include-managers=&include-manager-invites=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6d530418-fcc2-4d88-9bc6-7245f64027ae" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-a0ed77d9-263c-4275-96c5-6b065e8df4f1" }, { "name": "Updates a Consumer", "id": "402ea4b7-2546-4213-9d37-049a3026ed6f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"occaecat_d\": \"\"\n },\n \"metadata\": {\n \"sunt_a_8\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "id": "00373c06-bd4b-4149-9419-956471f3da04", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "402729e1-a483-4a58-a3e1-933bae7d1434", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "46509a71-2c49-4498-aeff-13342066155c", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." } ] }, "description": "Update the consumer with the matching consumer name." }, "response": [ { "id": "d065c718-6ec8-43dc-805d-c86df50d023e", "name": "The request has succeeded.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"occaecat_d\": \"\"\n },\n \"metadata\": {\n \"sunt_a_8\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"name\": \"qcyqrvhz1ybs9zsoo2plmx-ogwkdhh5amx8shy0e04chod-pfmrdvib-ftoqc0ejdqx2v47ivc1c003unyo5imu7juihxhic\",\n \"apiKeys\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"description\": \"\",\n \"tags\": {\n \"voluptate_3\": \"\",\n \"fugiatc\": \"\",\n \"dolorba_\": \"\",\n \"nulla9\": \"\"\n },\n \"metadata\": {\n \"sunta67\": \"\"\n }\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-d065c718-6ec8-43dc-805d-c86df50d023e" }, { "id": "4fde2522-0c22-40aa-88cc-bdb489e1b608", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"occaecat_d\": \"\"\n },\n \"metadata\": {\n \"sunt_a_8\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-4fde2522-0c22-40aa-88cc-bdb489e1b608" }, { "id": "83e409b8-3c30-45a7-83cf-4d16126aa54b", "name": "Access is unauthorized.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"occaecat_d\": \"\"\n },\n \"metadata\": {\n \"sunt_a_8\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-83e409b8-3c30-45a7-83cf-4d16126aa54b" }, { "id": "5cbe1be8-5f6a-4838-bdf8-c0b160c44ad5", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"occaecat_d\": \"\"\n },\n \"metadata\": {\n \"sunt_a_8\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-5cbe1be8-5f6a-4838-bdf8-c0b160c44ad5" }, { "id": "c809dd33-e396-4aec-8444-0bbbea2b4cdf", "name": "Rate Limiting Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"occaecat_d\": \"\"\n },\n \"metadata\": {\n \"sunt_a_8\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c809dd33-e396-4aec-8444-0bbbea2b4cdf" }, { "id": "fd12cd9e-96a3-43bb-827b-bd110b1365c5", "name": "Server error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"occaecat_d\": \"\"\n },\n \"metadata\": {\n \"sunt_a_8\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-fd12cd9e-96a3-43bb-827b-bd110b1365c5" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-402ea4b7-2546-4213-9d37-049a3026ed6f" }, { "name": "Deletes a Consumer", "id": "8c640088-0026-4732-986a-d4bd972597f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "id": "32f185f3-91ca-49fa-ac80-c642c611bc15", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "bd9de58d-90dd-4d03-be7f-40a77c4464b3", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." }, { "id": "e7d07d35-f7f6-4c3b-8d4d-c55b676db1de", "key": "consumerName", "value": "", "description": "(Required) The name of the consumer." } ] }, "description": "Deletes a consumer and any related resources" }, "response": [ { "id": "d1f987cb-cb1a-499d-a9a5-355451d15102", "name": "There is no content to send for this request, but the headers may be useful.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-d1f987cb-cb1a-499d-a9a5-355451d15102" }, { "id": "5bc926de-0199-4cb9-bf4d-7857a3e40c33", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-5bc926de-0199-4cb9-bf4d-7857a3e40c33" }, { "id": "9243abd3-8b18-4f0c-a985-a0544856638e", "name": "Access is unauthorized.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-9243abd3-8b18-4f0c-a985-a0544856638e" }, { "id": "0dd4731b-2038-4e70-835f-62de535098af", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0dd4731b-2038-4e70-835f-62de535098af" }, { "id": "e6532fee-37f8-4f5a-9af9-06259848c727", "name": "Rate Limiting Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-e6532fee-37f8-4f5a-9af9-06259848c727" }, { "id": "19f188d9-c12f-4d61-8971-dbd96f117966", "name": "Server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers/:consumerName?tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers", ":consumerName" ], "query": [ { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" }, { "key": "consumerName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-19f188d9-c12f-4d61-8971-dbd96f117966" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-8c640088-0026-4732-986a-d4bd972597f3" } ], "id": "b527d101-b095-4f5a-a781-fd416a1dcc13", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-b527d101-b095-4f5a-a781-fd416a1dcc13" }, { "name": "Lists Consumers", "id": "2073e7d0-c62a-46cd-977b-f0e0113ec681", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?limit=&offset=&include-api-keys=&include-manager-invites=&include-managers=&key-format=none&manager-email=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Filter by email address of key manager.", "key": "manager-email", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "id": "53e1b1f0-59b3-4b40-b36e-1d749ee1eff7", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "e08cbe10-5655-412f-9ffb-ec1a2b6cb347", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." } ] }, "description": "Lists all consumers belonging to this account." }, "response": [ { "id": "7d700216-bc0b-4c15-a2b6-d970f896b0a4", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?limit=&offset=&include-api-keys=&include-manager-invites=&include-managers=&key-format=none&manager-email=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Filter by email address of key manager.", "key": "manager-email", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"name\": \"8564hc-\",\n \"apiKeys\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"description\": \"\",\n \"tags\": {\n \"occaecat_f\": \"\"\n },\n \"metadata\": {\n \"est_9\": \"\",\n \"magna263\": \"\"\n }\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"name\": \"i44s3q8my-x4ydumi0j7kfhd13pmt64-tn8vpstfcgnal8kle8gdg5cy33vlrh6fitbl3nf-jf-mupgxg3bp3j7y6-zoivb\",\n \"apiKeys\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"description\": \"\",\n \"tags\": {\n \"ullamco588\": \"\",\n \"Lorem_6e\": \"\"\n },\n \"metadata\": {\n \"qui32\": \"\",\n \"mollit_5d\": \"\"\n }\n }\n ],\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-7d700216-bc0b-4c15-a2b6-d970f896b0a4" }, { "id": "c57bdd37-ad0a-4881-8e36-152336e14e5c", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?limit=&offset=&include-api-keys=&include-manager-invites=&include-managers=&key-format=none&manager-email=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Filter by email address of key manager.", "key": "manager-email", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c57bdd37-ad0a-4881-8e36-152336e14e5c" }, { "id": "f8f6208e-d2da-45dc-9061-171e7b6697b6", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?limit=&offset=&include-api-keys=&include-manager-invites=&include-managers=&key-format=none&manager-email=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Filter by email address of key manager.", "key": "manager-email", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f8f6208e-d2da-45dc-9061-171e7b6697b6" }, { "id": "4927890b-28cc-40d9-b71d-000c7d1c7238", "name": "Rate Limiting Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?limit=&offset=&include-api-keys=&include-manager-invites=&include-managers=&key-format=none&manager-email=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Filter by email address of key manager.", "key": "manager-email", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-4927890b-28cc-40d9-b71d-000c7d1c7238" }, { "id": "c9cf64be-1a4c-4ad6-b23c-a57cac2a6e42", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?limit=&offset=&include-api-keys=&include-manager-invites=&include-managers=&key-format=none&manager-email=&tag=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "(Required) The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000", "key": "limit", "value": "" }, { "description": "(Required) The offset of the first item returned in the collection. Default: 0", "key": "offset", "value": "" }, { "description": "Include the api key data in the response.", "key": "include-api-keys", "value": "" }, { "description": "Include the manager invites data in the response.", "key": "include-manager-invites", "value": "" }, { "description": "Include the manager's data in the response.", "key": "include-managers", "value": "" }, { "description": "The format of the key to return.\n`none`: Key is completely hidden.\n`visible`: Key is completely visible.\n`masked`: Part of key suffix is visible.", "key": "key-format", "value": "none" }, { "description": "Filter by email address of key manager.", "key": "manager-email", "value": "" }, { "description": "Query by tag. Example usage is `tag.account=foo`, where `account` is the name of the tag property and `foo` is the value.", "key": "tag", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c9cf64be-1a4c-4ad6-b23c-a57cac2a6e42" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-2073e7d0-c62a-46cd-977b-f0e0113ec681" }, { "name": "Creates a Consumer", "id": "89c4d580-75c1-4bb8-bf7e-d5ac648bbde0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"m6wvc2cpqr58alwnif34a4a-lc82-gvotwv\",\n \"managers\": [\n \"\",\n \"\"\n ],\n \"apiKeys\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"description\": \"\",\n \"tags\": {\n \"dolor_d3\": \"\",\n \"velit1f\": \"\",\n \"elit_3d6\": \"\"\n },\n \"metadata\": {\n \"ex_9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?with-api-key=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "If an API key should be created with the consumer.", "key": "with-api-key", "value": "" } ], "variable": [ { "id": "0e43e42d-527f-4376-8a83-203175b89b13", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "e42608e3-e463-41f8-a8c0-f6250dda2af9", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." } ] }, "description": "Creates a new consumer for this account." }, "response": [ { "id": "1af58442-87c3-4f32-84ea-3ffb61e2a2db", "name": "The request has succeeded.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"m6wvc2cpqr58alwnif34a4a-lc82-gvotwv\",\n \"managers\": [\n \"\",\n \"\"\n ],\n \"apiKeys\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"description\": \"\",\n \"tags\": {\n \"dolor_d3\": \"\",\n \"velit1f\": \"\",\n \"elit_3d6\": \"\"\n },\n \"metadata\": {\n \"ex_9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?with-api-key=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "If an API key should be created with the consumer.", "key": "with-api-key", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"name\": \"qcyqrvhz1ybs9zsoo2plmx-ogwkdhh5amx8shy0e04chod-pfmrdvib-ftoqc0ejdqx2v47ivc1c003unyo5imu7juihxhic\",\n \"apiKeys\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"description\": \"\",\n \"tags\": {\n \"voluptate_3\": \"\",\n \"fugiatc\": \"\",\n \"dolorba_\": \"\",\n \"nulla9\": \"\"\n },\n \"metadata\": {\n \"sunta67\": \"\"\n }\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-1af58442-87c3-4f32-84ea-3ffb61e2a2db" }, { "id": "77d1f309-c71c-4451-8d83-42536974f40c", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"m6wvc2cpqr58alwnif34a4a-lc82-gvotwv\",\n \"managers\": [\n \"\",\n \"\"\n ],\n \"apiKeys\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"description\": \"\",\n \"tags\": {\n \"dolor_d3\": \"\",\n \"velit1f\": \"\",\n \"elit_3d6\": \"\"\n },\n \"metadata\": {\n \"ex_9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?with-api-key=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "If an API key should be created with the consumer.", "key": "with-api-key", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-77d1f309-c71c-4451-8d83-42536974f40c" }, { "id": "e1ffbe12-84f3-4998-a8f3-73d3a3514ba3", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"m6wvc2cpqr58alwnif34a4a-lc82-gvotwv\",\n \"managers\": [\n \"\",\n \"\"\n ],\n \"apiKeys\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"description\": \"\",\n \"tags\": {\n \"dolor_d3\": \"\",\n \"velit1f\": \"\",\n \"elit_3d6\": \"\"\n },\n \"metadata\": {\n \"ex_9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?with-api-key=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "If an API key should be created with the consumer.", "key": "with-api-key", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-e1ffbe12-84f3-4998-a8f3-73d3a3514ba3" }, { "id": "65464b80-10a6-485d-bf8b-0d8801c7b1c5", "name": "Rate Limiting Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"m6wvc2cpqr58alwnif34a4a-lc82-gvotwv\",\n \"managers\": [\n \"\",\n \"\"\n ],\n \"apiKeys\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"description\": \"\",\n \"tags\": {\n \"dolor_d3\": \"\",\n \"velit1f\": \"\",\n \"elit_3d6\": \"\"\n },\n \"metadata\": {\n \"ex_9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?with-api-key=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "If an API key should be created with the consumer.", "key": "with-api-key", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-65464b80-10a6-485d-bf8b-0d8801c7b1c5" }, { "id": "6075ddad-f493-4cb6-8171-b1b8dd3c8d2d", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"m6wvc2cpqr58alwnif34a4a-lc82-gvotwv\",\n \"managers\": [\n \"\",\n \"\"\n ],\n \"apiKeys\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"expiresOn\": \"\",\n \"description\": \"\",\n \"key\": \"\"\n }\n ],\n \"description\": \"\",\n \"tags\": {\n \"dolor_d3\": \"\",\n \"velit1f\": \"\",\n \"elit_3d6\": \"\"\n },\n \"metadata\": {\n \"ex_9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName/consumers?with-api-key=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName", "consumers" ], "query": [ { "description": "If an API key should be created with the consumer.", "key": "with-api-key", "value": "" } ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6075ddad-f493-4cb6-8171-b1b8dd3c8d2d" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-89c4d580-75c1-4bb8-bf7e-d5ac648bbde0" } ], "id": "530b307b-b110-45f6-965d-67683573aa7f", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-530b307b-b110-45f6-965d-67683573aa7f" }, { "name": "Gets a Bucket", "id": "04c1c8f4-e13b-45ce-99a7-7c6661e2575e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "id": "be440461-76d2-48d9-9e9e-c7511df533b5", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "6f1c3584-90a3-49dc-b76e-8f3144adf447", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." } ] }, "description": "Returns the details for a bucket, including the token used to connect to the bucket." }, "response": [ { "id": "2e70af1e-700c-49dd-aea5-b837523e1fad", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"name\": \"3jb007c7p3gcuwvuq3apw1616-796lnyiepxu2dx6j3jpzvz0oi4v4ej3fvy0igi1bl-elcqw83badjprwyjzmzgx4o3b2xk2srmxi8ykz4gongxj1h\",\n \"isRetrievable\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"incididunt79d\": \"\",\n \"enim2\": \"\"\n }\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-2e70af1e-700c-49dd-aea5-b837523e1fad" }, { "id": "629aed43-1675-4047-87ad-5c78f8fa7b9b", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-629aed43-1675-4047-87ad-5c78f8fa7b9b" }, { "id": "4573e265-e3fe-4ce1-b79d-65edc51cb2d9", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-4573e265-e3fe-4ce1-b79d-65edc51cb2d9" }, { "id": "2e64dcc9-de01-4e63-968e-033d379529b8", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-2e64dcc9-de01-4e63-968e-033d379529b8" }, { "id": "181f0ca8-5148-412d-9d9b-5f27be4b1fb4", "name": "Rate Limiting Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-181f0ca8-5148-412d-9d9b-5f27be4b1fb4" }, { "id": "758faaee-17f8-4da6-acaa-d5a761b98b49", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-758faaee-17f8-4da6-acaa-d5a761b98b49" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-04c1c8f4-e13b-45ce-99a7-7c6661e2575e" }, { "name": "Updates a Bucket", "id": "bc7ce6f4-0209-42ac-a5e1-95d0e5c95ae3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"minim0_\": \"\",\n \"Lorem_a1c\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "id": "cab95787-e82c-45f1-9bcf-15787d63b3fc", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "639199a0-87d6-4aff-ab2d-867699d2b3ff", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." } ] }, "description": "Updates a bucket, and returns the updated value." }, "response": [ { "id": "ff074827-4951-48c5-8d41-89fdf698670a", "name": "The request has succeeded.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"minim0_\": \"\",\n \"Lorem_a1c\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"name\": \"3jb007c7p3gcuwvuq3apw1616-796lnyiepxu2dx6j3jpzvz0oi4v4ej3fvy0igi1bl-elcqw83badjprwyjzmzgx4o3b2xk2srmxi8ykz4gongxj1h\",\n \"isRetrievable\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"incididunt79d\": \"\",\n \"enim2\": \"\"\n }\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ff074827-4951-48c5-8d41-89fdf698670a" }, { "id": "6c949d06-3fdd-4a07-8e45-09020051ab85", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"minim0_\": \"\",\n \"Lorem_a1c\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6c949d06-3fdd-4a07-8e45-09020051ab85" }, { "id": "8ded0f3e-484f-4735-acce-b8cc4b973957", "name": "Access is unauthorized.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"minim0_\": \"\",\n \"Lorem_a1c\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-8ded0f3e-484f-4735-acce-b8cc4b973957" }, { "id": "b407c638-ab68-435e-9ea6-d0a4538c8513", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"minim0_\": \"\",\n \"Lorem_a1c\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-b407c638-ab68-435e-9ea6-d0a4538c8513" }, { "id": "bbf5bdd2-08c5-403f-a185-a479389a3cac", "name": "Rate Limiting Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"minim0_\": \"\",\n \"Lorem_a1c\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-bbf5bdd2-08c5-403f-a185-a479389a3cac" }, { "id": "42d1b706-88af-4044-82bf-0b25546c030f", "name": "Server error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"tags\": {\n \"minim0_\": \"\",\n \"Lorem_a1c\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-42d1b706-88af-4044-82bf-0b25546c030f" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-bc7ce6f4-0209-42ac-a5e1-95d0e5c95ae3" }, { "name": "Deletes a Bucket", "id": "a6058382-3d85-4f01-b53c-c319aaebe5c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "id": "145c2af6-3988-48d0-bc80-6abe5b79c1b1", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "fa229daf-e683-4bed-94ef-97ab4f9e148f", "key": "bucketName", "value": "", "description": "(Required) The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information." } ] }, "description": "Deletes a bucket and any related resources" }, "response": [ { "id": "3ee32acc-760b-4868-b93c-053dba42985b", "name": "There is no content to send for this request, but the headers may be useful.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3ee32acc-760b-4868-b93c-053dba42985b" }, { "id": "b70e1a64-bef1-46f9-8cf5-b9df91331e2b", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-b70e1a64-bef1-46f9-8cf5-b9df91331e2b" }, { "id": "e5512d6a-1146-498c-9e25-a9d8cca7a252", "name": "Access is unauthorized.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-e5512d6a-1146-498c-9e25-a9d8cca7a252" }, { "id": "a1329e8b-54f1-472a-b1d3-01f999de9cc1", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-a1329e8b-54f1-472a-b1d3-01f999de9cc1" }, { "id": "155c9c73-717f-4a5d-8e26-eb416f1a6088", "name": "Rate Limiting Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-155c9c73-717f-4a5d-8e26-eb416f1a6088" }, { "id": "dd7b3862-a477-42dc-b7c1-eae20310c8ac", "name": "Server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets/:bucketName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets", ":bucketName" ], "variable": [ { "key": "accountName" }, { "key": "bucketName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-dd7b3862-a477-42dc-b7c1-eae20310c8ac" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-a6058382-3d85-4f01-b53c-c319aaebe5c0" } ], "id": "7c7ad3ea-3829-4e32-a599-57eebf305576", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-7c7ad3ea-3829-4e32-a599-57eebf305576" }, { "name": "Lists Buckets", "id": "2277800c-bc6e-4443-bb6b-b5e08c65eddc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "id": "98c12c9b-4cbc-4777-a26d-2955bcba10f6", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." } ] }, "description": "Lists all buckets belonging to this account." }, "response": [ { "id": "f5787871-7f75-4896-a6e8-7eca8a58f5e2", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "key": "accountName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"name\": \"n9il6tsa4qfp1xo\",\n \"isRetrievable\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"irure_82\": \"\",\n \"ut_ba\": \"\"\n }\n },\n {\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"name\": \"kmif9dnxb314gvo4cu7hbh-ozeb0ouee9fyw2q\",\n \"isRetrievable\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"ea_6\": \"\",\n \"incididunt__\": \"\"\n }\n }\n ],\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f5787871-7f75-4896-a6e8-7eca8a58f5e2" }, { "id": "36215eb2-289c-4b00-b066-dcfaaded2bc8", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "key": "accountName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-36215eb2-289c-4b00-b066-dcfaaded2bc8" }, { "id": "f1df7528-73c0-4c36-8db7-866cdbd077dd", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "key": "accountName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f1df7528-73c0-4c36-8db7-866cdbd077dd" }, { "id": "cc6b81e3-6db2-4c69-88d8-f44006f29cec", "name": "Rate Limiting Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "key": "accountName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-cc6b81e3-6db2-4c69-88d8-f44006f29cec" }, { "id": "0c8a21b0-e34e-421d-ab1d-66cf74301154", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "key": "accountName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0c8a21b0-e34e-421d-ab1d-66cf74301154" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-2277800c-bc6e-4443-bb6b-b5e08c65eddc" }, { "name": "Creates a Bucket", "id": "68700a57-74e3-4743-97d9-e8628f07fd54", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"zwmlhmaj6c8sl3jeo09c7ub027glvs65xikc40nrai54fn48j1uikhxcqp4mlwqghbs2w2e6gacve56\",\n \"description\": \"\",\n \"tags\": {\n \"non_76\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "id": "c708648b-4271-4b84-8468-ad7bdc738eb4", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." } ] }, "description": "Creates a new bucket for this account." }, "response": [ { "id": "3aea4b83-fceb-4547-a837-19324349a589", "name": "The request has succeeded.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"zwmlhmaj6c8sl3jeo09c7ub027glvs65xikc40nrai54fn48j1uikhxcqp4mlwqghbs2w2e6gacve56\",\n \"description\": \"\",\n \"tags\": {\n \"non_76\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "key": "accountName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"id\": \"\",\n \"name\": \"3jb007c7p3gcuwvuq3apw1616-796lnyiepxu2dx6j3jpzvz0oi4v4ej3fvy0igi1bl-elcqw83badjprwyjzmzgx4o3b2xk2srmxi8ykz4gongxj1h\",\n \"isRetrievable\": \"\",\n \"description\": \"\",\n \"tags\": {\n \"incididunt79d\": \"\",\n \"enim2\": \"\"\n }\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3aea4b83-fceb-4547-a837-19324349a589" }, { "id": "da63417e-0b64-492c-bf9b-1e6952c5f363", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"zwmlhmaj6c8sl3jeo09c7ub027glvs65xikc40nrai54fn48j1uikhxcqp4mlwqghbs2w2e6gacve56\",\n \"description\": \"\",\n \"tags\": {\n \"non_76\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "key": "accountName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-da63417e-0b64-492c-bf9b-1e6952c5f363" }, { "id": "814f48df-9680-411c-b718-dea87887f6d4", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"zwmlhmaj6c8sl3jeo09c7ub027glvs65xikc40nrai54fn48j1uikhxcqp4mlwqghbs2w2e6gacve56\",\n \"description\": \"\",\n \"tags\": {\n \"non_76\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "key": "accountName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-814f48df-9680-411c-b718-dea87887f6d4" }, { "id": "ed904098-5c2d-4c37-9301-3c4a61dee190", "name": "Rate Limiting Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"zwmlhmaj6c8sl3jeo09c7ub027glvs65xikc40nrai54fn48j1uikhxcqp4mlwqghbs2w2e6gacve56\",\n \"description\": \"\",\n \"tags\": {\n \"non_76\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "key": "accountName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "The number of seconds to wait before making a new request.", "type": "text/plain" }, "key": "retry-after", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ed904098-5c2d-4c37-9301-3c4a61dee190" }, { "id": "8ec0ae4f-87df-485e-a999-489c95cbf182", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"zwmlhmaj6c8sl3jeo09c7ub027glvs65xikc40nrai54fn48j1uikhxcqp4mlwqghbs2w2e6gacve56\",\n \"description\": \"\",\n \"tags\": {\n \"non_76\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/key-buckets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "key-buckets" ], "variable": [ { "key": "accountName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-8ec0ae4f-87df-485e-a999-489c95cbf182" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-68700a57-74e3-4743-97d9-e8628f07fd54" } ], "id": "e53bb2ae-ab85-4e5f-9c6f-00bdcc49f91b", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-e53bb2ae-ab85-4e5f-9c6f-00bdcc49f91b" }, { "name": "projects", "item": [ { "name": "{projectName}", "item": [ { "name": "branches", "item": [ { "name": "{branchName}", "item": [ { "name": "variables", "item": [ { "name": "{variableName}", "item": [ { "name": "Updates a Variable", "id": "f90fec86-1241-45f8-b606-61bee1185364", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables/:variableName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "branches", ":branchName", "variables", ":variableName" ], "variable": [ { "id": "938f1e1d-059a-4458-8b99-224b8ba25af7", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "97924ee2-aab5-4fef-abad-c2755c1d173d", "key": "projectName", "value": "", "description": "(Required) The name of the project. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "d63366a3-69ca-478a-8e12-3db3f2d0b5e7", "key": "branchName", "value": "", "description": "(Required) The name of the branch in your source control provider." }, { "id": "f0545858-88e3-4f3d-836a-9e0c6f9daba9", "key": "variableName", "value": "", "description": "(Required) The name of the environment variable." } ] }, "description": "Update the value of a variable in a branch for a given project." }, "response": [ { "id": "6b9e6643-2d06-4637-b816-025e9c7c9d8d", "name": "The request has succeeded.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables/:variableName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "branches", ":branchName", "variables", ":variableName" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "branchName" }, { "key": "variableName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"branch\": \"\",\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"name\": \"\",\n \"isSecret\": \"\",\n \"value\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6b9e6643-2d06-4637-b816-025e9c7c9d8d" }, { "id": "ff977ed3-ee3b-4f12-a54e-680f7725b480", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables/:variableName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "branches", ":branchName", "variables", ":variableName" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "branchName" }, { "key": "variableName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ff977ed3-ee3b-4f12-a54e-680f7725b480" }, { "id": "d366229c-1a13-44f3-acfc-94e724ff3c6d", "name": "Access is unauthorized.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables/:variableName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "branches", ":branchName", "variables", ":variableName" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "branchName" }, { "key": "variableName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-d366229c-1a13-44f3-acfc-94e724ff3c6d" }, { "id": "e7c0eee2-db1d-4646-92c2-9326763f4536", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables/:variableName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "branches", ":branchName", "variables", ":variableName" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "branchName" }, { "key": "variableName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-e7c0eee2-db1d-4646-92c2-9326763f4536" }, { "id": "a28983f2-f413-4994-a408-382316737aa6", "name": "Server error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables/:variableName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "branches", ":branchName", "variables", ":variableName" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "branchName" }, { "key": "variableName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-a28983f2-f413-4994-a408-382316737aa6" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f90fec86-1241-45f8-b606-61bee1185364" } ], "id": "0eaa8b67-f791-4429-92a9-84f033ca0ba9", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0eaa8b67-f791-4429-92a9-84f033ca0ba9" }, { "name": "Creates a Variable", "id": "a1c33859-1f73-45d7-87f8-87d1d5a267f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"isSecret\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "branches", ":branchName", "variables" ], "variable": [ { "id": "c1986760-1cb1-4af5-9bed-2afcaf88562d", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "d079e7cc-21d0-4c91-9212-12aed096cbe0", "key": "projectName", "value": "", "description": "(Required) The name of the project. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "73fc50ed-06bc-471d-8806-303f391d898c", "key": "branchName", "value": "", "description": "(Required) The name of the branch in your source control provider." } ] }, "description": "Creates a new environment variable in a branch for a given project." }, "response": [ { "id": "eb327cab-4687-4d09-8c2c-722d49f4cefe", "name": "The request has succeeded and a new resource has been created as a result.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"isSecret\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "branches", ":branchName", "variables" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "branchName" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"branch\": \"\",\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"name\": \"\",\n \"isSecret\": \"\",\n \"value\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-eb327cab-4687-4d09-8c2c-722d49f4cefe" }, { "id": "1c1e8014-76a2-4638-9dde-7609336858ac", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"isSecret\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "branches", ":branchName", "variables" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "branchName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-1c1e8014-76a2-4638-9dde-7609336858ac" }, { "id": "ee55c930-b121-40c5-a398-9f8bd72924b2", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"isSecret\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "branches", ":branchName", "variables" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "branchName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ee55c930-b121-40c5-a398-9f8bd72924b2" }, { "id": "3443c634-cb19-430b-a715-31d7d1f8413c", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"isSecret\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/branches/:branchName/variables", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "branches", ":branchName", "variables" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "branchName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3443c634-cb19-430b-a715-31d7d1f8413c" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-a1c33859-1f73-45d7-87f8-87d1d5a267f7" } ], "id": "86791418-30bd-4909-bdb7-e1b1f15b2f0a", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-86791418-30bd-4909-bdb7-e1b1f15b2f0a" } ], "id": "cb2f20e0-3080-4f20-9692-7693863f332a", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-cb2f20e0-3080-4f20-9692-7693863f332a" } ], "id": "3bc7f744-e969-41f9-a729-b8f0ceeb0a87", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3bc7f744-e969-41f9-a729-b8f0ceeb0a87" }, { "name": "deployment-status", "item": [ { "name": "{statusId}", "item": [ { "name": "Gets a Deployment Status", "id": "386cb472-7bd3-47c5-89e8-33c1e8091c54", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/deployment-status/:statusId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "deployment-status", ":statusId" ], "variable": [ { "id": "d271e3a1-42d6-4679-8cdf-a839a343290b", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "f583e73e-826c-410d-9f94-adf0ac9bd7ea", "key": "projectName", "value": "", "description": "(Required) The name of the project. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "ef319122-36b3-49bc-aa88-0b6533a53cb0", "key": "statusId", "value": "", "description": "(Required) The UUID of the uploaded sources." } ] }, "description": "Gets the deployment status of your upload. Use the UUID of the uploaded sources as the `statusId`." }, "response": [ { "id": "aef7b1bc-2aca-4abd-9d14-baf24ede84f3", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/deployment-status/:statusId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "deployment-status", ":statusId" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "statusId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"IN_PROGRESS\",\n \"url\": \"\",\n \"steps\": {\n \"utb\": {},\n \"reprehenderit_f2\": {},\n \"veniam_26\": {}\n },\n \"buildResult\": {\n \"do0\": {}\n }\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-aef7b1bc-2aca-4abd-9d14-baf24ede84f3" }, { "id": "cae597dc-b0f9-451a-8762-c3a4c78592b8", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/deployment-status/:statusId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "deployment-status", ":statusId" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "statusId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-cae597dc-b0f9-451a-8762-c3a4c78592b8" }, { "id": "f2ca4e42-86a7-4a0b-9eb7-4323ba8f6e74", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/deployment-status/:statusId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "deployment-status", ":statusId" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "statusId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f2ca4e42-86a7-4a0b-9eb7-4323ba8f6e74" }, { "id": "7e20868b-dea4-44c9-ab05-dc232bace2df", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/deployment-status/:statusId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "deployment-status", ":statusId" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "statusId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-7e20868b-dea4-44c9-ab05-dc232bace2df" }, { "id": "3136a525-64c3-4549-a516-d61cbc876583", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/deployment-status/:statusId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "deployment-status", ":statusId" ], "variable": [ { "key": "accountName" }, { "key": "projectName" }, { "key": "statusId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3136a525-64c3-4549-a516-d61cbc876583" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-386cb472-7bd3-47c5-89e8-33c1e8091c54" } ], "id": "0b696e50-c0f9-4cd9-a2da-630178fe0325", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0b696e50-c0f9-4cd9-a2da-630178fe0325" } ], "id": "616bfcdc-35f9-48a3-86e3-f414d0a0bf88", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-616bfcdc-35f9-48a3-86e3-f414d0a0bf88" }, { "name": "deployments", "item": [ { "name": "Lists Deployments", "id": "87ef68b4-ac6d-42db-a3ee-6d4c0b527252", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/deployments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "deployments" ], "variable": [ { "id": "075d63d9-b1f7-4d43-a7b5-036a883a8a50", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "2ae8a56c-9365-472b-af5e-6b681225af45", "key": "projectName", "value": "", "description": "(Required) The name of the project. You can find this in your Zuplo Portal under Settings > Project Information." } ] }, "description": "Lists the deployments for the specified account and project." }, "response": [ { "id": "988593ef-39c8-482a-ba40-85983fb27d4e", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/deployments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "deployments" ], "variable": [ { "key": "accountName" }, { "key": "projectName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"name\": \"\",\n \"url\": \"\",\n \"label\": \"\",\n \"urlParameter\": \"\",\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"loggingId\": \"\",\n \"accountName\": \"\",\n \"projectName\": \"\",\n \"state\": \"\",\n \"message\": \"\",\n \"branchName\": \"\",\n \"environmentType\": \"\"\n },\n {\n \"name\": \"\",\n \"url\": \"\",\n \"label\": \"\",\n \"urlParameter\": \"\",\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"loggingId\": \"\",\n \"accountName\": \"\",\n \"projectName\": \"\",\n \"state\": \"\",\n \"message\": \"\",\n \"branchName\": \"\",\n \"environmentType\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-988593ef-39c8-482a-ba40-85983fb27d4e" }, { "id": "bfdeb925-903b-4fec-b699-94fb53d08528", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/deployments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "deployments" ], "variable": [ { "key": "accountName" }, { "key": "projectName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-bfdeb925-903b-4fec-b699-94fb53d08528" }, { "id": "b1e73cf7-e449-4d21-850d-b547a84c498a", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/deployments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "deployments" ], "variable": [ { "key": "accountName" }, { "key": "projectName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-b1e73cf7-e449-4d21-850d-b547a84c498a" }, { "id": "993cae3d-d52d-4bd4-990e-634e85a0b356", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/projects/:projectName/deployments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "projects", ":projectName", "deployments" ], "variable": [ { "key": "accountName" }, { "key": "projectName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-993cae3d-d52d-4bd4-990e-634e85a0b356" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-87ef68b4-ac6d-42db-a3ee-6d4c0b527252" } ], "id": "f0b57512-98c8-4f8c-9f9c-9e2b694ee530", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f0b57512-98c8-4f8c-9f9c-9e2b694ee530" } ], "id": "1302364d-f65a-496a-8f9a-36c161f50e74", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-1302364d-f65a-496a-8f9a-36c161f50e74" } ], "id": "77ef931e-48f5-41d7-9927-9387b2555d06", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-77ef931e-48f5-41d7-9927-9387b2555d06" }, { "name": "tunnels", "item": [ { "name": "{tunnelId}", "item": [ { "name": "$rotate-token", "item": [ { "name": "Rotates the Token", "id": "0576415d-9af4-453a-a3f4-ca72321e4581", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/$rotate-token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "$rotate-token" ], "variable": [ { "id": "923ec4fe-b4ba-48fb-8bb5-244ba3f2c8be", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "adb610cd-deef-4f65-927a-baaa3ea9de4f", "key": "tunnelId", "value": "", "description": "(Required) The ID of the tunnel." } ] }, "description": "Rotates the token used to connect to the tunnel." }, "response": [ { "id": "34b8882b-db04-49cf-9e87-7bbf21e5ed9d", "name": "The request has succeeded.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/$rotate-token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "$rotate-token" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"tunnelId\": \"\",\n \"name\": \"nOTw54hHORS6uM8PFSdOFelT\",\n \"token\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-34b8882b-db04-49cf-9e87-7bbf21e5ed9d" }, { "id": "f653aa20-c604-4db8-b93e-36c7e199be31", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/$rotate-token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "$rotate-token" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f653aa20-c604-4db8-b93e-36c7e199be31" }, { "id": "c98284c4-43f2-4a43-952e-0986d7892796", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/$rotate-token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "$rotate-token" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c98284c4-43f2-4a43-952e-0986d7892796" }, { "id": "4f3bacc1-462c-48b7-9e11-c8c052e298e1", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/$rotate-token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "$rotate-token" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-4f3bacc1-462c-48b7-9e11-c8c052e298e1" }, { "id": "b3146b00-a200-469c-b38d-2063b0e9b1a7", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/$rotate-token", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "$rotate-token" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-b3146b00-a200-469c-b38d-2063b0e9b1a7" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0576415d-9af4-453a-a3f4-ca72321e4581" } ], "id": "f36082c2-07e4-497a-bd72-abf2395f5f93", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f36082c2-07e4-497a-bd72-abf2395f5f93" }, { "name": "provisioning-operations", "item": [ { "name": "{operationId}", "item": [ { "name": "Gets a Provisioning Status", "id": "d0fd7d4a-9943-461b-ad8a-801fb19a5fd6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/provisioning-operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "provisioning-operations", ":operationId" ], "variable": [ { "id": "e7e23a52-32a1-47ea-b710-0d46a68cfd7f", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "3b8bc54e-d43a-43bc-8f08-99745d2ba38d", "key": "tunnelId", "value": "", "description": "(Required) The ID of the tunnel." }, { "id": "836410d6-ea81-4b1c-b2da-93632455aa25", "key": "operationId", "value": "", "description": "(Required) The ID of the operation." } ] }, "description": "This endpoint returns the status of the services that the tunnel is currently configured for. Provisioning the services is an asynchronous process so this endpoint allows you to poll the status." }, "response": [ { "id": "deb6a150-b6f6-4aa3-b52e-f87fdccc6323", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/provisioning-operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "provisioning-operations", ":operationId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" }, { "key": "operationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"success\",\n \"message\": \"\",\n \"details\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-deb6a150-b6f6-4aa3-b52e-f87fdccc6323" }, { "id": "e6c315da-ebbd-4d09-a839-117c5c7c79aa", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/provisioning-operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "provisioning-operations", ":operationId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" }, { "key": "operationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-e6c315da-ebbd-4d09-a839-117c5c7c79aa" }, { "id": "1c87a65d-de10-46e2-950b-ca36d4056b3e", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/provisioning-operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "provisioning-operations", ":operationId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" }, { "key": "operationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-1c87a65d-de10-46e2-950b-ca36d4056b3e" }, { "id": "7dc2f3e9-0ffb-47d0-b923-89d6274a195a", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/provisioning-operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "provisioning-operations", ":operationId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" }, { "key": "operationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-7dc2f3e9-0ffb-47d0-b923-89d6274a195a" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-d0fd7d4a-9943-461b-ad8a-801fb19a5fd6" } ], "id": "2314456e-72f5-49ef-bfbb-a865dcdcdcad", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-2314456e-72f5-49ef-bfbb-a865dcdcdcad" } ], "id": "ac28edd9-6d0d-4d95-93ff-7f0807b19b6c", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ac28edd9-6d0d-4d95-93ff-7f0807b19b6c" }, { "name": "services-configuration", "item": [ { "name": "Gets a Service Configuration", "id": "fbdf1066-01fe-4ee6-97e4-b15762b514dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "services-configuration" ], "variable": [ { "id": "4bb52f8c-d488-4196-ae12-fed8b6f9715f", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "3a19e7c0-b6aa-4ae1-85d8-f15612aa66d7", "key": "tunnelId", "value": "", "description": "(Required) The ID of the tunnel." } ] }, "description": "This endpoint returns a snapshot of the services that the tunnel is currently configured for." }, "response": [ { "id": "51a01c32-a545-4899-98a7-6b99bdfcf36a", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "services-configuration" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"version\": \"\",\n \"services\": [\n {\n \"name\": \"OOlEJ7EvuAmqcK6RppJl\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"working-copy\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"production\"\n ]\n }\n ]\n },\n {\n \"name\": \"Zcs1K587ilRmJvESybmGwN3\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"preview\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"preview\",\n \"preview\"\n ]\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-51a01c32-a545-4899-98a7-6b99bdfcf36a" }, { "id": "7cceb858-38f4-4c4d-8220-a9e17c193a54", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "services-configuration" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-7cceb858-38f4-4c4d-8220-a9e17c193a54" }, { "id": "61bce490-43eb-4c44-98b5-b4a89e051722", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "services-configuration" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-61bce490-43eb-4c44-98b5-b4a89e051722" }, { "id": "40bd85b4-4d70-4b63-a47d-a0505399ce00", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "services-configuration" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-40bd85b4-4d70-4b63-a47d-a0505399ce00" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-fbdf1066-01fe-4ee6-97e4-b15762b514dd" }, { "name": "Configures Tunnel Services", "id": "a90f4f1f-b3dd-4779-9529-377eab41ba3d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"services\": [\n {\n \"name\": \"OOlEJ7EvuAmqcK6RppJl\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"working-copy\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"production\"\n ]\n }\n ]\n },\n {\n \"name\": \"Zcs1K587ilRmJvESybmGwN3\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"preview\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"preview\",\n \"preview\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "services-configuration" ], "variable": [ { "id": "fbb0a427-309a-42dd-a231-91aa3b013b81", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "db7c7355-fd6c-412d-8a45-b650a518a817", "key": "tunnelId", "value": "", "description": "(Required) The ID of the tunnel." } ] }, "description": "This endpoint reads the request body and creates/updates/delete the services that the tunnel connects to." }, "response": [ { "id": "dd00b388-89e5-4584-9f3f-227c4b09cde3", "name": "The request has succeeded.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"services\": [\n {\n \"name\": \"OOlEJ7EvuAmqcK6RppJl\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"working-copy\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"production\"\n ]\n }\n ]\n },\n {\n \"name\": \"Zcs1K587ilRmJvESybmGwN3\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"preview\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"preview\",\n \"preview\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "services-configuration" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"success\",\n \"message\": \"\",\n \"details\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-dd00b388-89e5-4584-9f3f-227c4b09cde3" }, { "id": "915bbd56-7e15-45b1-9a29-32fe994c6f2f", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"services\": [\n {\n \"name\": \"OOlEJ7EvuAmqcK6RppJl\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"working-copy\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"production\"\n ]\n }\n ]\n },\n {\n \"name\": \"Zcs1K587ilRmJvESybmGwN3\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"preview\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"preview\",\n \"preview\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "services-configuration" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-915bbd56-7e15-45b1-9a29-32fe994c6f2f" }, { "id": "43cd6ef0-896d-4c86-be26-481cf9ba08d4", "name": "Access is unauthorized.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"services\": [\n {\n \"name\": \"OOlEJ7EvuAmqcK6RppJl\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"working-copy\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"production\"\n ]\n }\n ]\n },\n {\n \"name\": \"Zcs1K587ilRmJvESybmGwN3\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"preview\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"preview\",\n \"preview\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "services-configuration" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-43cd6ef0-896d-4c86-be26-481cf9ba08d4" }, { "id": "bb14f0b8-77c2-46f2-92ae-2e13b1a4c514", "name": "Server error", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"services\": [\n {\n \"name\": \"OOlEJ7EvuAmqcK6RppJl\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"working-copy\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"production\"\n ]\n }\n ]\n },\n {\n \"name\": \"Zcs1K587ilRmJvESybmGwN3\",\n \"endpoint\": \"\",\n \"configurations\": [\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"working-copy\",\n \"preview\"\n ]\n },\n {\n \"project\": \"\",\n \"accessibleBy\": [\n \"preview\",\n \"preview\"\n ]\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/services-configuration", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "services-configuration" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-bb14f0b8-77c2-46f2-92ae-2e13b1a4c514" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-a90f4f1f-b3dd-4779-9529-377eab41ba3d" } ], "id": "c935955a-b8ea-4347-8b89-bb2455fcc7d0", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c935955a-b8ea-4347-8b89-bb2455fcc7d0" }, { "name": "teardown-operations", "item": [ { "name": "{operationId}", "item": [ { "name": "Gets a Teardown Status", "id": "53003a8d-1408-493d-9a33-c9ec84ad6bc4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/teardown-operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "teardown-operations", ":operationId" ], "variable": [ { "id": "2209d5cf-866a-4b15-b604-a8919a0816bb", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "f590acaf-1522-476d-8349-fb9b79e0918b", "key": "tunnelId", "value": "", "description": "(Required) The ID of the tunnel." }, { "id": "1318b3c8-995d-4eff-9e4d-12e5f8987b1d", "key": "operationId", "value": "", "description": "(Required) The ID of the deletion operation." } ] }, "description": "This endpoint returns the status of the deletion of the tunnel. Tearing down the tunnel is an asynchronous process so this endpoint allows you to poll the status." }, "response": [ { "id": "3e93a24a-f3d5-4054-b9b1-c62147619fe3", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/teardown-operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "teardown-operations", ":operationId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" }, { "key": "operationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"error\",\n \"message\": \"\",\n \"details\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3e93a24a-f3d5-4054-b9b1-c62147619fe3" }, { "id": "f76a2015-13b1-4dd2-bf50-3685d3f992da", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/teardown-operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "teardown-operations", ":operationId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" }, { "key": "operationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f76a2015-13b1-4dd2-bf50-3685d3f992da" }, { "id": "095572f8-9fcf-4e5d-a6d6-259447aa6500", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/teardown-operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "teardown-operations", ":operationId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" }, { "key": "operationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-095572f8-9fcf-4e5d-a6d6-259447aa6500" }, { "id": "19fee469-71fb-490a-b57e-3fc9a9dc0a9f", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId/teardown-operations/:operationId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId", "teardown-operations", ":operationId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" }, { "key": "operationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-19fee469-71fb-490a-b57e-3fc9a9dc0a9f" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-53003a8d-1408-493d-9a33-c9ec84ad6bc4" } ], "id": "f0a12340-1a5f-4f6a-ad6e-823f1867fb02", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f0a12340-1a5f-4f6a-ad6e-823f1867fb02" } ], "id": "df6f9c16-b718-4d25-89a0-123bc957157b", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-df6f9c16-b718-4d25-89a0-123bc957157b" }, { "name": "Gets a Tunnel", "id": "8a1ecede-52f1-42f7-b97d-7c98e4d2c107", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "id": "1492b6b7-75e4-40bb-aeca-102303935c7a", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "a2243445-7aba-4579-8147-4666a50af2b2", "key": "tunnelId", "value": "", "description": "(Required) The ID of the tunnel." } ] }, "description": "Returns the details for a tunnel, including the token used to connect to the tunnel." }, "response": [ { "id": "1dab28bf-77cd-4e90-a496-9f27b8ecb422", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"tunnelId\": \"\",\n \"name\": \"nOTw54hHORS6uM8PFSdOFelT\",\n \"token\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-1dab28bf-77cd-4e90-a496-9f27b8ecb422" }, { "id": "c239488f-9029-4d6a-acd3-df7edd90263a", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c239488f-9029-4d6a-acd3-df7edd90263a" }, { "id": "6aadc75e-4364-4b79-95f8-d386335d2f6d", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6aadc75e-4364-4b79-95f8-d386335d2f6d" }, { "id": "429c149f-2975-4d10-8fc0-ec4b9a6601bc", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-429c149f-2975-4d10-8fc0-ec4b9a6601bc" }, { "id": "37d98389-a63d-4d2e-ae7b-9570a18e70aa", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-37d98389-a63d-4d2e-ae7b-9570a18e70aa" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-8a1ecede-52f1-42f7-b97d-7c98e4d2c107" }, { "name": "Deletes a Tunnel", "id": "e0bfde84-6cf3-4592-8d5d-439d230a9a95", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "id": "fa8c9280-8c4d-4ae8-bade-b3742a8e03d1", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." }, { "id": "241f566f-7be2-4b75-8aed-31598dd71161", "key": "tunnelId", "value": "", "description": "(Required) The ID of the tunnel." } ] }, "description": "Deletes a tunnel and any services that it has." }, "response": [ { "id": "9729d359-f392-49bd-9813-6c0e197d1e01", "name": "The request has succeeded.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"error\",\n \"message\": \"\",\n \"details\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-9729d359-f392-49bd-9813-6c0e197d1e01" }, { "id": "903433ec-0bad-4f64-9561-421d14d5af40", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-903433ec-0bad-4f64-9561-421d14d5af40" }, { "id": "d405d4a5-616d-4414-9f3c-023632c4f020", "name": "Access is unauthorized.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-d405d4a5-616d-4414-9f3c-023632c4f020" }, { "id": "29dc889d-4493-4953-b66b-63fc2c58557b", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-29dc889d-4493-4953-b66b-63fc2c58557b" }, { "id": "1f7638ed-2ec2-4554-b947-57dbccd20143", "name": "Server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels/:tunnelId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels", ":tunnelId" ], "variable": [ { "key": "accountName" }, { "key": "tunnelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-1f7638ed-2ec2-4554-b947-57dbccd20143" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-e0bfde84-6cf3-4592-8d5d-439d230a9a95" } ], "id": "6862d75e-9321-4793-9497-0deb54375e2c", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6862d75e-9321-4793-9497-0deb54375e2c" }, { "name": "Lists Tunnels", "id": "bde972bb-62c6-4bf8-94ed-5092f00f33f2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels" ], "variable": [ { "id": "0c618adc-c4be-473e-8e16-4be3f55ff985", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." } ] }, "description": "Lists all tunnels belonging to this account." }, "response": [ { "id": "a8b80ad0-3681-4476-bbd9-cb1e319f156e", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels" ], "variable": [ { "key": "accountName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"pYv891qe4hX9LAckrezTkUf\"\n },\n {\n \"id\": \"\",\n \"name\": \"0LHRk8vVvkOmibMtg80s\"\n }\n ],\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-a8b80ad0-3681-4476-bbd9-cb1e319f156e" }, { "id": "7572198c-f51d-487c-8ef5-782ed0833e7a", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels" ], "variable": [ { "key": "accountName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-7572198c-f51d-487c-8ef5-782ed0833e7a" }, { "id": "a57bd875-0b0e-4cec-b6b5-733f854ea4ab", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels" ], "variable": [ { "key": "accountName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-a57bd875-0b0e-4cec-b6b5-733f854ea4ab" }, { "id": "ac005c6b-1c71-4c1e-8710-772552d0df84", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels" ], "variable": [ { "key": "accountName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ac005c6b-1c71-4c1e-8710-772552d0df84" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-bde972bb-62c6-4bf8-94ed-5092f00f33f2" }, { "name": "Creates a Tunnel", "id": "d77622ea-a8be-4433-a176-a9b436b647f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tunnelId\": \"\",\n \"name\": \"nOTw54hHORS6uM8PFSdOFelT\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels" ], "variable": [ { "id": "b689ebe2-29d2-42d7-921f-b715209d56d2", "key": "accountName", "value": "", "description": "(Required) The name of the account. You can find this in your Zuplo Portal under Settings > Project Information." } ] }, "description": "Creates a new tunnel for this account." }, "response": [ { "id": "551a52a6-7611-41f8-9b7c-37c4497eab58", "name": "The request has succeeded and a new resource has been created as a result.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tunnelId\": \"\",\n \"name\": \"nOTw54hHORS6uM8PFSdOFelT\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels" ], "variable": [ { "key": "accountName" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"tunnelId\": \"\",\n \"name\": \"nOTw54hHORS6uM8PFSdOFelT\",\n \"token\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-551a52a6-7611-41f8-9b7c-37c4497eab58" }, { "id": "c145354c-8fc1-4899-a0e4-e08e130801df", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tunnelId\": \"\",\n \"name\": \"nOTw54hHORS6uM8PFSdOFelT\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels" ], "variable": [ { "key": "accountName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c145354c-8fc1-4899-a0e4-e08e130801df" }, { "id": "ccf58b2a-9cba-4b7f-8d80-48112672033c", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tunnelId\": \"\",\n \"name\": \"nOTw54hHORS6uM8PFSdOFelT\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels" ], "variable": [ { "key": "accountName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ccf58b2a-9cba-4b7f-8d80-48112672033c" }, { "id": "4cc27551-13ff-4f4b-a90c-1c09d93ccacd", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tunnelId\": \"\",\n \"name\": \"nOTw54hHORS6uM8PFSdOFelT\",\n \"token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/accounts/:accountName/tunnels", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts", ":accountName", "tunnels" ], "variable": [ { "key": "accountName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-4cc27551-13ff-4f4b-a90c-1c09d93ccacd" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-d77622ea-a8be-4433-a176-a9b436b647f6" } ], "id": "9278ef57-96d8-4b61-ad03-061840c3b74e", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-9278ef57-96d8-4b61-ad03-061840c3b74e" } ], "id": "9511b69e-b817-4a36-9b10-2dcf0fe3a716", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-9511b69e-b817-4a36-9b10-2dcf0fe3a716" } ], "id": "86bed24e-ce97-4ea4-9134-e83ff7d9bea5", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-86bed24e-ce97-4ea4-9134-e83ff7d9bea5" }, { "name": "deployments", "item": [ { "name": "sources", "item": [ { "name": "Upload Deployment Source", "id": "87088986-627d-4b70-99b5-47c2b5f1785c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"projectName\": \"\",\n \"branchName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/deployments/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", "sources" ] }, "description": "Creates a URL for uploading sources." }, "response": [ { "id": "64fae7da-d491-4f9a-be8c-5ab06376c5c5", "name": "The request has succeeded.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"projectName\": \"\",\n \"branchName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/deployments/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", "sources" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"uploadUrl\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-64fae7da-d491-4f9a-be8c-5ab06376c5c5" }, { "id": "ef633adf-0b88-4b1a-828a-b63b42e031c2", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"projectName\": \"\",\n \"branchName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/deployments/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", "sources" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ef633adf-0b88-4b1a-828a-b63b42e031c2" }, { "id": "534bda0f-73a9-4ba6-87ce-b6eb3aed563f", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"projectName\": \"\",\n \"branchName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/deployments/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", "sources" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-534bda0f-73a9-4ba6-87ce-b6eb3aed563f" }, { "id": "e38b235e-c65e-4565-a427-8021c2a6242d", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"\",\n \"projectName\": \"\",\n \"branchName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/deployments/sources", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", "sources" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-e38b235e-c65e-4565-a427-8021c2a6242d" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-87088986-627d-4b70-99b5-47c2b5f1785c" } ], "id": "77de9f30-adca-4744-bf9f-f4dd95096f05", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-77de9f30-adca-4744-bf9f-f4dd95096f05" }, { "name": "{deploymentName}", "item": [ { "name": "deploy", "item": [ { "name": "Re-deploy a Deployment", "id": "5f6ed7d1-653b-4615-9553-189d97e02a48", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName/deploy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName", "deploy" ], "variable": [ { "id": "bd0047de-7809-4182-95c9-0ff9700785bc", "key": "deploymentName", "value": "", "description": "(Required) The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments." } ] }, "description": "Re-deploys the specified deployment so that it can pick up new environment variables or other configuration changes." }, "response": [ { "id": "d490e4a7-0520-4429-9001-c05341a79e4d", "name": "The request has succeeded.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName/deploy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName", "deploy" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-d490e4a7-0520-4429-9001-c05341a79e4d" }, { "id": "07e85eae-4086-48e3-9fe4-d17b4fb92d91", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName/deploy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName", "deploy" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-07e85eae-4086-48e3-9fe4-d17b4fb92d91" }, { "id": "98d418d4-fe72-4e0a-bc9f-1eb0dfd0969c", "name": "Access is unauthorized.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName/deploy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName", "deploy" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-98d418d4-fe72-4e0a-bc9f-1eb0dfd0969c" }, { "id": "9feeb0d4-848f-41f2-ab85-7860dab64c59", "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName/deploy", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName", "deploy" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-9feeb0d4-848f-41f2-ab85-7860dab64c59" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-5f6ed7d1-653b-4615-9553-189d97e02a48" } ], "id": "603dc183-53c6-417c-8dc0-17d13c7ef0d1", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-603dc183-53c6-417c-8dc0-17d13c7ef0d1" }, { "name": "Get a Deployment", "id": "e01479be-b3b7-401f-8c28-93ce68211868", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName" ], "variable": [ { "id": "bc29cc81-b945-4f1f-aefc-865aa56e7ba7", "key": "deploymentName", "value": "", "description": "(Required) The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments." } ] }, "description": "Gets the specified deployment." }, "response": [ { "id": "0409af8c-46b5-45dd-9f7c-5cf1f9d7fd51", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"url\": \"\",\n \"label\": \"\",\n \"urlParameter\": \"\",\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"loggingId\": \"\",\n \"accountName\": \"\",\n \"projectName\": \"\",\n \"state\": \"\",\n \"message\": \"\",\n \"branchName\": \"\",\n \"environmentType\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-0409af8c-46b5-45dd-9f7c-5cf1f9d7fd51" }, { "id": "be0038c5-6aca-4de7-8d4e-e60e6bdd929b", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-be0038c5-6aca-4de7-8d4e-e60e6bdd929b" }, { "id": "5625cc7c-b713-4d9b-9094-27526012abf0", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-5625cc7c-b713-4d9b-9094-27526012abf0" }, { "id": "6b9f63b7-77f4-46e2-9012-a1f0a958dcc9", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6b9f63b7-77f4-46e2-9012-a1f0a958dcc9" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-e01479be-b3b7-401f-8c28-93ce68211868" }, { "name": "Deletes a Deployment", "id": "be8b2bb8-736c-42db-b655-fbe31387f2aa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName" ], "variable": [ { "id": "14776986-a0e5-4251-8d45-5f00fe094241", "key": "deploymentName", "value": "", "description": "(Required) The name of the deployment. You can find this in the Zuplo Portal under Settings > Environments." } ] }, "description": "Deletes the specified deployment." }, "response": [ { "id": "19cf488e-849c-4436-b7f8-9d8717371fc0", "name": "The request has succeeded.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-19cf488e-849c-4436-b7f8-9d8717371fc0" }, { "id": "5fe98b8b-5a9e-48b2-b491-1bb7193b0eb5", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-5fe98b8b-5a9e-48b2-b491-1bb7193b0eb5" }, { "id": "c724c226-3483-4022-9ddf-124ea42d8f4b", "name": "Access is unauthorized.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c724c226-3483-4022-9ddf-124ea42d8f4b" }, { "id": "6710b14f-5980-4b37-8f99-16f6c0306989", "name": "Server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/deployments/:deploymentName", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deployments", ":deploymentName" ], "variable": [ { "key": "deploymentName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-6710b14f-5980-4b37-8f99-16f6c0306989" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-be8b2bb8-736c-42db-b655-fbe31387f2aa" } ], "id": "c1ed5662-0bf5-4a1d-bb01-6ff697e4900e", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-c1ed5662-0bf5-4a1d-bb01-6ff697e4900e" } ], "id": "2855bc31-ee73-462a-aca5-289a8fe62c2e", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-2855bc31-ee73-462a-aca5-289a8fe62c2e" }, { "name": "who-am-i", "item": [ { "name": "Who Am I", "id": "83e42836-73ec-4ea8-bce2-a48d41b0c72e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/who-am-i", "host": [ "{{baseUrl}}" ], "path": [ "v1", "who-am-i" ] }, "description": "Returns basic information about the caller. Supports both API key and JWT authentication. The response always includes the subject identifier (`sub`). The `account` field is included when called with an API key, and `email` is included when called with a JWT that carries the email claim." }, "response": [ { "id": "957abfce-defe-4b14-9140-a8494b6a2e05", "name": "The request has succeeded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/who-am-i", "host": [ "{{baseUrl}}" ], "path": [ "v1", "who-am-i" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sub\": \"\",\n \"account\": \"\",\n \"email\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-957abfce-defe-4b14-9140-a8494b6a2e05" }, { "id": "ee780a74-f9fa-443d-8e8b-d777592333cb", "name": "The server could not understand the request due to invalid syntax.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/who-am-i", "host": [ "{{baseUrl}}" ], "path": [ "v1", "who-am-i" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-ee780a74-f9fa-443d-8e8b-d777592333cb" }, { "id": "3a883f16-4fed-4f4f-b652-20e0174b91e9", "name": "Access is unauthorized.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/who-am-i", "host": [ "{{baseUrl}}" ], "path": [ "v1", "who-am-i" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-3a883f16-4fed-4f4f-b652-20e0174b91e9" }, { "id": "5dfeb048-b02e-4836-bae8-098c5bdf6ce8", "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/who-am-i", "host": [ "{{baseUrl}}" ], "path": [ "v1", "who-am-i" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-5dfeb048-b02e-4836-bae8-098c5bdf6ce8" } ], "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-83e42836-73ec-4ea8-bce2-a48d41b0c72e" } ], "id": "b6cde44f-6946-4ecd-b8c3-0ac1928e2c3b", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-b6cde44f-6946-4ecd-b8c3-0ac1928e2c3b" } ], "id": "f11e5758-c574-477d-823c-2fd4e91f406b", "createdAt": "2026-06-05T15:22:40.000Z", "updatedAt": "2026-06-05T15:22:40.000Z", "uid": "35240-f11e5758-c574-477d-823c-2fd4e91f406b" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://dev.zuplo.com" } ] }