{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Crawling Module API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
      "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Crawling Module",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "updateCrawlingModuleLogRequestState",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodules/:crawlingModuleId/logrequests/:crawlingModuleLogRequestId/state",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "crawlingModuleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "crawlingModuleLogRequestId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE_LOG_REQUEST\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "createCrawlingModuleReport",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodules/:crawlingModuleId/reporting",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "crawlingModuleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "destination",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ON_PREMISE_ADMINISTRATION\",\"type\":\"EDIT\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "getCrawlingModuleLogRequests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodules/:crawlingModuleId/logrequests",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "crawlingModuleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "state",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE_LOG_REQUEST\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "createCrawlingModuleLogRequest",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodules/:crawlingModuleId/logrequests",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "crawlingModuleId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE_LOG_REQUEST\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "getCrawlingModuleLogRequestUploadUrl",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodules/:crawlingModuleId/logrequests/:crawlingModuleLogRequestId/uploadurl",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "crawlingModuleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "crawlingModuleLogRequestId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE_LOG_REQUEST\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "getCrawlingModuleLogRequestDownload",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodules/:crawlingModuleId/logrequests/:crawlingModuleLogRequestId/download",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "crawlingModuleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "crawlingModuleLogRequestId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE_LOG_REQUEST\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Report Crawling Module Deployment",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodule/:crawlingModuleId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "crawlingModuleId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target crawling module.</br>**Example:** mycoveocloudv2organization76kcam-1e7c13e2-afe7-4510-bd00-cd5fd8ba9b0d\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reports a crawling module deployment in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).</br>**Required privilege:** On-Premise Administration - Edit or Crawling Module - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ON_PREMISE_ADMINISTRATION\",\"type\":\"EDIT\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Remove a Crawling Module Deployment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodule/:crawlingModuleId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "crawlingModuleId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target crawling module.</br>**Example:** mycoveocloudv2organization76kcam-1e7c13e2-afe7-4510-bd00-cd5fd8ba9b0d\n"
              }
            ]
          },
          "docs": "Remove an inactive Crawling Module Deployment</br>**Required privilege:** On-Premise Administration - Edit or Crawling Module - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ON_PREMISE_ADMINISTRATION\",\"type\":\"EDIT\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Sets the Crawling Module Version for an Upgrade Channel",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/crawlingmodule/upgradechannels/:upgradeChannel/version/:version",
            "params": [
              {
                "name": "upgradeChannel",
                "value": "",
                "type": "path"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Sets the Crawling Module Version for an Upgrade Channel"
        },
        {
          "info": {
            "name": "List Crawling Modules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodule",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ON_PREMISE_ADMINISTRATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Crawling Modules by Ids",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodule",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ON_PREMISE_ADMINISTRATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get the Update Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodule/:crawlingModuleId/update",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "crawlingModuleId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target crawling module.</br>**Example:** mycoveocloudv2organization76kcam-1e7c13e2-afe7-4510-bd00-cd5fd8ba9b0d\n"
              }
            ]
          },
          "docs": "Get the update status of a crawling module for an organization.</br>**Required privilege:** Crawling Module - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Gets the Latest Maestro Version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodule/versions/latest",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ]
          },
          "docs": "Gets the latest version of Maestro of an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).</br>**Required privilege:** On-Premise Administration - View or Crawling Module - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ON_PREMISE_ADMINISTRATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Crawling Modules by Project ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodule/projectid",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ON_PREMISE_ADMINISTRATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get the Download URL Prefix for Crawling Module Binaries.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/crawlingmodule/download",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"CRAWLING_MODULE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Gets the Crawling Module Version for an Upgrade Channel",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/crawlingmodule/upgradechannels/:upgradeChannel/version",
            "params": [
              {
                "name": "upgradeChannel",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Gets the Crawling Module Version for an Upgrade Channel"
        }
      ]
    }
  ],
  "bundled": true
}