How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Coveo

Coveo Crawling Module API

The Crawling Module API from Coveo — 13 operation(s) for crawling module.

Documentation Provider Profile APIs.io OpenAPI GitHub

Coveo Crawling Module API is one of 152 APIs that Coveo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 34 JSON Schema definitions.

Tagged areas include Crawling Module. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 16 operations across 13 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://platform.cloud.coveo.com.

16 operations 13 paths 13 schemas 1 DELETE9 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Contact
Coveo
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Coveo Crawling Module API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 16

Across 13 paths, the API surfaces 16 operations — 1 DELETE, 9 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Crawling Module 16
PUT
/rest/organizations/{organizationId}/crawlingmodules/{crawlingModuleId}/logrequests/{crawlingModuleLogRequestId}/state
Privilege required {"owner":"PLATFORM","targetDomain":"CRAWLINGMODULELOGREQUEST","type":"EDIT","targetId":""}
updateCrawlingModuleLogRequestState 3 params body → 200
POST
/rest/organizations/{organizationId}/crawlingmodules/{crawlingModuleId}/reporting
Privilege required {"owner":"PLATFORM","targetDomain":"ONPREMISEADMINISTRATION","type":"EDIT","targetId":""} OR {"owner":"PLATFORM","targetDomain":"CRAWLINGMODULE","type":"EDIT","targetId":""}
createCrawlingModuleReport 3 params body → 200
GET
/rest/organizations/{organizationId}/crawlingmodules/{crawlingModuleId}/logrequests
Privilege required {"owner":"PLATFORM","targetDomain":"CRAWLINGMODULELOGREQUEST","type":"VIEW","targetId":""}
getCrawlingModuleLogRequests 5 params → 200
POST
/rest/organizations/{organizationId}/crawlingmodules/{crawlingModuleId}/logrequests
Privilege required {"owner":"PLATFORM","targetDomain":"CRAWLINGMODULELOGREQUEST","type":"CREATE","targetId":""}
createCrawlingModuleLogRequest 2 params body → 200
GET
/rest/organizations/{organizationId}/crawlingmodules/{crawlingModuleId}/logrequests/{crawlingModuleLogRequestId}/uploadurl
Privilege required {"owner":"PLATFORM","targetDomain":"CRAWLINGMODULELOGREQUEST","type":"EDIT","targetId":""}
getCrawlingModuleLogRequestUploadUrl 3 params → 200
GET
/rest/organizations/{organizationId}/crawlingmodules/{crawlingModuleId}/logrequests/{crawlingModuleLogRequestId}/download
Privilege required {"owner":"PLATFORM","targetDomain":"CRAWLINGMODULELOGREQUEST","type":"VIEW","targetId":""}
getCrawlingModuleLogRequestDownload 3 params → 200
PUT
/rest/organizations/{organizationId}/crawlingmodule/{crawlingModuleId}
Report Crawling Module Deployment
reportCrawlingModule 2 params body → 200
DELETE
/rest/organizations/{organizationId}/crawlingmodule/{crawlingModuleId}
Remove a Crawling Module Deployment
removeCrawlingModule 2 params → 204
PUT
/rest/crawlingmodule/upgradechannels/{upgradeChannel}/version/{version}
Sets the Crawling Module Version for an Upgrade Channel
setCrawlingModuleUpgradeChannelVersion 2 params → 200
GET
/rest/organizations/{organizationId}/crawlingmodule
List Crawling Modules
getCrawlingModulesForOrganization 1 param → 200
POST
/rest/organizations/{organizationId}/crawlingmodule
List Crawling Modules by Ids
getCrawlingModulesByIdsForOrganization 1 param body → 200
GET
/rest/organizations/{organizationId}/crawlingmodule/{crawlingModuleId}/update
Get the Update Status
getUpdateStatus 2 params → 200
GET
/rest/organizations/{organizationId}/crawlingmodule/versions/latest
Gets the Latest Maestro Version
getLatestMaestroVersion 1 param → 200
GET
/rest/organizations/{organizationId}/crawlingmodule/projectid
List Crawling Modules by Project ID
getCrawlingModulesByProjectIdForOrganization 2 params → 200
GET
/rest/organizations/{organizationId}/crawlingmodule/download
Get the Download URL Prefix for Crawling Module Binaries.
getCrawlingModuleDownloadUrl 1 param → 200
GET
/rest/crawlingmodule/upgradechannels/{upgradeChannel}/version
Gets the Crawling Module Version for an Upgrade Channel
getCrawlingModuleUpgradeChannelVersion 1 param → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are CrawlingModuleModel (11 properties), CrawlingModuleReportModel (8 properties), CrawlingModuleLogRequestModel (6 properties), CrawlingModuleExceptionModel (4 properties). Each schema is shown below with its type and property counts.

CrawlingModuleExceptionModel
object
4 properties
PageModelCrawlingModuleLogRequestModel
object
3 properties
CrawlingModuleLogRequestModel
object
6 properties
CrawlingModuleReportModel
object
8 properties
CreateCrawlingModuleLogRequestModel
object
3 properties
ValueModelString
object
1 property
CrawlingModuleLogRequestStateModel
object
2 properties
CrawlingModuleLogRequestDownloadModel
object
3 properties
ReportCrawlingModuleModel
object
A crawling module report.
3 properties
CrawlingModuleUpdateStatusModel
object
A crawling module update status.
2 properties
CrawlingModuleModel
object
A crawling module.
11 properties
JsonNode
object
CrawlingModuleVersionsModel
object
Various versions of a crawling module.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-crawling-module-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
AE Profile APIs.io
Coveo Administration API - Version 15 API
AE Profile APIs.io
Coveo Advanced Model Configurations API
AE Profile APIs.io
Coveo Agent Configuration API API
AE Profile APIs.io
Coveo Agent Orchestration API API
AE Profile APIs.io
Coveo Analysis V3 API
AE Profile APIs.io
Coveo Analytics API - Version 14 API
AE Profile APIs.io
Coveo Analytics API - Version 15 API
AE Profile APIs.io
Coveo Answer API
AE Profile APIs.io
Coveo Api Keys API
AE Profile APIs.io
Coveo Atlassian Connect App API
AE Profile APIs.io
Coveo Badges API
AE Profile APIs.io
#Crawling Module
← Back to C APIs
API Details
ID
coveo:coveo-crawling-module-api
Base URL
https://platform.cloud.coveo.com
Docs
https://docs.coveo.com/en/124/
Provider
Coveo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=coveo-crawling-module-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/coveo-crawling-module-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Coveo Crawling Module API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.