{ "info": { "_postman_id": "3960fad0-b96c-4a26-ba11-34d43a84086e", "name": "Vendor API V3 apps enterprisePortal API", "description": "Manage enterprise portal users, install options, branding, documentation, email templates, and access control.\n\nContact Support:\n Name: Replicated, Inc.\n Email: info@replicated.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:45:20.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "lastUpdatedBy": "35240", "uid": "35240-3960fad0-b96c-4a26-ba11-34d43a84086e" }, "item": [ { "name": "app", "item": [ { "name": "{app_id}", "item": [ { "name": "enterprise-portal", "item": [ { "name": "access", "item": [ { "name": "Get download portal access settings", "id": "902fb53b-0341-44c0-a152-90a5378bc9cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "id": "4e93a20f-0f26-42b5-a75d-ad91af634044", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy: kots/app/[:appid]/enterprise-portal/access/read" }, "response": [ { "id": "ec08328c-8940-44e5-adf5-162630c43c32", "name": "GetEnterprisePortalAccessResponse represents the access settings 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}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"auto_invite_to_ep_on_create\": \"\",\n \"download_portal_disabled\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ec08328c-8940-44e5-adf5-162630c43c32" }, { "id": "e1c3d44b-009a-4148-a792-ae84a3afced3", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e1c3d44b-009a-4148-a792-ae84a3afced3" }, { "id": "8b154d32-6687-4627-be94-1aba60e8ec9d", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-8b154d32-6687-4627-be94-1aba60e8ec9d" }, { "id": "f3809c9a-3534-4066-9ee7-ace0d5c2fa57", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-f3809c9a-3534-4066-9ee7-ace0d5c2fa57" }, { "id": "e008a56b-722f-4513-8212-0f30aef7c6d2", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e008a56b-722f-4513-8212-0f30aef7c6d2" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-902fb53b-0341-44c0-a152-90a5378bc9cc" }, { "name": "Update download portal access settings", "id": "e5b537a2-bfba-4b5c-9742-b81990270394", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"auto_invite_to_ep_on_create\": \"\",\n \"download_portal_disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "id": "5382d5b1-1fbb-444f-8ecc-245f6ac89e61", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy: kots/app/{app_id}/enterprise-portal/access/update" }, "response": [ { "id": "5a43b73d-e129-4990-9ca2-ec7ed4bef757", "name": "UpdateEnterprisePortalAccessResponse represents the access settings response", "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 \"auto_invite_to_ep_on_create\": \"\",\n \"download_portal_disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"auto_invite_to_ep_on_create\": \"\",\n \"download_portal_disabled\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-5a43b73d-e129-4990-9ca2-ec7ed4bef757" }, { "id": "b4638607-e27c-45e5-b729-88dbd2a4564a", "name": "Returned on bad input", "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 \"auto_invite_to_ep_on_create\": \"\",\n \"download_portal_disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-b4638607-e27c-45e5-b729-88dbd2a4564a" }, { "id": "dc1ecdcb-7092-40cf-99f1-f40b67e46712", "name": "Return if the caller is not authorized", "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 \"auto_invite_to_ep_on_create\": \"\",\n \"download_portal_disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-dc1ecdcb-7092-40cf-99f1-f40b67e46712" }, { "id": "f98240e3-16e5-41b5-80d1-f97a10966478", "name": "Returned if the caller does not have the needed permission", "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 \"auto_invite_to_ep_on_create\": \"\",\n \"download_portal_disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-f98240e3-16e5-41b5-80d1-f97a10966478" }, { "id": "d49adb5c-37c2-4ca5-a5f3-02b217dc1e3e", "name": "Returned on resource not found", "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 \"auto_invite_to_ep_on_create\": \"\",\n \"download_portal_disabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/access", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "access" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-d49adb5c-37c2-4ca5-a5f3-02b217dc1e3e" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e5b537a2-bfba-4b5c-9742-b81990270394" } ], "id": "00fabc4f-85f3-47c2-9d99-ce43f93083fb", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-00fabc4f-85f3-47c2-9d99-ce43f93083fb" }, { "name": "branding", "item": [ { "name": "Get custom branding for the enterprise portal", "id": "45588bf4-fe62-4826-8451-b5c361b53ef6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "id": "e53d9141-7621-4c29-8f81-63829a1844ec", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy: kots/app/[:appid]/enterprise-portal/branding/read" }, "response": [ { "id": "9aadae76-f34e-44ef-a548-493fb75ee6be", "name": "GetEnterprisePortalBrandingResponse represents the branding for the enterprise portal.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeEnterprisePortalTemplate\": \"\",\n \"branding\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9aadae76-f34e-44ef-a548-493fb75ee6be" }, { "id": "5e92363d-6441-4f4c-b93a-5fb5730a27d9", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-5e92363d-6441-4f4c-b93a-5fb5730a27d9" }, { "id": "666a1b6f-e941-48c8-84de-8b51121f16e4", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-666a1b6f-e941-48c8-84de-8b51121f16e4" }, { "id": "de7d9548-838e-47ff-b636-04d353d15d14", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-de7d9548-838e-47ff-b636-04d353d15d14" }, { "id": "32b288a6-8d33-44dc-8b7f-2b886b852121", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-32b288a6-8d33-44dc-8b7f-2b886b852121" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-45588bf4-fe62-4826-8451-b5c361b53ef6" }, { "name": "Update custom branding for the enterprise portal", "id": "075e6815-32a4-42a0-85c2-64c7dcb2a8b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"branding\": \"\",\n \"activeEnterprisePortalTemplate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "id": "b38057c8-6353-45b5-8929-306f501f9d81", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy: kots/app/{app_id}/enterprise-portal/branding/update" }, "response": [ { "id": "4be7c65c-a037-4801-92af-0aae913b781f", "name": "GetEnterprisePortalBrandingResponse represents the branding for the enterprise portal.", "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 \"branding\": \"\",\n \"activeEnterprisePortalTemplate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"activeEnterprisePortalTemplate\": \"\",\n \"branding\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-4be7c65c-a037-4801-92af-0aae913b781f" }, { "id": "d53dfbd0-51b6-44e8-acc4-b5ab32daacb3", "name": "Returned on bad input", "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 \"branding\": \"\",\n \"activeEnterprisePortalTemplate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-d53dfbd0-51b6-44e8-acc4-b5ab32daacb3" }, { "id": "bdfa34eb-520f-4c0c-9cb1-06afb45f5c5a", "name": "Return if the caller is not authorized", "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 \"branding\": \"\",\n \"activeEnterprisePortalTemplate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-bdfa34eb-520f-4c0c-9cb1-06afb45f5c5a" }, { "id": "3a4376cc-1a47-474d-b4a4-b9dbd8843b9c", "name": "Returned if the caller does not have the needed permission", "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 \"branding\": \"\",\n \"activeEnterprisePortalTemplate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-3a4376cc-1a47-474d-b4a4-b9dbd8843b9c" }, { "id": "4a7e0c8a-01bb-4366-b7a0-161df4c98a82", "name": "Returned on resource not found", "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 \"branding\": \"\",\n \"activeEnterprisePortalTemplate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/branding", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "branding" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-4a7e0c8a-01bb-4366-b7a0-161df4c98a82" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-075e6815-32a4-42a0-85c2-64c7dcb2a8b3" } ], "id": "db2a4b9f-071b-4f63-87f9-f713ac5098bf", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-db2a4b9f-071b-4f63-87f9-f713ac5098bf" }, { "name": "content-repos", "item": [ { "name": "{repo_id}", "item": [ { "name": "template-updates", "item": [ { "name": "acknowledge", "item": [ { "name": "Mark pending upstream content template updates reviewed for the current user.", "id": "46f3a059-72df-4ffe-97d3-035527c25eff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-repos/:repo_id/template-updates/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-repos", ":repo_id", "template-updates", "acknowledge" ], "variable": [ { "id": "b7a1843e-3a7c-470f-b3ad-0357175816df", "key": "app_id", "value": "", "description": "(Required) App identifier" }, { "id": "5c62df11-e91c-4696-a656-d40a2fa86ac4", "key": "repo_id", "value": "", "description": "(Required) Content repository identifier" } ] } }, "response": [ { "id": "c59969ab-d255-4eb6-88c9-fa218503a4ce", "name": "AcknowledgeContentTemplateUpdatesResponse contains the response from\nacknowledging upstream content template updates.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-repos/:repo_id/template-updates/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-repos", ":repo_id", "template-updates", "acknowledge" ], "variable": [ { "key": "app_id" }, { "key": "repo_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"acknowledged_through_at\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-c59969ab-d255-4eb6-88c9-fa218503a4ce" }, { "id": "99f621bf-8db6-4751-a635-6da948e18507", "name": "Return if the caller is not authorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-repos/:repo_id/template-updates/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-repos", ":repo_id", "template-updates", "acknowledge" ], "variable": [ { "key": "app_id" }, { "key": "repo_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-99f621bf-8db6-4751-a635-6da948e18507" }, { "id": "c4503305-4e86-4265-b74f-537d67beb7c3", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-repos/:repo_id/template-updates/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-repos", ":repo_id", "template-updates", "acknowledge" ], "variable": [ { "key": "app_id" }, { "key": "repo_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-c4503305-4e86-4265-b74f-537d67beb7c3" }, { "id": "4b844e0a-b1fc-4e0d-ae5b-f8cd5f4102f8", "name": "Returned on resource not found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-repos/:repo_id/template-updates/acknowledge", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-repos", ":repo_id", "template-updates", "acknowledge" ], "variable": [ { "key": "app_id" }, { "key": "repo_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-4b844e0a-b1fc-4e0d-ae5b-f8cd5f4102f8" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-46f3a059-72df-4ffe-97d3-035527c25eff" } ], "id": "2adde98e-bd8d-4dc5-9ca0-4f1d88ecc292", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-2adde98e-bd8d-4dc5-9ca0-4f1d88ecc292" } ], "id": "d7d46f32-08ff-4fb2-ace2-67f7e04a4e99", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-d7d46f32-08ff-4fb2-ace2-67f7e04a4e99" } ], "id": "d7c7358d-fe49-4d08-ad06-59bad741f32d", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-d7c7358d-fe49-4d08-ad06-59bad741f32d" } ], "id": "fe0a0079-7676-461d-b8d9-12a638d37dab", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-fe0a0079-7676-461d-b8d9-12a638d37dab" }, { "name": "content-settings", "item": [ { "name": "Update Enterprise Portal content settings for an app.", "id": "62fd5ad7-fc3f-402f-a739-cfc71cf56526", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"hide_unmatched_content_versions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-settings" ], "variable": [ { "id": "45cadf9c-a04d-49a6-824c-39d547c1656e", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy: kots/app/[:appId]/enterprise-portal/documentation/update" }, "response": [ { "id": "cb846617-8231-4ea0-af8d-ab375bdeb5a1", "name": "New Response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"hide_unmatched_content_versions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-settings" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"settings\": {\n \"hide_unmatched_content_versions\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-cb846617-8231-4ea0-af8d-ab375bdeb5a1" }, { "id": "719cabbb-7c3c-4948-ac4b-47472b4d6610", "name": "Returned on bad input", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"hide_unmatched_content_versions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-settings" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-719cabbb-7c3c-4948-ac4b-47472b4d6610" }, { "id": "db36c736-f28f-4e1b-ac0b-8db99b738982", "name": "Return if the caller is not authorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"hide_unmatched_content_versions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-settings" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-db36c736-f28f-4e1b-ac0b-8db99b738982" }, { "id": "c10bc0ee-44a4-4936-8087-e501444f8f2d", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"hide_unmatched_content_versions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-settings" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-c10bc0ee-44a4-4936-8087-e501444f8f2d" }, { "id": "b1c4bee1-2165-4ab7-96ea-910db338675e", "name": "Returned on resource not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"hide_unmatched_content_versions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-settings" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-b1c4bee1-2165-4ab7-96ea-910db338675e" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-62fd5ad7-fc3f-402f-a739-cfc71cf56526" } ], "id": "bdf90d3e-4e81-408f-aa72-4fa9a0ad986e", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-bdf90d3e-4e81-408f-aa72-4fa9a0ad986e" }, { "name": "content-versions", "item": [ { "name": "pin", "item": [ { "name": "Pin a release version label to an existing content branch", "id": "74422e44-74f3-499c-aedb-b754c6774a66", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"version_label\": \"\",\n \"replace_existing\": \"\",\n \"source_branch_pattern\": \"\",\n \"source_version_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/pin", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", "pin" ], "variable": [ { "id": "5594fb01-e773-46d2-a94f-8275f71973fe", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Creates a virtual content branch row that pins a release version label to\nthe content of an existing real branch." }, "response": [ { "id": "479af5f9-b960-4abe-aeb5-4b3c6ae075e3", "name": "CreateContentVersionPinResponse contains the response from creating a\ncontent version pin.", "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 \"version_label\": \"\",\n \"replace_existing\": \"\",\n \"source_branch_pattern\": \"\",\n \"source_version_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/pin", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", "pin" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"version\": {\n \"branch\": \"\",\n \"created_at\": \"\",\n \"id\": \"\",\n \"last_sync_at\": \"\",\n \"last_sync_commit\": \"\",\n \"last_sync_error\": \"\",\n \"last_sync_notice\": \"\",\n \"repo_id\": \"\",\n \"source_version_id\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-479af5f9-b960-4abe-aeb5-4b3c6ae075e3" }, { "id": "3479b392-41ca-4b38-9607-0599f6eaa752", "name": "Returned on bad input", "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 \"version_label\": \"\",\n \"replace_existing\": \"\",\n \"source_branch_pattern\": \"\",\n \"source_version_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/pin", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", "pin" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-3479b392-41ca-4b38-9607-0599f6eaa752" }, { "id": "2eb85f07-481e-45b3-a730-589faf2af679", "name": "Return if the caller is not authorized", "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 \"version_label\": \"\",\n \"replace_existing\": \"\",\n \"source_branch_pattern\": \"\",\n \"source_version_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/pin", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", "pin" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-2eb85f07-481e-45b3-a730-589faf2af679" }, { "id": "74c04efd-edba-4eac-81d4-1d9ffe2b57a3", "name": "Returned if the caller does not have the needed permission", "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 \"version_label\": \"\",\n \"replace_existing\": \"\",\n \"source_branch_pattern\": \"\",\n \"source_version_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/pin", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", "pin" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-74c04efd-edba-4eac-81d4-1d9ffe2b57a3" }, { "id": "1793cba1-09db-4250-bf94-25982dbd87e5", "name": "Returned on resource not found", "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 \"version_label\": \"\",\n \"replace_existing\": \"\",\n \"source_branch_pattern\": \"\",\n \"source_version_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/pin", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", "pin" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-1793cba1-09db-4250-bf94-25982dbd87e5" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-74422e44-74f3-499c-aedb-b754c6774a66" } ], "id": "80db8c53-7ec3-4bac-ae98-771be9e60d35", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-80db8c53-7ec3-4bac-ae98-771be9e60d35" }, { "name": "{version_id}", "item": [ { "name": "dismiss-notice", "item": [ { "name": "Clear the sync notice for a content version.", "id": "a28d9900-e4da-415d-b79e-5277e88d9aea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/:version_id/dismiss-notice", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", ":version_id", "dismiss-notice" ], "variable": [ { "id": "187a1e47-2123-4e73-8cb5-70d33132c012", "key": "app_id", "value": "", "description": "(Required) App identifier" }, { "id": "7fd4aa78-5e82-42f4-8780-ef547c264d69", "key": "version_id", "value": "", "description": "(Required) Content version identifier" } ] } }, "response": [ { "id": "c784cbc5-309b-48f7-8dab-d36c076d602c", "name": "DismissContentVersionNoticeResponse contains the response from dismissing a\ncontent version notice.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/:version_id/dismiss-notice", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", ":version_id", "dismiss-notice" ], "variable": [ { "key": "app_id" }, { "key": "version_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-c784cbc5-309b-48f7-8dab-d36c076d602c" }, { "id": "86b08bea-ea58-44fb-bafd-6871548f4d93", "name": "Return if the caller is not authorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/:version_id/dismiss-notice", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", ":version_id", "dismiss-notice" ], "variable": [ { "key": "app_id" }, { "key": "version_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-86b08bea-ea58-44fb-bafd-6871548f4d93" }, { "id": "eff8bea2-1a5b-402a-8059-250c4cbe8728", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/:version_id/dismiss-notice", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", ":version_id", "dismiss-notice" ], "variable": [ { "key": "app_id" }, { "key": "version_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-eff8bea2-1a5b-402a-8059-250c4cbe8728" }, { "id": "5a901b26-9f3c-4858-a441-07ac435043f3", "name": "Returned on resource not found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/:version_id/dismiss-notice", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", ":version_id", "dismiss-notice" ], "variable": [ { "key": "app_id" }, { "key": "version_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-5a901b26-9f3c-4858-a441-07ac435043f3" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-a28d9900-e4da-415d-b79e-5277e88d9aea" } ], "id": "2acfb1b2-f2ee-4aca-bc3d-8d0f970438a8", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-2acfb1b2-f2ee-4aca-bc3d-8d0f970438a8" }, { "name": "Delete a content version", "id": "4e7d0d05-44e1-4cfb-8a59-cc02b42c9807", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/:version_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", ":version_id" ], "variable": [ { "id": "919b3369-56c2-47fc-9da6-65dc68481321", "key": "app_id", "value": "", "description": "(Required) App identifier" }, { "id": "48011152-194b-4cca-ae9b-07b2480ce3ae", "key": "version_id", "value": "", "description": "(Required) Content version identifier" } ] }, "description": "Removes a content version row and its pages, toc, and theme.\nMainly used to remove pin rows. Real-branch rows can be deleted too \u2014\nthey'll be recreated (empty) on the next sync." }, "response": [ { "id": "2df5c6d4-bf51-4118-9751-02a969913090", "name": "DeleteContentVersionResponse contains the response from deleting a content\nversion.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/:version_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", ":version_id" ], "variable": [ { "key": "app_id" }, { "key": "version_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-2df5c6d4-bf51-4118-9751-02a969913090" }, { "id": "7c77e050-4ea5-4b17-b1f2-917858e1180e", "name": "Returned on bad input", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/:version_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", ":version_id" ], "variable": [ { "key": "app_id" }, { "key": "version_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-7c77e050-4ea5-4b17-b1f2-917858e1180e" }, { "id": "5b44ce1e-96a9-4493-96b8-72bb5ecfaa7c", "name": "Return if the caller is not authorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/:version_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", ":version_id" ], "variable": [ { "key": "app_id" }, { "key": "version_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-5b44ce1e-96a9-4493-96b8-72bb5ecfaa7c" }, { "id": "cf4cb893-f044-4787-ae9d-c6470755307b", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/:version_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", ":version_id" ], "variable": [ { "key": "app_id" }, { "key": "version_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-cf4cb893-f044-4787-ae9d-c6470755307b" }, { "id": "8a127d6e-8c06-485b-97c4-db62d0c89585", "name": "Returned on resource not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/content-versions/:version_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "content-versions", ":version_id" ], "variable": [ { "key": "app_id" }, { "key": "version_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-8a127d6e-8c06-485b-97c4-db62d0c89585" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-4e7d0d05-44e1-4cfb-8a59-cc02b42c9807" } ], "id": "f6e41211-1cbe-4fe8-9197-7cd1694c3db5", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-f6e41211-1cbe-4fe8-9197-7cd1694c3db5" } ], "id": "2a4fae69-b727-459f-b013-13f44b0189fc", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-2a4fae69-b727-459f-b013-13f44b0189fc" }, { "name": "customer-allowed-domains", "item": [ { "name": "{allowedDomainId}", "item": [ { "name": "Delete a customer allowed domain for the enterprise portal", "id": "f34529f5-83ba-41f5-b6cf-171ce9084946", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains/:allowedDomainId?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains", ":allowedDomainId" ], "query": [ { "description": "(Required) The customer ID for the allowed domain", "key": "customer_id", "value": "" } ], "variable": [ { "id": "513f3e33-7a5a-4f68-9e01-e4ec900574fb", "key": "app_id", "value": "", "description": "(Required) App identifier" }, { "id": "066c9f90-2c61-4caa-be6c-e726a642badf", "key": "allowedDomainId", "value": "", "description": "(Required) The allowed domain ID to delete" } ] }, "description": "Required RBAC Policy:\nkots/app/[:appid]/enterprise-portal/customer-allowed-domains/delete\nkots/app/[:appid]/license/[:customer_id]/read" }, "response": [ { "id": "b3220dfd-37ac-417c-8f83-53835ea3f638", "name": "On success, no payload returned", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains/:allowedDomainId?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains", ":allowedDomainId" ], "query": [ { "description": "(Required) The customer ID for the allowed domain", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "allowedDomainId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-b3220dfd-37ac-417c-8f83-53835ea3f638" }, { "id": "5fca5c5f-b93c-4f98-9160-17fb9f726d42", "name": "Returned on bad input", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains/:allowedDomainId?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains", ":allowedDomainId" ], "query": [ { "description": "(Required) The customer ID for the allowed domain", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "allowedDomainId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-5fca5c5f-b93c-4f98-9160-17fb9f726d42" }, { "id": "9c8c47af-aa2d-4119-a330-ab22d4b05714", "name": "Return if the caller is not authorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains/:allowedDomainId?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains", ":allowedDomainId" ], "query": [ { "description": "(Required) The customer ID for the allowed domain", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "allowedDomainId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9c8c47af-aa2d-4119-a330-ab22d4b05714" }, { "id": "0e11b55e-7616-4ff9-a680-0954d50dde12", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains/:allowedDomainId?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains", ":allowedDomainId" ], "query": [ { "description": "(Required) The customer ID for the allowed domain", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "allowedDomainId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-0e11b55e-7616-4ff9-a680-0954d50dde12" }, { "id": "834568cd-0577-491a-a5ae-ee140ababd0c", "name": "Returned on resource not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains/:allowedDomainId?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains", ":allowedDomainId" ], "query": [ { "description": "(Required) The customer ID for the allowed domain", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "allowedDomainId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-834568cd-0577-491a-a5ae-ee140ababd0c" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-f34529f5-83ba-41f5-b6cf-171ce9084946" } ], "id": "e4d3cfa7-8897-4afc-8ec0-39626aa0dc97", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e4d3cfa7-8897-4afc-8ec0-39626aa0dc97" }, { "name": "List customer allowed domains for the enterprise portal", "id": "e05ef3a1-c34c-4712-8c67-ef72cc327a89", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "query": [ { "description": "(Required) Filter by customer ID", "key": "customer_id", "value": "" } ], "variable": [ { "id": "5c479e66-6f07-463b-b0aa-6b517d494f70", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy:\nkots/app/[:appid]/enterprise-portal/customer-allowed-domains/read\nkots/app/[:appid]/license/[:customer_id]/read" }, "response": [ { "id": "452ac7a1-ab57-4769-81aa-37d470ee9448", "name": "New 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}}/app/:app_id/enterprise-portal/customer-allowed-domains?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "query": [ { "description": "(Required) Filter by customer ID", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedDomains\": [\n {\n \"appId\": \"\",\n \"createdAt\": \"\",\n \"customerId\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"teamId\": \"\"\n },\n {\n \"appId\": \"\",\n \"createdAt\": \"\",\n \"customerId\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"teamId\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-452ac7a1-ab57-4769-81aa-37d470ee9448" }, { "id": "21fdb0f7-89df-478f-bd35-3c76c605ccfb", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "query": [ { "description": "(Required) Filter by customer ID", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-21fdb0f7-89df-478f-bd35-3c76c605ccfb" }, { "id": "f1b48c83-c851-47dd-bfcb-225526d35efb", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "query": [ { "description": "(Required) Filter by customer ID", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-f1b48c83-c851-47dd-bfcb-225526d35efb" }, { "id": "1a507199-dbb7-4f3f-9f21-8e9e5db756fe", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "query": [ { "description": "(Required) Filter by customer ID", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-1a507199-dbb7-4f3f-9f21-8e9e5db756fe" }, { "id": "3601b750-2df4-4409-a89d-ec1ed69e9173", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains?customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "query": [ { "description": "(Required) Filter by customer ID", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-3601b750-2df4-4409-a89d-ec1ed69e9173" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e05ef3a1-c34c-4712-8c67-ef72cc327a89" }, { "name": "Create a customer allowed domain for the enterprise portal", "id": "31b4ad29-826d-462b-896e-f8f2dd1e4fd5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"domain\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "variable": [ { "id": "0704336b-6c3f-43e6-83e9-83da593453c9", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy:\nkots/app/[:appid]/enterprise-portal/customer-allowed-domains/create\nkots/app/[:appid]/license/[:customer_id]/read" }, "response": [ { "id": "8106378d-6851-4868-99ee-77ed04c5c029", "name": "New 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 \"customer_id\": \"\",\n \"domain\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "variable": [ { "key": "app_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"allowedDomain\": {\n \"appId\": \"\",\n \"createdAt\": \"\",\n \"customerId\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"teamId\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-8106378d-6851-4868-99ee-77ed04c5c029" }, { "id": "ae15b2a2-8f13-4dc2-b5b8-4bc33fa6279c", "name": "Returned on bad input", "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 \"customer_id\": \"\",\n \"domain\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ae15b2a2-8f13-4dc2-b5b8-4bc33fa6279c" }, { "id": "4de27465-e6b8-4b4e-8d67-cd10fd3f073d", "name": "Return if the caller is not authorized", "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 \"customer_id\": \"\",\n \"domain\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-4de27465-e6b8-4b4e-8d67-cd10fd3f073d" }, { "id": "ca0b9c3b-4161-4053-9dfd-1c1a1c1c5710", "name": "Returned if the caller does not have the needed permission", "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 \"customer_id\": \"\",\n \"domain\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ca0b9c3b-4161-4053-9dfd-1c1a1c1c5710" }, { "id": "9424506f-0bb1-443b-8dbd-57aa8c4a4d44", "name": "Returned on resource not found", "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 \"customer_id\": \"\",\n \"domain\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-allowed-domains", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-allowed-domains" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9424506f-0bb1-443b-8dbd-57aa8c4a4d44" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-31b4ad29-826d-462b-896e-f8f2dd1e4fd5" } ], "id": "ab50e766-b605-42c4-b3a9-4fe7b29924bc", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ab50e766-b605-42c4-b3a9-4fe7b29924bc" }, { "name": "customer-user", "item": [ { "name": "Invite a customer user to the enterprise portal", "id": "192e15e2-5e2f-4427-91a0-702484510e67", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"email_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "variable": [ { "id": "6ac301a6-6d7b-4cb8-a45c-a21fc2b092a4", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Invite a customer user to the enterprise portal, sending an invite email to the customer user." }, "response": [ { "id": "8e1743bd-2702-4e99-879f-64d1f91fc1da", "name": "New 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 \"customer_id\": \"\",\n \"email_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "variable": [ { "key": "app_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"invite\": {\n \"appId\": \"\",\n \"appSlug\": \"\",\n \"createdAt\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"emailAddress\": \"\",\n \"expireAt\": \"\",\n \"id\": \"\",\n \"inviteNonce\": \"\",\n \"teamId\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-8e1743bd-2702-4e99-879f-64d1f91fc1da" }, { "id": "6b0ab865-6343-489f-800d-abe27581c17d", "name": "Returned on bad input", "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 \"customer_id\": \"\",\n \"email_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-6b0ab865-6343-489f-800d-abe27581c17d" }, { "id": "c08616d0-1fd9-495b-9c33-1ce5bc0c01ba", "name": "Return if the caller is not authorized", "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 \"customer_id\": \"\",\n \"email_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-c08616d0-1fd9-495b-9c33-1ce5bc0c01ba" }, { "id": "d7cc3c5f-9e50-4802-8164-be2c8fdbbef4", "name": "Returned if the caller does not have the needed permission", "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 \"customer_id\": \"\",\n \"email_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-d7cc3c5f-9e50-4802-8164-be2c8fdbbef4" }, { "id": "04bccf2a-51b1-4c97-87b1-c6504bc2cbe1", "name": "Returned on resource not found", "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 \"customer_id\": \"\",\n \"email_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-04bccf2a-51b1-4c97-87b1-c6504bc2cbe1" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-192e15e2-5e2f-4427-91a0-702484510e67" }, { "name": "delete Enterprise Portal Customer User", "id": "5eb625b2-8601-4959-990d-8f3c3d09b744", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user?EmailAddress=&customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "query": [ { "description": "The email address of the user to delete", "key": "EmailAddress", "value": "" }, { "description": "The customer ID which the user belongs to", "key": "customer_id", "value": "" } ], "variable": [ { "id": "8d8ca7c7-a9a3-4273-bf75-b3f49f483be4", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Delete a customer user for the enterprise portal" }, "response": [ { "id": "f22977d9-db61-4fb0-a75d-c048f5c6e84b", "name": "On success, no payload returned", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user?EmailAddress=&customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "query": [ { "description": "The email address of the user to delete", "key": "EmailAddress", "value": "" }, { "description": "The customer ID which the user belongs to", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-f22977d9-db61-4fb0-a75d-c048f5c6e84b" }, { "id": "a20a6f7e-c57d-4994-936f-a3ec0cc6b1e6", "name": "Returned on bad input", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user?EmailAddress=&customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "query": [ { "description": "The email address of the user to delete", "key": "EmailAddress", "value": "" }, { "description": "The customer ID which the user belongs to", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-a20a6f7e-c57d-4994-936f-a3ec0cc6b1e6" }, { "id": "8e28058d-c45e-4896-be93-59582d4a3258", "name": "Return if the caller is not authorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user?EmailAddress=&customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "query": [ { "description": "The email address of the user to delete", "key": "EmailAddress", "value": "" }, { "description": "The customer ID which the user belongs to", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-8e28058d-c45e-4896-be93-59582d4a3258" }, { "id": "627c25b7-a6ae-464b-a8bd-2bea84bbf10c", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user?EmailAddress=&customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "query": [ { "description": "The email address of the user to delete", "key": "EmailAddress", "value": "" }, { "description": "The customer ID which the user belongs to", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-627c25b7-a6ae-464b-a8bd-2bea84bbf10c" }, { "id": "3d483744-689f-4863-a778-0f7ded8a1ec7", "name": "Returned on resource not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-user?EmailAddress=&customer_id=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-user" ], "query": [ { "description": "The email address of the user to delete", "key": "EmailAddress", "value": "" }, { "description": "The customer ID which the user belongs to", "key": "customer_id", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-3d483744-689f-4863-a778-0f7ded8a1ec7" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-5eb625b2-8601-4959-990d-8f3c3d09b744" } ], "id": "2866b8c9-333e-48d3-a1f2-657e4736faad", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-2866b8c9-333e-48d3-a1f2-657e4736faad" }, { "name": "customer-users", "item": [ { "name": "List customer users for the enterprise portal", "id": "2b235789-710d-4db7-9bc2-61b12e0b529b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-users?ExcludeInvites=false&FilterCustomerID=&FilterEmail=&Limit=&Offset=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-users" ], "query": [ { "key": "ExcludeInvites", "value": "false" }, { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "key": "Limit", "value": "" }, { "key": "Offset", "value": "" }, { "key": "Sort", "value": "" }, { "key": "Order", "value": "" } ], "variable": [ { "id": "4664d1b9-8ba7-4bc4-9dfb-a0c45e7cfddc", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy:\nkots/app/[:appid]/enterprise-portal/customer-users/read\nkots/app/[:appid]/license/[:customer_id]/read" }, "response": [ { "id": "63e648bc-3acb-401c-96ce-d68ced69cd26", "name": "New 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}}/app/:app_id/enterprise-portal/customer-users?ExcludeInvites=false&FilterCustomerID=&FilterEmail=&Limit=&Offset=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-users" ], "query": [ { "key": "ExcludeInvites", "value": "false" }, { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "key": "Limit", "value": "" }, { "key": "Offset", "value": "" }, { "key": "Sort", "value": "" }, { "key": "Order", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total\": \"\",\n \"users\": [\n {\n \"appId\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"emailAddress\": \"\",\n \"firstAccessedAt\": \"\",\n \"id\": \"\",\n \"invitedAt\": \"\",\n \"lastAccessedAt\": \"\",\n \"pendingInvite\": \"\",\n \"role\": \"\",\n \"viewCount\": \"\"\n },\n {\n \"appId\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"emailAddress\": \"\",\n \"firstAccessedAt\": \"\",\n \"id\": \"\",\n \"invitedAt\": \"\",\n \"lastAccessedAt\": \"\",\n \"pendingInvite\": \"\",\n \"role\": \"\",\n \"viewCount\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-63e648bc-3acb-401c-96ce-d68ced69cd26" }, { "id": "41e56625-0d1e-449d-a034-4cfed01590fc", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-users?ExcludeInvites=false&FilterCustomerID=&FilterEmail=&Limit=&Offset=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-users" ], "query": [ { "key": "ExcludeInvites", "value": "false" }, { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "key": "Limit", "value": "" }, { "key": "Offset", "value": "" }, { "key": "Sort", "value": "" }, { "key": "Order", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-41e56625-0d1e-449d-a034-4cfed01590fc" }, { "id": "7a4b0061-fcb4-4102-9fba-013f81828f21", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-users?ExcludeInvites=false&FilterCustomerID=&FilterEmail=&Limit=&Offset=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-users" ], "query": [ { "key": "ExcludeInvites", "value": "false" }, { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "key": "Limit", "value": "" }, { "key": "Offset", "value": "" }, { "key": "Sort", "value": "" }, { "key": "Order", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-7a4b0061-fcb4-4102-9fba-013f81828f21" }, { "id": "6177dd2f-150e-4724-a70d-f446b31c4d2d", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-users?ExcludeInvites=false&FilterCustomerID=&FilterEmail=&Limit=&Offset=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-users" ], "query": [ { "key": "ExcludeInvites", "value": "false" }, { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "key": "Limit", "value": "" }, { "key": "Offset", "value": "" }, { "key": "Sort", "value": "" }, { "key": "Order", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-6177dd2f-150e-4724-a70d-f446b31c4d2d" }, { "id": "ee0b5e81-6693-4af4-9b1f-c6c5110d88f6", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/customer-users?ExcludeInvites=false&FilterCustomerID=&FilterEmail=&Limit=&Offset=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "customer-users" ], "query": [ { "key": "ExcludeInvites", "value": "false" }, { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "key": "Limit", "value": "" }, { "key": "Offset", "value": "" }, { "key": "Sort", "value": "" }, { "key": "Order", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ee0b5e81-6693-4af4-9b1f-c6c5110d88f6" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-2b235789-710d-4db7-9bc2-61b12e0b529b" } ], "id": "98893c1f-060a-4c79-b143-b4865137b482", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-98893c1f-060a-4c79-b143-b4865137b482" }, { "name": "documentation", "item": [ { "name": "Get documentation URLs for various installation methods", "id": "ec7d6299-b171-4e73-8ae2-089467d7873f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/documentation", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "documentation" ], "variable": [ { "id": "59fd98ec-a8bc-404c-8532-4ad42063cce3", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy: kots/app/[:appid]/enterprise-portal/documentation/read" }, "response": [ { "id": "70a362f7-ee51-4ce2-b72e-723b40e3b9a0", "name": "New 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}}/app/:app_id/enterprise-portal/documentation", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "documentation" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"documentation\": {\n \"embedded_cluster_install_url\": \"\",\n \"embedded_cluster_post_install\": \"\",\n \"embedded_cluster_pre_install\": \"\",\n \"helm_install_url\": \"\",\n \"helm_post_install\": \"\",\n \"helm_pre_install\": \"\",\n \"kots_install_url\": \"\",\n \"kurl_install_url\": \"\",\n \"values_override_url\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-70a362f7-ee51-4ce2-b72e-723b40e3b9a0" }, { "id": "e11e37c4-2a96-4c2b-a8df-b8fad16b9bce", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/documentation", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "documentation" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e11e37c4-2a96-4c2b-a8df-b8fad16b9bce" }, { "id": "f6c44b1a-4947-40ea-a0dc-a677335d15ef", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/documentation", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "documentation" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-f6c44b1a-4947-40ea-a0dc-a677335d15ef" }, { "id": "48c4265f-fd08-45ed-bdca-407e310c96af", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/documentation", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "documentation" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-48c4265f-fd08-45ed-bdca-407e310c96af" }, { "id": "49653998-8eed-490f-ab0f-6d718c5837ba", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/documentation", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "documentation" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-49653998-8eed-490f-ab0f-6d718c5837ba" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ec7d6299-b171-4e73-8ae2-089467d7873f" }, { "name": "Update documentation URLs", "id": "a1ce680d-7ff0-454b-9b5d-49430194c130", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"embeddedClusterInstallURL\": \"\",\n \"embeddedClusterPostInstall\": \"\",\n \"embeddedClusterPreInstall\": \"\",\n \"helmInstallURL\": \"\",\n \"helmPostInstall\": \"\",\n \"helmPreInstall\": \"\",\n \"kotsInstallURL\": \"\",\n \"kurlInstallURL\": \"\",\n \"valuesOverrideURL\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/documentation", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "documentation" ], "variable": [ { "id": "eb2fe02d-6857-47bd-b157-d0f44c768307", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Update documentation URLs and markdown content for various installation methods\n\nRequired RBAC Policy: kots/app/[:appid]/enterprise-portal/documentation/update" }, "response": [ { "id": "8cb0cb4d-5033-4447-86c9-bfc485f88b09", "name": "New Response", "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 \"embeddedClusterInstallURL\": \"\",\n \"embeddedClusterPostInstall\": \"\",\n \"embeddedClusterPreInstall\": \"\",\n \"helmInstallURL\": \"\",\n \"helmPostInstall\": \"\",\n \"helmPreInstall\": \"\",\n \"kotsInstallURL\": \"\",\n \"kurlInstallURL\": \"\",\n \"valuesOverrideURL\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/documentation", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "documentation" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-8cb0cb4d-5033-4447-86c9-bfc485f88b09" }, { "id": "dee9ec6d-c15a-440f-8b85-c40c81e447c7", "name": "Returned on bad input", "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 \"embeddedClusterInstallURL\": \"\",\n \"embeddedClusterPostInstall\": \"\",\n \"embeddedClusterPreInstall\": \"\",\n \"helmInstallURL\": \"\",\n \"helmPostInstall\": \"\",\n \"helmPreInstall\": \"\",\n \"kotsInstallURL\": \"\",\n \"kurlInstallURL\": \"\",\n \"valuesOverrideURL\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/documentation", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "documentation" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-dee9ec6d-c15a-440f-8b85-c40c81e447c7" }, { "id": "686b242f-8575-4c88-bb22-a1ae5e0d99b8", "name": "Return if the caller is not authorized", "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 \"embeddedClusterInstallURL\": \"\",\n \"embeddedClusterPostInstall\": \"\",\n \"embeddedClusterPreInstall\": \"\",\n \"helmInstallURL\": \"\",\n \"helmPostInstall\": \"\",\n \"helmPreInstall\": \"\",\n \"kotsInstallURL\": \"\",\n \"kurlInstallURL\": \"\",\n \"valuesOverrideURL\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/documentation", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "documentation" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-686b242f-8575-4c88-bb22-a1ae5e0d99b8" }, { "id": "6b3399b0-f326-4800-bf3f-0125263f2395", "name": "Returned if the caller does not have the needed permission", "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 \"embeddedClusterInstallURL\": \"\",\n \"embeddedClusterPostInstall\": \"\",\n \"embeddedClusterPreInstall\": \"\",\n \"helmInstallURL\": \"\",\n \"helmPostInstall\": \"\",\n \"helmPreInstall\": \"\",\n \"kotsInstallURL\": \"\",\n \"kurlInstallURL\": \"\",\n \"valuesOverrideURL\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/documentation", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "documentation" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-6b3399b0-f326-4800-bf3f-0125263f2395" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-a1ce680d-7ff0-454b-9b5d-49430194c130" } ], "id": "fc0a83ec-4496-4fb8-82e6-31f588680e3e", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-fc0a83ec-4496-4fb8-82e6-31f588680e3e" }, { "name": "email-history", "item": [ { "name": "List email history for the enterprise portal", "id": "65b9ec85-0c39-45e2-b98d-fa37dc8a45b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/email-history?EmailType=&Status=&CustomerID=&Limit=25&Offset=0", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "email-history" ], "query": [ { "description": "Filter by email type (login, invite, version_update)", "key": "EmailType", "value": "" }, { "description": "Filter by status (sent, delivered, bounced, spam_complaint)", "key": "Status", "value": "" }, { "description": "Filter by customer ID", "key": "CustomerID", "value": "" }, { "key": "Limit", "value": "25" }, { "key": "Offset", "value": "0" } ], "variable": [ { "id": "f40ed51b-fe86-499e-ab2b-7dc9b32e2d17", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Returns a paginated list of emails sent through the enterprise portal with their delivery status.\n\nRequired RBAC Policy:\nkots/app/{app_id}/enterprise-portal/email-history/read" }, "response": [ { "id": "395980a6-f517-46a3-9328-7722996b30d0", "name": "New 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}}/app/:app_id/enterprise-portal/email-history?EmailType=&Status=&CustomerID=&Limit=25&Offset=0", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "email-history" ], "query": [ { "description": "Filter by email type (login, invite, version_update)", "key": "EmailType", "value": "" }, { "description": "Filter by status (sent, delivered, bounced, spam_complaint)", "key": "Status", "value": "" }, { "description": "Filter by customer ID", "key": "CustomerID", "value": "" }, { "key": "Limit", "value": "25" }, { "key": "Offset", "value": "0" } ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"emails\": [\n {\n \"bounceType\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"emailType\": \"\",\n \"fromEmail\": \"\",\n \"latestEventAt\": \"\",\n \"latestStatus\": \"\",\n \"messageId\": \"\",\n \"sentAt\": \"\",\n \"subject\": \"\",\n \"templateName\": \"\",\n \"toEmail\": \"\"\n },\n {\n \"bounceType\": \"\",\n \"customerId\": \"\",\n \"customerName\": \"\",\n \"emailType\": \"\",\n \"fromEmail\": \"\",\n \"latestEventAt\": \"\",\n \"latestStatus\": \"\",\n \"messageId\": \"\",\n \"sentAt\": \"\",\n \"subject\": \"\",\n \"templateName\": \"\",\n \"toEmail\": \"\"\n }\n ],\n \"total\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-395980a6-f517-46a3-9328-7722996b30d0" }, { "id": "723c80f4-0522-4624-ab07-8fc3a7ddd653", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/email-history?EmailType=&Status=&CustomerID=&Limit=25&Offset=0", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "email-history" ], "query": [ { "description": "Filter by email type (login, invite, version_update)", "key": "EmailType", "value": "" }, { "description": "Filter by status (sent, delivered, bounced, spam_complaint)", "key": "Status", "value": "" }, { "description": "Filter by customer ID", "key": "CustomerID", "value": "" }, { "key": "Limit", "value": "25" }, { "key": "Offset", "value": "0" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-723c80f4-0522-4624-ab07-8fc3a7ddd653" }, { "id": "22a077b1-7854-45fa-aa25-5454da5d7908", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/email-history?EmailType=&Status=&CustomerID=&Limit=25&Offset=0", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "email-history" ], "query": [ { "description": "Filter by email type (login, invite, version_update)", "key": "EmailType", "value": "" }, { "description": "Filter by status (sent, delivered, bounced, spam_complaint)", "key": "Status", "value": "" }, { "description": "Filter by customer ID", "key": "CustomerID", "value": "" }, { "key": "Limit", "value": "25" }, { "key": "Offset", "value": "0" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-22a077b1-7854-45fa-aa25-5454da5d7908" }, { "id": "9277ab1b-109b-4dc3-bd03-a4f360de72c5", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/email-history?EmailType=&Status=&CustomerID=&Limit=25&Offset=0", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "email-history" ], "query": [ { "description": "Filter by email type (login, invite, version_update)", "key": "EmailType", "value": "" }, { "description": "Filter by status (sent, delivered, bounced, spam_complaint)", "key": "Status", "value": "" }, { "description": "Filter by customer ID", "key": "CustomerID", "value": "" }, { "key": "Limit", "value": "25" }, { "key": "Offset", "value": "0" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9277ab1b-109b-4dc3-bd03-a4f360de72c5" }, { "id": "27d274c9-835a-495d-835f-09866ea51e03", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/email-history?EmailType=&Status=&CustomerID=&Limit=25&Offset=0", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "email-history" ], "query": [ { "description": "Filter by email type (login, invite, version_update)", "key": "EmailType", "value": "" }, { "description": "Filter by status (sent, delivered, bounced, spam_complaint)", "key": "Status", "value": "" }, { "description": "Filter by customer ID", "key": "CustomerID", "value": "" }, { "key": "Limit", "value": "25" }, { "key": "Offset", "value": "0" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-27d274c9-835a-495d-835f-09866ea51e03" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-65b9ec85-0c39-45e2-b98d-fa37dc8a45b8" } ], "id": "bc26ceb1-6b86-40ea-abf0-9f4857aa28e5", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-bc26ceb1-6b86-40ea-abf0-9f4857aa28e5" }, { "name": "failed-login-attempts", "item": [ { "name": "List failed login attempts", "id": "fea2019c-cee3-4e77-93e5-ebdcf5c27680", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/failed-login-attempts?Limit=&Offset=&FilterEmail=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "failed-login-attempts" ], "query": [ { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" } ], "variable": [ { "id": "067d54dc-682a-444b-a772-05074cd79879", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "List failed login attempts for the enterprise portal users.\n\n\nRequired RBAC Policy: kots/app/[:appid]/enterprise-portal/failed-login-attempts/read" }, "response": [ { "id": "23f83f9b-fb95-49b1-b68c-153ae0de265a", "name": "New 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}}/app/:app_id/enterprise-portal/failed-login-attempts?Limit=&Offset=&FilterEmail=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "failed-login-attempts" ], "query": [ { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"attempts\": [\n {\n \"app_id\": \"\",\n \"created_at\": \"\",\n \"email_address\": \"\",\n \"id\": \"\",\n \"ip_address\": \"\",\n \"login_url\": \"\",\n \"team_id\": \"\"\n },\n {\n \"app_id\": \"\",\n \"created_at\": \"\",\n \"email_address\": \"\",\n \"id\": \"\",\n \"ip_address\": \"\",\n \"login_url\": \"\",\n \"team_id\": \"\"\n }\n ],\n \"total\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-23f83f9b-fb95-49b1-b68c-153ae0de265a" }, { "id": "7230a16c-8892-488a-badc-d909c08a8f0e", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/failed-login-attempts?Limit=&Offset=&FilterEmail=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "failed-login-attempts" ], "query": [ { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-7230a16c-8892-488a-badc-d909c08a8f0e" }, { "id": "6528426c-42db-4f5e-93cf-34247cbc1ff2", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/failed-login-attempts?Limit=&Offset=&FilterEmail=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "failed-login-attempts" ], "query": [ { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-6528426c-42db-4f5e-93cf-34247cbc1ff2" }, { "id": "ad2e1a4b-a028-46f3-a783-ecc5df0e1ac7", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/failed-login-attempts?Limit=&Offset=&FilterEmail=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "failed-login-attempts" ], "query": [ { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ad2e1a4b-a028-46f3-a783-ecc5df0e1ac7" }, { "id": "51e5071f-0141-4dc9-9541-f925c7cba418", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/failed-login-attempts?Limit=&Offset=&FilterEmail=&Sort=&Order=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "failed-login-attempts" ], "query": [ { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by email address", "key": "FilterEmail", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-51e5071f-0141-4dc9-9541-f925c7cba418" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-fea2019c-cee3-4e77-93e5-ebdcf5c27680" } ], "id": "c74266ea-f8bf-4796-9c0b-092b0a837ac3", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-c74266ea-f8bf-4796-9c0b-092b0a837ac3" }, { "name": "features", "item": [ { "name": "Get Enterprise Portal feature settings for an app", "id": "ce8a53a0-9750-4739-9d10-cd049a5c6616", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/features", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "features" ], "variable": [ { "id": "10409964-7b52-42f5-a451-a3290b3be5d6", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy: kots/app/[:appid]/read" }, "response": [ { "id": "8a18c772-fe19-41fc-af4f-4dd89d382ba2", "name": "PortalFeaturesResponse holds the current state of all portal feature toggles for an app.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/features", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "features" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"askAiEnabled\": \"\",\n \"supportBundleUploadEnabled\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-8a18c772-fe19-41fc-af4f-4dd89d382ba2" }, { "id": "bb813aa4-8f2a-4cb4-b012-a48676c23f52", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/features", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "features" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-bb813aa4-8f2a-4cb4-b012-a48676c23f52" }, { "id": "3d794f4b-1137-4015-a03d-c7010891f159", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/features", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "features" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-3d794f4b-1137-4015-a03d-c7010891f159" }, { "id": "12d2c21e-a64f-4b06-9adf-7d4d72fd27ab", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/features", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "features" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-12d2c21e-a64f-4b06-9adf-7d4d72fd27ab" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ce8a53a0-9750-4739-9d10-cd049a5c6616" }, { "name": "Update Enterprise Portal feature settings for an app", "id": "4c94ef66-750c-4e9d-a061-8e85d40f3646", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"askAiEnabled\": \"\",\n \"supportBundleUploadEnabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/features", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "features" ], "variable": [ { "id": "252aa9bc-9d57-4a39-9aaf-ff8e75af67a1", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy: kots/app/[:appid]/update" }, "response": [ { "id": "fe6504b6-d25f-4ae6-96d8-6470ecc79428", "name": "PortalFeaturesResponse holds the current state of all portal feature toggles for an app.", "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 \"askAiEnabled\": \"\",\n \"supportBundleUploadEnabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/features", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "features" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"askAiEnabled\": \"\",\n \"supportBundleUploadEnabled\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-fe6504b6-d25f-4ae6-96d8-6470ecc79428" }, { "id": "224be38f-876c-4d5f-b790-8b202cbcab29", "name": "Returned on bad input", "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 \"askAiEnabled\": \"\",\n \"supportBundleUploadEnabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/features", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "features" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-224be38f-876c-4d5f-b790-8b202cbcab29" }, { "id": "4464a2be-ca24-4c8b-94fa-aae62377875c", "name": "Return if the caller is not authorized", "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 \"askAiEnabled\": \"\",\n \"supportBundleUploadEnabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/features", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "features" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-4464a2be-ca24-4c8b-94fa-aae62377875c" }, { "id": "b9338938-b834-4080-8e97-b7d77715be66", "name": "Returned if the caller does not have the needed permission", "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 \"askAiEnabled\": \"\",\n \"supportBundleUploadEnabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/features", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "features" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-b9338938-b834-4080-8e97-b7d77715be66" }, { "id": "6d5d2ad8-bc51-4ec8-a6b6-54e8a0786591", "name": "Returned on resource not found", "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 \"askAiEnabled\": \"\",\n \"supportBundleUploadEnabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/features", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "features" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-6d5d2ad8-bc51-4ec8-a6b6-54e8a0786591" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-4c94ef66-750c-4e9d-a061-8e85d40f3646" } ], "id": "2f3644f5-d9df-40af-b18f-d6383198c340", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-2f3644f5-d9df-40af-b18f-d6383198c340" }, { "name": "install-attempts", "item": [ { "name": "List installation attempts for the enterprise portal", "id": "a8e9e657-c9e0-4bf4-8709-73705633ef5d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-attempts?FilterCustomerID=&FilterInstanceID=&Limit=&Offset=&FilterStatus=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-attempts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by a specific instance ID", "key": "FilterInstanceID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by status", "key": "FilterStatus", "value": "" } ], "variable": [ { "id": "26f684b2-9f7a-4f8d-a088-3dde33a579a4", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "List install attempts for a customer or all customers in the app." }, "response": [ { "id": "94da0763-5d67-4bc7-98e9-d8983104c74b", "name": "New 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}}/app/:app_id/enterprise-portal/install-attempts?FilterCustomerID=&FilterInstanceID=&Limit=&Offset=&FilterStatus=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-attempts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by a specific instance ID", "key": "FilterInstanceID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by status", "key": "FilterStatus", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"install_attempts\": [\n {\n \"admin_console_url\": \"\",\n \"assets_downloaded_at\": \"\",\n \"browser_install_completed_at\": \"\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"customer_email\": \"\",\n \"customer_id\": \"\",\n \"ec_version\": \"\",\n \"id\": \"\",\n \"images_pulled_at\": \"\",\n \"install_type\": \"\",\n \"installation_completed_at\": \"\",\n \"instance_id\": \"\",\n \"instance_name\": \"\",\n \"is_multi_node\": \"\",\n \"kubernetes_distribution\": \"\",\n \"license_id\": \"\",\n \"network_availability\": \"\",\n \"os_distro\": \"\",\n \"os_version\": \"\",\n \"registry_authenticated_at\": \"\",\n \"registry_availability\": \"\",\n \"release_sequence\": \"\",\n \"service_account_email_address\": \"\",\n \"service_account_id\": \"\",\n \"service_account_token\": \"\",\n \"started_at\": \"\",\n \"status\": \"stalled\",\n \"version\": \"\",\n \"version_label\": \"\"\n },\n {\n \"admin_console_url\": \"\",\n \"assets_downloaded_at\": \"\",\n \"browser_install_completed_at\": \"\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"customer_email\": \"\",\n \"customer_id\": \"\",\n \"ec_version\": \"\",\n \"id\": \"\",\n \"images_pulled_at\": \"\",\n \"install_type\": \"\",\n \"installation_completed_at\": \"\",\n \"instance_id\": \"\",\n \"instance_name\": \"\",\n \"is_multi_node\": \"\",\n \"kubernetes_distribution\": \"\",\n \"license_id\": \"\",\n \"network_availability\": \"\",\n \"os_distro\": \"\",\n \"os_version\": \"\",\n \"registry_authenticated_at\": \"\",\n \"registry_availability\": \"\",\n \"release_sequence\": \"\",\n \"service_account_email_address\": \"\",\n \"service_account_id\": \"\",\n \"service_account_token\": \"\",\n \"started_at\": \"\",\n \"status\": \"succeeded\",\n \"version\": \"\",\n \"version_label\": \"\"\n }\n ],\n \"total\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-94da0763-5d67-4bc7-98e9-d8983104c74b" }, { "id": "da045172-a3ff-40b8-821b-b2eb1ac07da1", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-attempts?FilterCustomerID=&FilterInstanceID=&Limit=&Offset=&FilterStatus=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-attempts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by a specific instance ID", "key": "FilterInstanceID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by status", "key": "FilterStatus", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-da045172-a3ff-40b8-821b-b2eb1ac07da1" }, { "id": "8c34ff33-9a64-4bc5-b696-9795d3e2b45e", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-attempts?FilterCustomerID=&FilterInstanceID=&Limit=&Offset=&FilterStatus=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-attempts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by a specific instance ID", "key": "FilterInstanceID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by status", "key": "FilterStatus", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-8c34ff33-9a64-4bc5-b696-9795d3e2b45e" }, { "id": "9a5047ed-ff88-4aff-9d51-d669b21e6bb7", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-attempts?FilterCustomerID=&FilterInstanceID=&Limit=&Offset=&FilterStatus=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-attempts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by a specific instance ID", "key": "FilterInstanceID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by status", "key": "FilterStatus", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9a5047ed-ff88-4aff-9d51-d669b21e6bb7" }, { "id": "79de4754-ec38-4596-bb9b-d998cc63cbd0", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-attempts?FilterCustomerID=&FilterInstanceID=&Limit=&Offset=&FilterStatus=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-attempts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Filter by a specific instance ID", "key": "FilterInstanceID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Filter by status", "key": "FilterStatus", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-79de4754-ec38-4596-bb9b-d998cc63cbd0" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-a8e9e657-c9e0-4bf4-8709-73705633ef5d" } ], "id": "1f5c8c1e-158c-42ed-9288-6a0f786f1d68", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-1f5c8c1e-158c-42ed-9288-6a0f786f1d68" }, { "name": "install-options", "item": [ { "name": "{install_options_id}", "item": [ { "name": "Delete an installation options record", "id": "ca4b011a-5eb5-477e-a039-59f6f06bdbe7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "variable": [ { "id": "56f549b3-179f-43ce-95ff-fa48608f6efb", "key": "app_id", "value": "", "description": "(Required) App identifier" }, { "id": "d4db0336-df25-40e7-9f06-4cdd66958612", "key": "install_options_id", "value": "", "description": "(Required) Install options ID from path" } ] }, "description": "Soft-delete an existing installation options record for a customer by setting its status to \"discarded\".\nThe record is preserved for audit purposes. The associated service account is not revoked. The service account\nmust be revoked before the instance name can be reused with a new install option record for the same customer." }, "response": [ { "id": "c42b009d-307f-419f-82c2-abe8c56bc6e7", "name": "On success, no payload returned", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "variable": [ { "key": "app_id" }, { "key": "install_options_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-c42b009d-307f-419f-82c2-abe8c56bc6e7" }, { "id": "d793ecd8-e77b-4012-a50a-93e7b0a1e52a", "name": "Returned on bad input", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "variable": [ { "key": "app_id" }, { "key": "install_options_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-d793ecd8-e77b-4012-a50a-93e7b0a1e52a" }, { "id": "e32af147-8cce-449e-a0bb-fec5a3f38da2", "name": "Return if the caller is not authorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "variable": [ { "key": "app_id" }, { "key": "install_options_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e32af147-8cce-449e-a0bb-fec5a3f38da2" }, { "id": "49112520-849f-4e56-838a-c71aadb6b54c", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "variable": [ { "key": "app_id" }, { "key": "install_options_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-49112520-849f-4e56-838a-c71aadb6b54c" }, { "id": "da3b4e55-ecbd-45d8-abb2-0f775f1c77b3", "name": "Returned on resource not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "variable": [ { "key": "app_id" }, { "key": "install_options_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-da3b4e55-ecbd-45d8-abb2-0f775f1c77b3" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ca4b011a-5eb5-477e-a039-59f6f06bdbe7" }, { "name": "Update an installation options record", "id": "2e820b5e-4ac6-4978-ac06-ec6dd0d61a79", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"admin_console_url\": \"\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"instance_name\": \"\",\n \"kubernetes_distribution\": \"aks\",\n \"network_availability\": \"proxy\",\n \"registry_availability\": \"partial\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "id": "6e4bbb07-9214-482c-a78d-18fac2013b0c", "key": "app_id", "value": "", "description": "(Required) App identifier" }, { "id": "83604de7-e5fe-4608-b3a4-49e62e80c8fb", "key": "install_options_id", "value": "", "description": "(Required) Install options ID from path" } ] }, "description": "Update an existing installation options record for a customer. Only provided fields will be updated.\nYou cannot change the service account ID, instance name, or install type as these are immutable.\n\nOptionally return updated install instructions by setting the includeInstructions query parameter to true." }, "response": [ { "id": "4a182ea0-98fb-457f-ade0-eeb9ee1c63a4", "name": "PatchInstallOptionsResponse contains the response from patching install options.", "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 \"admin_console_url\": \"\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"instance_name\": \"\",\n \"kubernetes_distribution\": \"aks\",\n \"network_availability\": \"proxy\",\n \"registry_availability\": \"partial\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "install_options_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"install_options\": {\n \"admin_console_url\": \"\",\n \"assets_downloaded_at\": \"\",\n \"browser_install_completed_at\": \"\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"customer_email\": \"\",\n \"customer_id\": \"\",\n \"id\": \"\",\n \"images_pulled_at\": \"\",\n \"install_type\": \"\",\n \"installation_completed_at\": \"\",\n \"instance_id\": \"\",\n \"instance_name\": \"\",\n \"is_multi_node\": \"\",\n \"kubernetes_distribution\": \"\",\n \"license_id\": \"\",\n \"network_availability\": \"\",\n \"os_distro\": \"\",\n \"os_version\": \"\",\n \"registry_authenticated_at\": \"\",\n \"registry_availability\": \"\",\n \"service_account_id\": \"\",\n \"service_account_token\": \"\",\n \"started_at\": \"\",\n \"status\": \"\",\n \"version\": \"\"\n },\n \"instructions\": {\n \"context\": {\n \"description\": \"MDX context with all template variables\",\n \"x-go-name\": \"Context\"\n },\n \"format\": \"\",\n \"install_type\": \"\",\n \"mdx_template\": \"\",\n \"renderer_version\": \"\",\n \"steps\": [\n {\n \"commands\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"download_url\": \"\",\n \"downloads\": [\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"ipsum_0d\": \"\",\n \"ex_c\": \"\",\n \"aliquip_8e\": \"\"\n }\n },\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"dolorac\": \"\"\n }\n }\n ],\n \"step_name\": \"\",\n \"step_number\": \"\",\n \"title\": \"\"\n },\n {\n \"commands\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"download_url\": \"\",\n \"downloads\": [\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"in_f_\": \"\",\n \"laborum_7\": \"\"\n }\n },\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"ex6\": \"\"\n }\n }\n ],\n \"step_name\": \"\",\n \"step_number\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"\"\n },\n \"service_account\": {\n \"accountName\": \"\",\n \"createdAt\": \"\",\n \"customerId\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"isRevoked\": \"\",\n \"lastUsedAt\": \"\",\n \"token\": \"\",\n \"tokenRegeneratedAt\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-4a182ea0-98fb-457f-ade0-eeb9ee1c63a4" }, { "id": "1d85a087-a619-4642-89db-d93c3905681e", "name": "Returned on bad input", "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 \"admin_console_url\": \"\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"instance_name\": \"\",\n \"kubernetes_distribution\": \"aks\",\n \"network_availability\": \"proxy\",\n \"registry_availability\": \"partial\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "install_options_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-1d85a087-a619-4642-89db-d93c3905681e" }, { "id": "31319b61-318f-4deb-936b-58e62111d45a", "name": "Return if the caller is not authorized", "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 \"admin_console_url\": \"\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"instance_name\": \"\",\n \"kubernetes_distribution\": \"aks\",\n \"network_availability\": \"proxy\",\n \"registry_availability\": \"partial\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "install_options_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-31319b61-318f-4deb-936b-58e62111d45a" }, { "id": "989eb912-e18e-4032-8b16-18ad404b2c6e", "name": "Returned if the caller does not have the needed permission", "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 \"admin_console_url\": \"\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"instance_name\": \"\",\n \"kubernetes_distribution\": \"aks\",\n \"network_availability\": \"proxy\",\n \"registry_availability\": \"partial\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "install_options_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-989eb912-e18e-4032-8b16-18ad404b2c6e" }, { "id": "9969cacd-423e-4bfc-8e65-48bebdaaa619", "name": "Returned on resource not found", "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 \"admin_console_url\": \"\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"instance_name\": \"\",\n \"kubernetes_distribution\": \"aks\",\n \"network_availability\": \"proxy\",\n \"registry_availability\": \"partial\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:install_options_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":install_options_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "install_options_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9969cacd-423e-4bfc-8e65-48bebdaaa619" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-2e820b5e-4ac6-4978-ac06-ec6dd0d61a79" } ], "id": "df9f6a66-fe4d-4e8b-9d6a-1ee30d45329e", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-df9f6a66-fe4d-4e8b-9d6a-1ee30d45329e" }, { "name": "{option_id}", "item": [ { "name": "update-instructions", "item": [ { "name": "Get update instructions", "id": "8432a67a-0513-4534-9aa6-137b62028d16", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id/update-instructions?instance_id=&cluster_id=&targetChannelId=&targetChannelSequence=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id", "update-instructions" ], "query": [ { "description": "The instance ID for a legacy/airgap instance (used when option_id is \"placeholder\")", "key": "instance_id", "value": "" }, { "description": "Optional cluster ID used to disambiguate a kots_license_instance row when\nthe same instance_id exists across multiple clusters.", "key": "cluster_id", "value": "" }, { "description": "(Required) Target channel ID for the update", "key": "targetChannelId", "value": "" }, { "description": "(Required) Target channel sequence for the update", "key": "targetChannelSequence", "value": "" } ], "variable": [ { "id": "84832424-5232-4133-92a2-3ed58d9e5e6c", "key": "app_id", "value": "", "description": "(Required) App identifier" }, { "id": "02181b06-4df7-42ec-9753-39ce1af7116f", "key": "option_id", "value": "", "description": "(Required) The ID for a customer install options record" } ] }, "description": "Generates step-by-step instructions for updating an installation to a specific target version.\nSupports both Helm and Linux (Embedded Cluster) installation types. The update instructions\nwill use upgrade/update commands instead of install commands, and are tailored to the\nnetwork and registry availability configuration from the original install options." }, "response": [ { "id": "2db56c00-eeea-482e-b49c-a22e62cb4ea5", "name": "GetUpdateInstructionsResponse contains the response from getting update instructions.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id/update-instructions?instance_id=&cluster_id=&targetChannelId=&targetChannelSequence=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id", "update-instructions" ], "query": [ { "description": "The instance ID for a legacy/airgap instance (used when option_id is \"placeholder\")", "key": "instance_id", "value": "" }, { "description": "Optional cluster ID used to disambiguate a kots_license_instance row when\nthe same instance_id exists across multiple clusters.", "key": "cluster_id", "value": "" }, { "description": "(Required) Target channel ID for the update", "key": "targetChannelId", "value": "" }, { "description": "(Required) Target channel sequence for the update", "key": "targetChannelSequence", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "option_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"context\": {\n \"description\": \"MDX context with all template variables\",\n \"x-go-name\": \"Context\"\n },\n \"format\": \"\",\n \"install_type\": \"\",\n \"mdx_template\": \"\",\n \"renderer_version\": \"\",\n \"steps\": [\n {\n \"commands\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"download_url\": \"\",\n \"downloads\": [\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"culpa400\": \"\",\n \"inb_\": \"\",\n \"in_3\": \"\"\n }\n },\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"voluptate_90f\": \"\",\n \"enima\": \"\"\n }\n }\n ],\n \"step_name\": \"\",\n \"step_number\": \"\",\n \"title\": \"\"\n },\n {\n \"commands\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"download_url\": \"\",\n \"downloads\": [\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"labore__96\": \"\"\n }\n },\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"dolor9b4\": \"\"\n }\n }\n ],\n \"step_name\": \"\",\n \"step_number\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-2db56c00-eeea-482e-b49c-a22e62cb4ea5" }, { "id": "bb75f695-ce6c-438d-9bf6-960857ba1d11", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id/update-instructions?instance_id=&cluster_id=&targetChannelId=&targetChannelSequence=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id", "update-instructions" ], "query": [ { "description": "The instance ID for a legacy/airgap instance (used when option_id is \"placeholder\")", "key": "instance_id", "value": "" }, { "description": "Optional cluster ID used to disambiguate a kots_license_instance row when\nthe same instance_id exists across multiple clusters.", "key": "cluster_id", "value": "" }, { "description": "(Required) Target channel ID for the update", "key": "targetChannelId", "value": "" }, { "description": "(Required) Target channel sequence for the update", "key": "targetChannelSequence", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "option_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-bb75f695-ce6c-438d-9bf6-960857ba1d11" }, { "id": "158939aa-1c42-435d-b646-36f35527adc2", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id/update-instructions?instance_id=&cluster_id=&targetChannelId=&targetChannelSequence=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id", "update-instructions" ], "query": [ { "description": "The instance ID for a legacy/airgap instance (used when option_id is \"placeholder\")", "key": "instance_id", "value": "" }, { "description": "Optional cluster ID used to disambiguate a kots_license_instance row when\nthe same instance_id exists across multiple clusters.", "key": "cluster_id", "value": "" }, { "description": "(Required) Target channel ID for the update", "key": "targetChannelId", "value": "" }, { "description": "(Required) Target channel sequence for the update", "key": "targetChannelSequence", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "option_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-158939aa-1c42-435d-b646-36f35527adc2" }, { "id": "8ae4436a-deca-4641-a511-0252aa99c319", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id/update-instructions?instance_id=&cluster_id=&targetChannelId=&targetChannelSequence=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id", "update-instructions" ], "query": [ { "description": "The instance ID for a legacy/airgap instance (used when option_id is \"placeholder\")", "key": "instance_id", "value": "" }, { "description": "Optional cluster ID used to disambiguate a kots_license_instance row when\nthe same instance_id exists across multiple clusters.", "key": "cluster_id", "value": "" }, { "description": "(Required) Target channel ID for the update", "key": "targetChannelId", "value": "" }, { "description": "(Required) Target channel sequence for the update", "key": "targetChannelSequence", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "option_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-8ae4436a-deca-4641-a511-0252aa99c319" }, { "id": "7ac7c7e2-15a6-4441-8d9a-b31d69a2ea0f", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id/update-instructions?instance_id=&cluster_id=&targetChannelId=&targetChannelSequence=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id", "update-instructions" ], "query": [ { "description": "The instance ID for a legacy/airgap instance (used when option_id is \"placeholder\")", "key": "instance_id", "value": "" }, { "description": "Optional cluster ID used to disambiguate a kots_license_instance row when\nthe same instance_id exists across multiple clusters.", "key": "cluster_id", "value": "" }, { "description": "(Required) Target channel ID for the update", "key": "targetChannelId", "value": "" }, { "description": "(Required) Target channel sequence for the update", "key": "targetChannelSequence", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "option_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-7ac7c7e2-15a6-4441-8d9a-b31d69a2ea0f" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-8432a67a-0513-4534-9aa6-137b62028d16" } ], "id": "f4b07ba2-a4ac-433f-8074-0caebc90cb06", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-f4b07ba2-a4ac-433f-8074-0caebc90cb06" }, { "name": "Get an install options record", "id": "b219b71b-b6ca-4e32-adf4-3bf0f9450f74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "id": "7b4d0d89-7881-46ad-9959-391f98b4c344", "key": "app_id", "value": "", "description": "(Required) App identifier" }, { "id": "44381737-e9cf-4044-9ab2-76f0139c788f", "key": "option_id", "value": "", "description": "(Required) The ID for a customer install options record (returned from create install options)" } ] }, "description": "Retrieve the installation options that describe the installation configured for a customers install via the Enterprise Portal or API.\nOptionally include generated install instructions by setting the includeInstructions query parameter to true." }, "response": [ { "id": "5d833266-7737-4d33-a7e9-0480b6f7200f", "name": "GetInstallOptionsResponse contains the response from getting install options.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "option_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"admin_console_url\": \"\",\n \"assets_downloaded_at\": \"\",\n \"browser_install_completed_at\": \"\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"customer_email\": \"\",\n \"customer_id\": \"\",\n \"id\": \"\",\n \"images_pulled_at\": \"\",\n \"install_type\": \"\",\n \"installation_completed_at\": \"\",\n \"instance_id\": \"\",\n \"instance_name\": \"\",\n \"instructions\": {\n \"context\": {\n \"description\": \"MDX context with all template variables\",\n \"x-go-name\": \"Context\"\n },\n \"format\": \"\",\n \"install_type\": \"\",\n \"mdx_template\": \"\",\n \"renderer_version\": \"\",\n \"steps\": [\n {\n \"commands\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"download_url\": \"\",\n \"downloads\": [\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"magna_b\": \"\"\n }\n },\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"consequat2b\": \"\"\n }\n }\n ],\n \"step_name\": \"\",\n \"step_number\": \"\",\n \"title\": \"\"\n },\n {\n \"commands\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"download_url\": \"\",\n \"downloads\": [\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"consequat__ca\": \"\",\n \"commodo_296\": \"\",\n \"fugiatf_\": \"\",\n \"nisi74\": \"\"\n }\n },\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"amet_9c\": \"\",\n \"Lorem_5\": \"\"\n }\n }\n ],\n \"step_name\": \"\",\n \"step_number\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"\"\n },\n \"is_multi_node\": \"\",\n \"kubernetes_distribution\": \"\",\n \"license_id\": \"\",\n \"network_availability\": \"\",\n \"os_distro\": \"\",\n \"os_version\": \"\",\n \"registry_authenticated_at\": \"\",\n \"registry_availability\": \"\",\n \"service_account_id\": \"\",\n \"service_account_token\": \"\",\n \"started_at\": \"\",\n \"status\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-5d833266-7737-4d33-a7e9-0480b6f7200f" }, { "id": "68b201ee-f461-4ac9-86c3-b641365e231d", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "option_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-68b201ee-f461-4ac9-86c3-b641365e231d" }, { "id": "963ac7f4-d9cd-442f-a75d-2bc70a86e59f", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "option_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-963ac7f4-d9cd-442f-a75d-2bc70a86e59f" }, { "id": "77eb7236-ef2a-4f2b-8c4f-340109543561", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "option_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-77eb7236-ef2a-4f2b-8c4f-340109543561" }, { "id": "7a55a542-b2d7-4f45-b1c7-67b0a4ae1b8e", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options/:option_id?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options", ":option_id" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" }, { "key": "option_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-7a55a542-b2d7-4f45-b1c7-67b0a4ae1b8e" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-b219b71b-b6ca-4e32-adf4-3bf0f9450f74" } ], "id": "ed16613e-0066-4c7f-8cea-7dff8bf05374", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ed16613e-0066-4c7f-8cea-7dff8bf05374" }, { "name": "Create an installation options record", "id": "9d840909-b632-43eb-8454-e31c374cefea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\",\n \"install_type\": \"helm\",\n \"instance_name\": \"\",\n \"network_availability\": \"airgap\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"admin_console_url\": \"\",\n \"is_multi_node\": \"\",\n \"kubernetes_distribution\": \"rancher\",\n \"registry_availability\": \"online\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "id": "b4fe26e6-ee39-4b04-ab4b-20119fedb81d", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Create an installation options record for a customer describing the installation configuration. Automatically creating\na service account for the installation that can be used to perform the actual installation.\nOptionally include generated install instructions by setting the includeInstructions query parameter to true." }, "response": [ { "id": "2e0f381f-2629-43bf-b12d-6485838d9b14", "name": "CreateInstallOptionsResponse contains the response from creating install options.", "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 \"customer_id\": \"\",\n \"install_type\": \"helm\",\n \"instance_name\": \"\",\n \"network_availability\": \"airgap\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"admin_console_url\": \"\",\n \"is_multi_node\": \"\",\n \"kubernetes_distribution\": \"rancher\",\n \"registry_availability\": \"online\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"install_options\": {\n \"admin_console_url\": \"\",\n \"assets_downloaded_at\": \"\",\n \"browser_install_completed_at\": \"\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"customer_email\": \"\",\n \"customer_id\": \"\",\n \"id\": \"\",\n \"images_pulled_at\": \"\",\n \"install_type\": \"\",\n \"installation_completed_at\": \"\",\n \"instance_id\": \"\",\n \"instance_name\": \"\",\n \"is_multi_node\": \"\",\n \"kubernetes_distribution\": \"\",\n \"license_id\": \"\",\n \"network_availability\": \"\",\n \"os_distro\": \"\",\n \"os_version\": \"\",\n \"registry_authenticated_at\": \"\",\n \"registry_availability\": \"\",\n \"service_account_id\": \"\",\n \"service_account_token\": \"\",\n \"started_at\": \"\",\n \"status\": \"\",\n \"version\": \"\"\n },\n \"instructions\": {\n \"context\": {\n \"description\": \"MDX context with all template variables\",\n \"x-go-name\": \"Context\"\n },\n \"format\": \"\",\n \"install_type\": \"\",\n \"mdx_template\": \"\",\n \"renderer_version\": \"\",\n \"steps\": [\n {\n \"commands\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"download_url\": \"\",\n \"downloads\": [\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"ipsum_0d\": \"\",\n \"ex_c\": \"\",\n \"aliquip_8e\": \"\"\n }\n },\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"dolorac\": \"\"\n }\n }\n ],\n \"step_name\": \"\",\n \"step_number\": \"\",\n \"title\": \"\"\n },\n {\n \"commands\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"download_url\": \"\",\n \"downloads\": [\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"in_f_\": \"\",\n \"laborum_7\": \"\"\n }\n },\n {\n \"filename\": \"\",\n \"href\": \"\",\n \"id\": \"\",\n \"kind\": \"\",\n \"label\": \"\",\n \"metadata\": {\n \"ex6\": \"\"\n }\n }\n ],\n \"step_name\": \"\",\n \"step_number\": \"\",\n \"title\": \"\"\n }\n ],\n \"title\": \"\"\n },\n \"service_account\": {\n \"accountName\": \"\",\n \"createdAt\": \"\",\n \"customerId\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"isRevoked\": \"\",\n \"lastUsedAt\": \"\",\n \"token\": \"\",\n \"tokenRegeneratedAt\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-2e0f381f-2629-43bf-b12d-6485838d9b14" }, { "id": "13eb759b-a021-4d24-98b6-07579ec5b9e8", "name": "Returned on bad input", "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 \"customer_id\": \"\",\n \"install_type\": \"helm\",\n \"instance_name\": \"\",\n \"network_availability\": \"airgap\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"admin_console_url\": \"\",\n \"is_multi_node\": \"\",\n \"kubernetes_distribution\": \"rancher\",\n \"registry_availability\": \"online\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-13eb759b-a021-4d24-98b6-07579ec5b9e8" }, { "id": "e16a9dbf-d6b3-438f-9ff6-dc147c39e4e4", "name": "Return if the caller is not authorized", "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 \"customer_id\": \"\",\n \"install_type\": \"helm\",\n \"instance_name\": \"\",\n \"network_availability\": \"airgap\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"admin_console_url\": \"\",\n \"is_multi_node\": \"\",\n \"kubernetes_distribution\": \"rancher\",\n \"registry_availability\": \"online\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e16a9dbf-d6b3-438f-9ff6-dc147c39e4e4" }, { "id": "57c2c4d5-1bb9-4a00-8cc8-75201de6fabb", "name": "Returned if the caller does not have the needed permission", "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 \"customer_id\": \"\",\n \"install_type\": \"helm\",\n \"instance_name\": \"\",\n \"network_availability\": \"airgap\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"admin_console_url\": \"\",\n \"is_multi_node\": \"\",\n \"kubernetes_distribution\": \"rancher\",\n \"registry_availability\": \"online\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-57c2c4d5-1bb9-4a00-8cc8-75201de6fabb" }, { "id": "75b3d718-4f39-4422-829e-13273199817d", "name": "Returned on resource not found", "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 \"customer_id\": \"\",\n \"install_type\": \"helm\",\n \"instance_name\": \"\",\n \"network_availability\": \"airgap\",\n \"channel_id\": \"\",\n \"channel_release_sequence\": \"\",\n \"admin_console_url\": \"\",\n \"is_multi_node\": \"\",\n \"kubernetes_distribution\": \"rancher\",\n \"registry_availability\": \"online\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/install-options?includeInstructions=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "install-options" ], "query": [ { "description": "Whether to include install instructions in the response", "key": "includeInstructions", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-75b3d718-4f39-4422-829e-13273199817d" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9d840909-b632-43eb-8454-e31c374cefea" } ], "id": "d8d23cfc-f0d0-4bc8-868a-ad144a6261e7", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-d8d23cfc-f0d0-4bc8-868a-ad144a6261e7" }, { "name": "instances", "item": [ { "name": "List instances", "id": "79c35dd0-1342-4210-a0cd-fcbea70def97", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/instances?FilterCustomerID=&Limit=&Offset=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "instances" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" } ], "variable": [ { "id": "97682c02-5d6c-481b-86d4-e0b02c1da5c4", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "List instances for the enterprise portal with optional pagination and customer filtering." }, "response": [ { "id": "0eacee07-0028-4fff-9363-f24faab0a431", "name": "New 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}}/app/:app_id/enterprise-portal/instances?FilterCustomerID=&Limit=&Offset=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "instances" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"instances\": [\n {\n \"appStatus\": \"\",\n \"channelId\": \"\",\n \"channelSequence\": \"\",\n \"clusterId\": \"\",\n \"embeddedClusterId\": \"\",\n \"embeddedClusterVersion\": \"\",\n \"firstCheckin\": \"\",\n \"firstReadyAt\": \"\",\n \"id\": \"\",\n \"installType\": \"\",\n \"isAirgap\": \"\",\n \"k8sDistribution\": \"\",\n \"k8sVersion\": \"\",\n \"kotsInstallId\": \"\",\n \"kurlInstallId\": \"\",\n \"lastCheckin\": \"\",\n \"releaseSequence\": \"\",\n \"resourceStates\": [\n {\n \"kind\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"state\": \"\"\n },\n {\n \"kind\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"state\": \"\"\n }\n ],\n \"serviceAccountId\": \"\",\n \"tags\": [\n {\n \"instanceId\": \"\",\n \"key\": \"\",\n \"origin\": \"\",\n \"value\": \"\"\n },\n {\n \"instanceId\": \"\",\n \"key\": \"\",\n \"origin\": \"\",\n \"value\": \"\"\n }\n ],\n \"versionLabel\": \"\"\n },\n {\n \"appStatus\": \"\",\n \"channelId\": \"\",\n \"channelSequence\": \"\",\n \"clusterId\": \"\",\n \"embeddedClusterId\": \"\",\n \"embeddedClusterVersion\": \"\",\n \"firstCheckin\": \"\",\n \"firstReadyAt\": \"\",\n \"id\": \"\",\n \"installType\": \"\",\n \"isAirgap\": \"\",\n \"k8sDistribution\": \"\",\n \"k8sVersion\": \"\",\n \"kotsInstallId\": \"\",\n \"kurlInstallId\": \"\",\n \"lastCheckin\": \"\",\n \"releaseSequence\": \"\",\n \"resourceStates\": [\n {\n \"kind\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"state\": \"\"\n },\n {\n \"kind\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"state\": \"\"\n }\n ],\n \"serviceAccountId\": \"\",\n \"tags\": [\n {\n \"instanceId\": \"\",\n \"key\": \"\",\n \"origin\": \"\",\n \"value\": \"\"\n },\n {\n \"instanceId\": \"\",\n \"key\": \"\",\n \"origin\": \"\",\n \"value\": \"\"\n }\n ],\n \"versionLabel\": \"\"\n }\n ],\n \"total\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-0eacee07-0028-4fff-9363-f24faab0a431" }, { "id": "01ae55c9-97d5-49f0-aa6a-292a6ef3f2a5", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/instances?FilterCustomerID=&Limit=&Offset=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "instances" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-01ae55c9-97d5-49f0-aa6a-292a6ef3f2a5" }, { "id": "11ee6df9-13d8-4729-8e47-0931a6ac36e3", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/instances?FilterCustomerID=&Limit=&Offset=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "instances" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-11ee6df9-13d8-4729-8e47-0931a6ac36e3" }, { "id": "03c77fe7-7aa9-4dc3-9925-52ba9822e689", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/instances?FilterCustomerID=&Limit=&Offset=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "instances" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-03c77fe7-7aa9-4dc3-9925-52ba9822e689" }, { "id": "50cbc55a-39f1-413b-aded-bb92aea59e3b", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/instances?FilterCustomerID=&Limit=&Offset=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "instances" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-50cbc55a-39f1-413b-aded-bb92aea59e3b" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-79c35dd0-1342-4210-a0cd-fcbea70def97" } ], "id": "ee5eac21-5823-4826-a1e7-b650b7626cc6", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ee5eac21-5823-4826-a1e7-b650b7626cc6" }, { "name": "service-accounts", "item": [ { "name": "{serviceAccountId}", "item": [ { "name": "Delete (revoke) a service account", "id": "b82b59bb-88c1-42f5-9c6f-f490a40a68c2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/service-accounts/:serviceAccountId", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts", ":serviceAccountId" ], "variable": [ { "id": "47bad2bb-5177-463b-88c4-69454fe8f019", "key": "app_id", "value": "", "description": "(Required) App identifier" }, { "id": "2725dc10-bb9a-4bde-9d3c-853e456b0707", "key": "serviceAccountId", "value": "", "description": "(Required) Service Account ID to revoke" } ] }, "description": "Revokes an enterprise portal service account, marking it as revoked and clearing sensitive data. Note that this\nmakes the service account name reusable." }, "response": [ { "id": "566470d8-85a8-4311-84b6-8fa4e96142e7", "name": "On success, no payload returned", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/service-accounts/:serviceAccountId", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts", ":serviceAccountId" ], "variable": [ { "key": "app_id" }, { "key": "serviceAccountId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-566470d8-85a8-4311-84b6-8fa4e96142e7" }, { "id": "6afb4f9b-b5cd-40ac-a47f-c265d3003b59", "name": "Returned on bad input", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/service-accounts/:serviceAccountId", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts", ":serviceAccountId" ], "variable": [ { "key": "app_id" }, { "key": "serviceAccountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-6afb4f9b-b5cd-40ac-a47f-c265d3003b59" }, { "id": "ee2e9d07-b3cb-40f0-b596-cc3c65343287", "name": "Return if the caller is not authorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/service-accounts/:serviceAccountId", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts", ":serviceAccountId" ], "variable": [ { "key": "app_id" }, { "key": "serviceAccountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ee2e9d07-b3cb-40f0-b596-cc3c65343287" }, { "id": "b6496b5a-45f0-434a-8a43-007b2b8bfe6f", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/service-accounts/:serviceAccountId", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts", ":serviceAccountId" ], "variable": [ { "key": "app_id" }, { "key": "serviceAccountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-b6496b5a-45f0-434a-8a43-007b2b8bfe6f" }, { "id": "b9428213-240e-4889-91a3-871e3ca2ec38", "name": "Returned on resource not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/service-accounts/:serviceAccountId", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts", ":serviceAccountId" ], "variable": [ { "key": "app_id" }, { "key": "serviceAccountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-b9428213-240e-4889-91a3-871e3ca2ec38" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-b82b59bb-88c1-42f5-9c6f-f490a40a68c2" } ], "id": "b81d8445-0306-412d-8e2d-89a23def6188", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-b81d8445-0306-412d-8e2d-89a23def6188" }, { "name": "List service accounts", "id": "ad7cda02-f120-4ed3-8070-c71e28a4e97a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/service-accounts?FilterCustomerID=&Limit=&Offset=&Sort=&Order=&FilterRevoked=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" }, { "description": "Filter by revoked status", "key": "FilterRevoked", "value": "" } ], "variable": [ { "id": "160e69a4-66f9-4763-a96a-0eaa7c3863c4", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "List service accounts for the enterprise portal, optionally filtered by customer ID and/or revoked status." }, "response": [ { "id": "f0fc681d-3d24-4494-b7f4-7e4b88da8734", "name": "New 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}}/app/:app_id/enterprise-portal/service-accounts?FilterCustomerID=&Limit=&Offset=&Sort=&Order=&FilterRevoked=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" }, { "description": "Filter by revoked status", "key": "FilterRevoked", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"service_accounts\": [\n {\n \"accountName\": \"\",\n \"createdAt\": \"\",\n \"customerId\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"isRevoked\": \"\",\n \"lastUsedAt\": \"\",\n \"token\": \"\",\n \"tokenRegeneratedAt\": \"\"\n },\n {\n \"accountName\": \"\",\n \"createdAt\": \"\",\n \"customerId\": \"\",\n \"emailAddress\": \"\",\n \"id\": \"\",\n \"isRevoked\": \"\",\n \"lastUsedAt\": \"\",\n \"token\": \"\",\n \"tokenRegeneratedAt\": \"\"\n }\n ],\n \"total\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-f0fc681d-3d24-4494-b7f4-7e4b88da8734" }, { "id": "03def0fc-0fa3-4a29-aac8-671913b8c9e8", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/service-accounts?FilterCustomerID=&Limit=&Offset=&Sort=&Order=&FilterRevoked=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" }, { "description": "Filter by revoked status", "key": "FilterRevoked", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-03def0fc-0fa3-4a29-aac8-671913b8c9e8" }, { "id": "94b42f0f-6c23-460e-aa51-c20ca35ff3fe", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/service-accounts?FilterCustomerID=&Limit=&Offset=&Sort=&Order=&FilterRevoked=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" }, { "description": "Filter by revoked status", "key": "FilterRevoked", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-94b42f0f-6c23-460e-aa51-c20ca35ff3fe" }, { "id": "8897da18-215e-4587-931d-77345121b3f4", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/service-accounts?FilterCustomerID=&Limit=&Offset=&Sort=&Order=&FilterRevoked=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" }, { "description": "Filter by revoked status", "key": "FilterRevoked", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-8897da18-215e-4587-931d-77345121b3f4" }, { "id": "ba062986-cad6-4d07-9085-1c1b35c3ebb2", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/service-accounts?FilterCustomerID=&Limit=&Offset=&Sort=&Order=&FilterRevoked=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "service-accounts" ], "query": [ { "description": "Filter by a specific customer ID", "key": "FilterCustomerID", "value": "" }, { "description": "Maximum number of results to return", "key": "Limit", "value": "" }, { "description": "Number of results to skip", "key": "Offset", "value": "" }, { "description": "Sort field", "key": "Sort", "value": "" }, { "description": "Sort order (asc or desc)", "key": "Order", "value": "" }, { "description": "Filter by revoked status", "key": "FilterRevoked", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ba062986-cad6-4d07-9085-1c1b35c3ebb2" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ad7cda02-f120-4ed3-8070-c71e28a4e97a" } ], "id": "fc852363-8353-49cd-a78b-1d287a4abaae", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-fc852363-8353-49cd-a78b-1d287a4abaae" }, { "name": "settings", "item": [ { "name": "get Enterprise Portal Settings", "id": "f8a0de2c-1e3d-42df-a0ae-1ea3a82f0a72", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/settings?FilterCustomerID=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" } ], "variable": [ { "id": "754060ea-04be-4b23-8fb5-d184b1625e1b", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Get enterprise portal settings for a customer" }, "response": [ { "id": "fe41967d-be23-4901-abe3-0ec717057880", "name": "New 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}}/app/:app_id/enterprise-portal/settings?FilterCustomerID=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"settings\": {\n \"allowedDomainsEnabled\": \"\",\n \"appId\": \"\",\n \"createdAt\": \"\",\n \"customerId\": \"\",\n \"portalVersion\": \"\",\n \"teamId\": \"\",\n \"updatedAt\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-fe41967d-be23-4901-abe3-0ec717057880" }, { "id": "975897e6-4b80-4a02-b7c4-8b83ffef7982", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/settings?FilterCustomerID=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-975897e6-4b80-4a02-b7c4-8b83ffef7982" }, { "id": "d3e66fde-8298-4525-85a4-a898cec100da", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/settings?FilterCustomerID=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-d3e66fde-8298-4525-85a4-a898cec100da" }, { "id": "7ebc3049-b7b0-4b74-960a-81f70ab2f377", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/settings?FilterCustomerID=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-7ebc3049-b7b0-4b74-960a-81f70ab2f377" }, { "id": "c5ab223a-eabe-4bd3-a250-6324811621ba", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/settings?FilterCustomerID=", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "query": [ { "description": "Filter by customer ID", "key": "FilterCustomerID", "value": "" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-c5ab223a-eabe-4bd3-a250-6324811621ba" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-f8a0de2c-1e3d-42df-a0ae-1ea3a82f0a72" }, { "name": "update Enterprise Portal Settings", "id": "9980b59e-4ecc-42d4-8e77-c7b1318ece17", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"allowedDomainsEnabled\": \"\",\n \"customerId\": \"\",\n \"portalVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "variable": [ { "id": "be24bb40-38dd-4b3b-b61f-2be3a461461e", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Update enterprise portal settings for a customer" }, "response": [ { "id": "b6fa1b33-facf-4253-8b9e-01fa806ad8dc", "name": "New Response", "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 \"allowedDomainsEnabled\": \"\",\n \"customerId\": \"\",\n \"portalVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"settings\": {\n \"allowedDomainsEnabled\": \"\",\n \"appId\": \"\",\n \"createdAt\": \"\",\n \"customerId\": \"\",\n \"portalVersion\": \"\",\n \"teamId\": \"\",\n \"updatedAt\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-b6fa1b33-facf-4253-8b9e-01fa806ad8dc" }, { "id": "cf00e506-5553-4995-b4b8-1626bcba3cd3", "name": "Returned on bad input", "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 \"allowedDomainsEnabled\": \"\",\n \"customerId\": \"\",\n \"portalVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-cf00e506-5553-4995-b4b8-1626bcba3cd3" }, { "id": "00ba14e8-d7e1-4f3d-9cbb-58feac6dbe52", "name": "Return if the caller is not authorized", "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 \"allowedDomainsEnabled\": \"\",\n \"customerId\": \"\",\n \"portalVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-00ba14e8-d7e1-4f3d-9cbb-58feac6dbe52" }, { "id": "3f12b5f4-59a1-4e9e-9f58-ed9f5bfd9f17", "name": "Returned if the caller does not have the needed permission", "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 \"allowedDomainsEnabled\": \"\",\n \"customerId\": \"\",\n \"portalVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-3f12b5f4-59a1-4e9e-9f58-ed9f5bfd9f17" }, { "id": "532d6c87-42b5-40ea-884e-67d30767f5a7", "name": "Returned on resource not found", "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 \"allowedDomainsEnabled\": \"\",\n \"customerId\": \"\",\n \"portalVersion\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/settings", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "settings" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-532d6c87-42b5-40ea-884e-67d30767f5a7" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9980b59e-4ecc-42d4-8e77-c7b1318ece17" } ], "id": "40cc5f23-e61d-452e-b00c-280a97312837", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-40cc5f23-e61d-452e-b00c-280a97312837" }, { "name": "status", "item": [ { "name": "Get enterprise portal status", "id": "6e6a228c-e296-4558-8c4d-4a37f190047b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "id": "99b828a8-72ac-40a0-a6bf-164eea04ab63", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Get the status of the enterprise portal for an app" }, "response": [ { "id": "a45244ea-5d81-4e90-a573-1f5fa1f55416", "name": "GetEnterprisePortalStatusResponse represents the status of the enterprise portal.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-a45244ea-5d81-4e90-a573-1f5fa1f55416" }, { "id": "6191f329-76e3-49d9-949a-473151aa4df7", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-6191f329-76e3-49d9-949a-473151aa4df7" }, { "id": "fb8f6d82-1221-496c-bd88-54ba650b4bd1", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-fb8f6d82-1221-496c-bd88-54ba650b4bd1" }, { "id": "b4df06d2-bae4-47e0-b37a-e5a732b3b08c", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-b4df06d2-bae4-47e0-b37a-e5a732b3b08c" }, { "id": "5424296e-825b-4187-8c77-a4a0c07b89c0", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-5424296e-825b-4187-8c77-a4a0c07b89c0" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-6e6a228c-e296-4558-8c4d-4a37f190047b" }, { "name": "Update status of the enterprise portal", "id": "9ea798f6-cc9d-4960-82ba-f4737e7becb3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"per-customer\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "id": "0c5fcb19-2bb5-4739-8f56-32ff3969661d", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Update the status of the enterprise portal for an app" }, "response": [ { "id": "6e912923-20c2-41ef-9089-fd143b8b1e95", "name": "GetEnterprisePortalStatusResponse represents the status of the enterprise portal.", "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 \"status\": \"per-customer\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-6e912923-20c2-41ef-9089-fd143b8b1e95" }, { "id": "45953227-0d77-4204-b8c1-f6b6b4399c72", "name": "Returned on bad input", "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 \"status\": \"per-customer\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-45953227-0d77-4204-b8c1-f6b6b4399c72" }, { "id": "22fc35a2-c235-4352-bcbe-52d0658ce73f", "name": "Return if the caller is not authorized", "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 \"status\": \"per-customer\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-22fc35a2-c235-4352-bcbe-52d0658ce73f" }, { "id": "a0539ddb-8b92-4bd5-a014-20fa83951c21", "name": "Returned if the caller does not have the needed permission", "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 \"status\": \"per-customer\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-a0539ddb-8b92-4bd5-a014-20fa83951c21" }, { "id": "3637104a-f841-4a70-8cca-b14c481356c4", "name": "Returned on resource not found", "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 \"status\": \"per-customer\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/status", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "status" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-3637104a-f841-4a70-8cca-b14c481356c4" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9ea798f6-cc9d-4960-82ba-f4737e7becb3" } ], "id": "f69f4ff0-0c68-434a-98c0-7f9d44d4693d", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-f69f4ff0-0c68-434a-98c0-7f9d44d4693d" }, { "name": "system-user-login", "item": [ { "name": "Create a one-time login URL for Enterprise Portal using a system user for the specified customer.", "id": "79dfcb18-2498-4d8a-b136-452cdba928ca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/system-user-login", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "system-user-login" ], "variable": [ { "id": "218fc71c-d8cb-472e-b6e1-1002da9c4a48", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "The system user will be created on-demand if it does not exist. The URL will open the EP verify endpoint with the generated nonce." }, "response": [ { "id": "9747c04b-be12-41b5-8891-ff5ac0eeaca6", "name": "New 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 \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/system-user-login", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "system-user-login" ], "variable": [ { "key": "app_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"login_url\": \"\",\n \"nonce\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9747c04b-be12-41b5-8891-ff5ac0eeaca6" }, { "id": "ce5613b0-6bb7-45d8-b4d6-6e8a787a1c1d", "name": "Returned on bad input", "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 \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/system-user-login", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "system-user-login" ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-ce5613b0-6bb7-45d8-b4d6-6e8a787a1c1d" }, { "id": "978a9459-f166-4783-bb77-08b39c4cecff", "name": "Return if the caller is not authorized", "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 \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/system-user-login", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "system-user-login" ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-978a9459-f166-4783-bb77-08b39c4cecff" }, { "id": "e5837820-8230-491a-86a4-7145ac000c00", "name": "Returned if the caller does not have the needed permission", "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 \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/system-user-login", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "system-user-login" ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e5837820-8230-491a-86a4-7145ac000c00" }, { "id": "34b4f6f9-1dc6-4284-b312-21ec616e0bd3", "name": "Returned on resource not found", "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 \"customer_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/system-user-login", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "system-user-login" ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-34b4f6f9-1dc6-4284-b312-21ec616e0bd3" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-79dfcb18-2498-4d8a-b136-452cdba928ca" } ], "id": "e53ca8be-6af2-4381-8828-64e45cac48c0", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e53ca8be-6af2-4381-8828-64e45cac48c0" }, { "name": "update-attempts", "item": [ { "name": "List customer update attempts", "id": "e525dedc-2039-4920-b6e2-b471ff0f1e86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/update-attempts?customer_id=&service_account_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "update-attempts" ], "query": [ { "description": "(Required) The customer ID to list update attempts for", "key": "customer_id", "value": "" }, { "description": "Optional service account ID filter", "key": "service_account_id", "value": "" }, { "description": "Page number (starting at 1)", "key": "page", "value": "1" }, { "description": "Page size (1-100)", "key": "page_size", "value": "20" } ], "variable": [ { "id": "67959464-a954-4608-8593-928990376e77", "key": "app_id", "value": "", "description": "(Required) App identifier" } ] }, "description": "Required RBAC Policy: kots/app/[:appid]/enterprise-portal/update-attempts/read\n\nLists update attempts for a customer, optionally filtered by service account ID." }, "response": [ { "id": "44186eca-e231-4663-ab48-a584c672049c", "name": "ListUpdateAttemptsResponse is the response body for listing update attempts", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/update-attempts?customer_id=&service_account_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "update-attempts" ], "query": [ { "description": "(Required) The customer ID to list update attempts for", "key": "customer_id", "value": "" }, { "description": "Optional service account ID filter", "key": "service_account_id", "value": "" }, { "description": "Page number (starting at 1)", "key": "page", "value": "1" }, { "description": "Page size (1-100)", "key": "page_size", "value": "20" } ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"update_attempts\": [\n {\n \"admin_console_url\": \"\",\n \"airgap_assets_downloaded_at\": \"\",\n \"customer_id\": \"\",\n \"from_channel_id\": \"\",\n \"from_channel_sequence\": \"\",\n \"from_release_sequence\": \"\",\n \"from_version_label\": \"\",\n \"id\": \"\",\n \"install_option_id\": \"\",\n \"install_type\": \"\",\n \"instance_id\": \"\",\n \"instance_name\": \"\",\n \"network_availability\": \"\",\n \"service_account_email_address\": \"\",\n \"service_account_id\": \"\",\n \"started_at\": \"\",\n \"status\": \"\",\n \"target_channel_id\": \"\",\n \"target_channel_sequence\": \"\",\n \"target_release_sequence\": \"\",\n \"target_version_label\": \"\",\n \"update_completed_at\": \"\"\n },\n {\n \"admin_console_url\": \"\",\n \"airgap_assets_downloaded_at\": \"\",\n \"customer_id\": \"\",\n \"from_channel_id\": \"\",\n \"from_channel_sequence\": \"\",\n \"from_release_sequence\": \"\",\n \"from_version_label\": \"\",\n \"id\": \"\",\n \"install_option_id\": \"\",\n \"install_type\": \"\",\n \"instance_id\": \"\",\n \"instance_name\": \"\",\n \"network_availability\": \"\",\n \"service_account_email_address\": \"\",\n \"service_account_id\": \"\",\n \"started_at\": \"\",\n \"status\": \"\",\n \"target_channel_id\": \"\",\n \"target_channel_sequence\": \"\",\n \"target_release_sequence\": \"\",\n \"target_version_label\": \"\",\n \"update_completed_at\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-44186eca-e231-4663-ab48-a584c672049c" }, { "id": "52f15fdc-35ed-4e1d-a337-c9fe6c52b364", "name": "Returned on bad input", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/update-attempts?customer_id=&service_account_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "update-attempts" ], "query": [ { "description": "(Required) The customer ID to list update attempts for", "key": "customer_id", "value": "" }, { "description": "Optional service account ID filter", "key": "service_account_id", "value": "" }, { "description": "Page number (starting at 1)", "key": "page", "value": "1" }, { "description": "Page size (1-100)", "key": "page_size", "value": "20" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-52f15fdc-35ed-4e1d-a337-c9fe6c52b364" }, { "id": "79f01822-b34c-4b8a-92c7-cba3de60ae44", "name": "Return if the caller is not authorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/update-attempts?customer_id=&service_account_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "update-attempts" ], "query": [ { "description": "(Required) The customer ID to list update attempts for", "key": "customer_id", "value": "" }, { "description": "Optional service account ID filter", "key": "service_account_id", "value": "" }, { "description": "Page number (starting at 1)", "key": "page", "value": "1" }, { "description": "Page size (1-100)", "key": "page_size", "value": "20" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-79f01822-b34c-4b8a-92c7-cba3de60ae44" }, { "id": "9773beab-51a6-4f26-a2fc-1ddd83bf2def", "name": "Returned if the caller does not have the needed permission", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/update-attempts?customer_id=&service_account_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "update-attempts" ], "query": [ { "description": "(Required) The customer ID to list update attempts for", "key": "customer_id", "value": "" }, { "description": "Optional service account ID filter", "key": "service_account_id", "value": "" }, { "description": "Page number (starting at 1)", "key": "page", "value": "1" }, { "description": "Page size (1-100)", "key": "page_size", "value": "20" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"message\": \"\",\n \"messageCode\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9773beab-51a6-4f26-a2fc-1ddd83bf2def" }, { "id": "9adfc810-ceb2-40cf-802b-c3df3459f9f4", "name": "Returned on resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/app/:app_id/enterprise-portal/update-attempts?customer_id=&service_account_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "app", ":app_id", "enterprise-portal", "update-attempts" ], "query": [ { "description": "(Required) The customer ID to list update attempts for", "key": "customer_id", "value": "" }, { "description": "Optional service account ID filter", "key": "service_account_id", "value": "" }, { "description": "Page number (starting at 1)", "key": "page", "value": "1" }, { "description": "Page size (1-100)", "key": "page_size", "value": "20" } ], "variable": [ { "key": "app_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-9adfc810-ceb2-40cf-802b-c3df3459f9f4" } ], "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e525dedc-2039-4920-b6e2-b471ff0f1e86" } ], "id": "846bff71-30f2-4fd4-b09a-afac34fba3c4", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-846bff71-30f2-4fd4-b09a-afac34fba3c4" } ], "id": "7696cce2-5442-4c72-a123-85b59a357de0", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-7696cce2-5442-4c72-a123-85b59a357de0" } ], "id": "e47792f0-1d17-44d1-bee3-1ee2b4bba198", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-e47792f0-1d17-44d1-bee3-1ee2b4bba198" } ], "id": "45915c54-2a10-4288-a6e9-467f03c66a88", "createdAt": "2026-07-28T02:45:21.000Z", "updatedAt": "2026-07-28T02:45:21.000Z", "uid": "35240-45915c54-2a10-4288-a6e9-467f03c66a88" } ], "variable": [ { "key": "baseUrl", "value": "https://api.replicated.com/vendor/v3" } ] }