{ "info": { "_postman_id": "57e447a9-6397-4c02-98a2-367b6f58a9db", "name": "Coveo Activity Activities Pipelines API", "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "lastUpdatedBy": "35240", "uid": "35240-57e447a9-6397-4c02-98a2-367b6f58a9db" }, "item": [ { "name": "rest", "item": [ { "name": "search", "item": [ { "name": "v1", "item": [ { "name": "admin", "item": [ { "name": "pipelines", "item": [ { "name": "{pipelineId}", "item": [ { "name": "duplicate", "item": [ { "name": "Copy Query Pipeline", "id": "efcb24ef-df9d-499a-84d5-710f32f41b3f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId/duplicate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId", "duplicate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "35baa806-6694-436f-af8a-836e32bd2007", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Duplicates a single query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"},\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "ed5b026b-5ca3-4964-a991-a9c132204b48", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId/duplicate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId", "duplicate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"isDefault\": \"\",\n \"name\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"filter\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"last_modified_by\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"created_by\": \"\",\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-ed5b026b-5ca3-4964-a991-a9c132204b48" } ], "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-efcb24ef-df9d-499a-84d5-710f32f41b3f" } ], "id": "aac053b9-3d08-4581-b2bb-0d90f3b453fc", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-aac053b9-3d08-4581-b2bb-0d90f3b453fc" }, { "name": "swap", "item": [ { "name": "Swap Query Pipeline Names", "id": "34f039cf-fdc6-4aa2-8596-461a8ae8f9c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId/swap?other=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId", "swap" ], "query": [ { "description": "(Required) The unique identifier of the query pipeline to swap names with.", "key": "other", "value": "" }, { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "652594e6-7119-4fbf-9285-93f9febdfbac", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Swaps the names of two query pipelines. Doing so will affect the routing of incoming queries whose `pipeline` parameter is defined as the `name` value of one of the swapped query pipelines.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "1434ff30-cb25-4c31-a166-d3083ba30e6d", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId/swap?other=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId", "swap" ], "query": [ { "description": "(Required) The unique identifier of the query pipeline to swap names with.", "key": "other", "value": "" }, { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-1434ff30-cb25-4c31-a166-d3083ba30e6d" } ], "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-34f039cf-fdc6-4aa2-8596-461a8ae8f9c8" } ], "id": "9c92b358-30b3-40fb-a17e-ed7031aed182", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-9c92b358-30b3-40fb-a17e-ed7031aed182" }, { "name": "statements", "item": [ { "name": "import", "item": [ { "name": "Import Query Pipeline Statements", "id": "05701e91-19fc-4a7b-8d4c-9ba3e4a6328a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "54d9ae66-0aff-4ba0-81fe-d711c27c1426", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Import the definition, condition, and description of statements from a CSV file to a specific query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "ea1a82d4-6454-4488-b35a-f82c5cfe28c9", "name": "Imported", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-ea1a82d4-6454-4488-b35a-f82c5cfe28c9" }, { "id": "df529c1a-aa8c-4b91-a846-3a79d7a861f4", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-df529c1a-aa8c-4b91-a846-3a79d7a861f4" }, { "id": "d5ab4ed7-325a-43e5-8572-60e9b2079b8d", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-d5ab4ed7-325a-43e5-8572-60e9b2079b8d" }, { "id": "25d49e3a-4638-4155-a617-ff771dfd9752", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-25d49e3a-4638-4155-a617-ff771dfd9752" }, { "id": "f6689343-19b4-4fa5-b342-03d5b165c31c", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-f6689343-19b4-4fa5-b342-03d5b165c31c" }, { "id": "3cef39a9-aa60-405d-a612-cf0706a80ce8", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-3cef39a9-aa60-405d-a612-cf0706a80ce8" } ], "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-05701e91-19fc-4a7b-8d4c-9ba3e4a6328a" } ], "id": "98393fd1-9c96-467c-84ec-37e5d8e479af", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-98393fd1-9c96-467c-84ec-37e5d8e479af" } ], "id": "287edbd3-ab5e-41ab-9d1f-05d828fbb8f7", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-287edbd3-ab5e-41ab-9d1f-05d828fbb8f7" }, { "name": "Get Query Pipeline", "id": "35775eaf-17c2-487e-b529-39b3619485c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "4a9a6c62-08c6-43e9-b70f-9c8034573243", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Gets a single query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "c746422f-d631-45b7-9600-edb4dbb42b75", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"isDefault\": \"\",\n \"name\": \"\",\n \"position\": \"\",\n \"statementComposition\": {\n \"totalCount\": \"\"\n },\n \"description\": \"\",\n \"filter\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"last_modified_by\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"created_by\": \"\",\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n \"splitTestOriginalPipeline\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-c746422f-d631-45b7-9600-edb4dbb42b75" } ], "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-35775eaf-17c2-487e-b529-39b3619485c4" }, { "name": "Update Query Pipeline", "id": "244ca834-27c4-4258-8eca-66653b413806", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "009d8119-f9f4-4bde-81ac-6cf32edec899", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Modifies a single query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"},\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "eb64eb56-7c25-4989-b2a4-0cee16209d5c", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"isDefault\": \"\",\n \"name\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"filter\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"last_modified_by\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"created_by\": \"\",\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-eb64eb56-7c25-4989-b2a4-0cee16209d5c" } ], "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-244ca834-27c4-4258-8eca-66653b413806" }, { "name": "Delete Query Pipeline", "id": "635a2db2-edfc-4da3-bc76-85789cc4e8eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "17849898-1ea4-4aa7-8e53-c34a648739e9", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Deletes a single query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"},\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "031ec0ba-9e81-4d9b-8621-29ef131171fb", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/:pipelineId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", ":pipelineId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-031ec0ba-9e81-4d9b-8621-29ef131171fb" } ], "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-635a2db2-edfc-4da3-bc76-85789cc4e8eb" } ], "id": "8deb5853-7b18-41af-9c83-669bbda8c9d8", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-8deb5853-7b18-41af-9c83-669bbda8c9d8" }, { "name": "bulkGet", "item": [ { "name": "List Query Pipelines", "id": "3db16fab-1aa2-425e-b44b-0c6af879143c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ] }, "description": "Gets a sorted page of query pipelines matching certain criteria.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "f50db8a7-ce34-4fb0-8f85-3b586de6a48d", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"pipelines\": [\n {\n \"id\": \"\",\n \"isDefault\": \"\",\n \"name\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"filter\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"last_modified_by\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"created_by\": \"\",\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"isDefault\": \"\",\n \"name\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"filter\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"last_modified_by\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"created_by\": \"\",\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n }\n ],\n \"totalEntries\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-f50db8a7-ce34-4fb0-8f85-3b586de6a48d" }, { "id": "86c74bc2-2d88-4121-80cf-1f4168e1ffb3", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-86c74bc2-2d88-4121-80cf-1f4168e1ffb3" }, { "id": "39bfb361-aee1-4a15-a52b-5d9507d9ea4e", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-39bfb361-aee1-4a15-a52b-5d9507d9ea4e" }, { "id": "41cdce26-565d-4e03-85e2-2694f508937e", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-41cdce26-565d-4e03-85e2-2694f508937e" }, { "id": "6b14f3d8-9419-4263-9a43-efda360d3c25", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-6b14f3d8-9419-4263-9a43-efda360d3c25" }, { "id": "e8eaf49c-9d93-4f0c-bee5-ad31fed8a285", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-e8eaf49c-9d93-4f0c-bee5-ad31fed8a285" }, { "id": "c03e1df3-035a-487d-955d-4f6ea79e9fb8", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-c03e1df3-035a-487d-955d-4f6ea79e9fb8" } ], "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-3db16fab-1aa2-425e-b44b-0c6af879143c" } ], "id": "f924f880-a4ec-49e8-b2c8-9a14faa0de2a", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-f924f880-a4ec-49e8-b2c8-9a14faa0de2a" }, { "name": "validate", "item": [ { "name": "batch", "item": [ { "name": "Validate Batch of Pipeline Operations.", "id": "c7ffe6dc-e9ea-4c57-9af2-0553fc95b11a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] }, "description": "\r\n Validate that a list of operations would be accepted by our API and executed.\r\n A maximum of 15 can be processed per request.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "18bab5b7-5044-48d1-b125-7b79d80f33c6", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"results\": [\n {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"eiusmoda93\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n },\n {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"ad_6\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-18bab5b7-5044-48d1-b125-7b79d80f33c6" }, { "id": "b8abbfb8-d2ab-4644-8102-365308c0f3db", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-b8abbfb8-d2ab-4644-8102-365308c0f3db" }, { "id": "e8db75cb-d1b5-4e8c-b08a-dbb23a86bbce", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-e8db75cb-d1b5-4e8c-b08a-dbb23a86bbce" }, { "id": "c6d6e119-6e90-4009-951c-6dd7bb5c5e1d", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-c6d6e119-6e90-4009-951c-6dd7bb5c5e1d" }, { "id": "36077700-06e8-4a09-a789-f275c7842ff9", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-36077700-06e8-4a09-a789-f275c7842ff9" }, { "id": "740173e7-bf47-41f2-a852-05a125e82499", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-740173e7-bf47-41f2-a852-05a125e82499" }, { "id": "0cd43c97-a903-4712-be71-fbcea31c87e4", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-0cd43c97-a903-4712-be71-fbcea31c87e4" }, { "id": "faada4e3-4bc7-4194-a68a-d25d5a93c13b", "name": "Service Unavailable (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#5xx)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-faada4e3-4bc7-4194-a68a-d25d5a93c13b" } ], "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-c7ffe6dc-e9ea-4c57-9af2-0553fc95b11a" } ], "id": "5f8d1d33-9dc3-4546-a9c3-27e98b804768", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-5f8d1d33-9dc3-4546-a9c3-27e98b804768" }, { "name": "Validate a Single Pipeline Operation.", "id": "da882462-5a2f-4384-9db7-a0e204b461fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] }, "description": "Validate that a specific operation would be accepted by our API and executed.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "80cd50e1-910b-45c1-afb4-d5f65ae0029d", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"Ut_41\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"irure09e\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"tempor_0c9\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-80cd50e1-910b-45c1-afb4-d5f65ae0029d" }, { "id": "54cf5b7d-eca8-4de3-ade2-fdf2c4eac6d0", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-54cf5b7d-eca8-4de3-ade2-fdf2c4eac6d0" }, { "id": "e487ff07-747b-4478-ba59-6562b86f54a8", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-e487ff07-747b-4478-ba59-6562b86f54a8" }, { "id": "4c8bdf6e-95ef-48db-8f26-95ff01f052b2", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-4c8bdf6e-95ef-48db-8f26-95ff01f052b2" }, { "id": "1d647ad0-14ad-44eb-b2c5-90b2dbf79669", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-1d647ad0-14ad-44eb-b2c5-90b2dbf79669" }, { "id": "281c8f2c-3f7f-48d6-a050-13fb0eb012bc", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-281c8f2c-3f7f-48d6-a050-13fb0eb012bc" }, { "id": "520b5e4a-cd63-41c9-a528-a5eed0df82ab", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-520b5e4a-cd63-41c9-a528-a5eed0df82ab" } ], "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-da882462-5a2f-4384-9db7-a0e204b461fd" } ], "id": "1007db74-f8be-4ea9-a677-ffa31f2c6067", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-1007db74-f8be-4ea9-a677-ffa31f2c6067" }, { "name": "List Query Pipelines", "id": "de443a0c-ff09-4768-83cc-4d56d2a50ec1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines?isOrderAscending=true&filter=&sortBy=&page=0&excludeAbTestTargets=false&perPage=20&organizationId=&enablePagination=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines" ], "query": [ { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "Whether to exclude the A/B test targets from the result.", "key": "excludeAbTestTargets", "value": "false" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "Whether to receive the pipelines in a paginated format.", "key": "enablePagination", "value": "" } ] }, "description": "Gets a sorted page of query pipelines matching certain criteria.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "b8f56305-b884-462a-b148-5b226c0702aa", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines?isOrderAscending=true&filter=&sortBy=&page=0&excludeAbTestTargets=false&perPage=20&organizationId=&enablePagination=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines" ], "query": [ { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "Whether to exclude the A/B test targets from the result.", "key": "excludeAbTestTargets", "value": "false" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "Whether to receive the pipelines in a paginated format.", "key": "enablePagination", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"isDefault\": \"\",\n \"name\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"filter\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"last_modified_by\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"created_by\": \"\",\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"id\": \"\",\n \"isDefault\": \"\",\n \"name\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"filter\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"last_modified_by\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"created_by\": \"\",\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n }\n ],\n \"totalEntries\": \"\"\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-b8f56305-b884-462a-b148-5b226c0702aa" } ], "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-de443a0c-ff09-4768-83cc-4d56d2a50ec1" }, { "name": "Create Query Pipeline", "id": "5d9de40c-9db4-4aa0-b2c0-7a582ed4151a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] }, "description": "Creates a new query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "07d1b1c5-f957-4197-96e8-ad31c81e0682", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"isDefault\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"id\": \"\"\n },\n \"groupsThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"apiKeysThatCanEdit\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v1/admin/pipelines?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v1", "admin", "pipelines" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"isDefault\": \"\",\n \"name\": \"\",\n \"position\": \"\",\n \"description\": \"\",\n \"filter\": \"\",\n \"splitTestName\": \"\",\n \"splitTestTarget\": \"\",\n \"splitTestRatio\": \"\",\n \"splitTestEnabled\": \"\",\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"last_modified_by\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"created_by\": \"\",\n \"useCase\": \"\",\n \"interfaceUrls\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ],\n \"aduiConfig\": {\n \"tooltipsDismissed\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-07d1b1c5-f957-4197-96e8-ad31c81e0682" } ], "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-5d9de40c-9db4-4aa0-b2c0-7a582ed4151a" } ], "id": "88ba1d3f-4728-4fc0-9784-127214849b8d", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-88ba1d3f-4728-4fc0-9784-127214849b8d" } ], "id": "f8071a0f-237c-4299-b9e5-67f6c5de1812", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-f8071a0f-237c-4299-b9e5-67f6c5de1812" } ], "id": "fbec7dc2-a8e4-422a-a896-108cf5737c8c", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-fbec7dc2-a8e4-422a-a896-108cf5737c8c" } ], "id": "335b3e81-6015-40dc-ae70-801e5e707843", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-335b3e81-6015-40dc-ae70-801e5e707843" } ], "id": "6a8d3c55-a922-4040-8990-273502d1ad80", "createdAt": "2026-07-28T01:30:29.000Z", "updatedAt": "2026-07-28T01:30:29.000Z", "uid": "35240-6a8d3c55-a922-4040-8990-273502d1ad80" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://platform.cloud.coveo.com" } ] }