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

Coveo Indexing Pipeline Extensions API

The Indexing Pipeline Extensions API from Coveo — 14 operation(s) for indexing pipeline extensions.

Coveo Indexing Pipeline Extensions 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 Indexing Pipeline Extensions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 18 operations across 14 paths, and defines 27 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.

18 operations 14 paths 27 schemas 1 DELETE7 GET7 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
Terms of Service
Resource Areas
1

Authentication & Security 1

Coveo Indexing Pipeline Extensions 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 18

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

Indexing Pipeline Extensions 18
GET
/rest/organizations/{organizationId}/extensions/{extensionId}
Show Extension
getExtension 2 params → 200
PUT
/rest/organizations/{organizationId}/extensions/{extensionId}
Update Extension
updateExtension 2 params body → 200
DELETE
/rest/organizations/{organizationId}/extensions/{extensionId}
Delete Extension
deleteExtension 2 params → 204
PUT
/rest/organizations/{organizationId}/extensions/{extensionId}/timeouts
Set Timeout for a Given Extension for an Organization.
updateExtensionTimeout 2 params body → 204
GET
/rest/organizations/{organizationId}/extensions/{extensionId}/code
Show Extension Code
getExtensionCode 2 params → 200
PUT
/rest/organizations/{organizationId}/extensions/{extensionId}/code
Update Extension Code
updateExtensionCode 2 params body → 200
GET
/rest/organizations/{organizationId}/extensions
List Extensions
getExtensions 1 param → 200
POST
/rest/organizations/{organizationId}/extensions
Create Extension
createExtension 1 param body → 201
POST
/rest/organizations/{organizationId}/extensions/{extensionId}/test
Test Extension
testExtension 2 params body → 200
POST
/rest/organizations/{organizationId}/extensions/{extensionId}/test/datastream
Create Test Data Stream Upload URI
generateTestDataStreamUploadUri 2 params → 200
POST
/rest/organizations/{organizationId}/extensions/{extensionId}/enable
Enable Extension
enableExtension 2 params → 204
POST
/rest/organizations/{organizationId}/extensions/{extensionId}/disable
Disable Extension
disableExtension 2 params body → 204
POST
/rest/organizations/{organizationId}/extensions/test/compile
Try to Compile Code for an Extension
compileExtension 1 param body → 200
POST
/rest/organizations/{organizationId}/extensions/ids
Get a Subset of Extensions by Ids for an Organization.
getExtensionsByIds 4 params body → 200
GET
/rest/organizations/{organizationId}/extensions/{extensionId}/versions
List Extension Versions
getExtensionVersions 2 params → 200
GET
/rest/organizations/{organizationId}/extensions/{extensionId}/versions/{versionId}
Show Extension Version
getExtensionVersion 3 params → 200
GET
/rest/organizations/{organizationId}/extensions/project
Get Extensions Associated with Specified Project.
getExtensionsByProjectId 5 params → 200
GET
/rest/organizations/{organizationId}/extensions/page
List Extensions by Page with Filter.
getExtensionsByPage 4 params → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are ExtensionModel (16 properties), EditExtensionModel (10 properties), SinglePermissionModel (9 properties), ExtensionStatusModel (7 properties). Each schema is shown below with its type and property counts.

ExtensionStatusModel
object
Status details of an [extension](https://docs.coveo.com/en/206/).
7 properties 5 required
SinglePermissionModel
object
9 properties
LogEntryModel
object
An extension test execution log.
5 properties 1 required
ExtensionUsedByModel
object
A [source](https://docs.coveo.com/en/246/) a given extension applies to.
2 properties
IdAndDisplayNameModel
object
2 properties
EditExtensionModel
object
An [extension](https://docs.coveo.com/en/206/) to create or modify.
10 properties 2 required
ExtensionTestResultModel
object
Details regarding the outcome of an extension script execution.
2 properties 1 required
ExtensionTestDocumentModel
object
A mock document. Default: {"metadata":[],"dataStreams":[],"permissions":[]}
4 properties
ExtensionHealthModel
object
Information regarding a health characteristic of the extension.
2 properties 1 required
ExtensionTestExecutionReportModel
object
Test results of an [extension](https://docs.coveo.com/en/206/).
5 properties 4 required
ExtensionStatisticsModel
object
Execution statistics pertaining to an extension over the past 24 hours (for all items from all sources to which the extension applies).
5 properties 5 required
ExtensionCompileErrorModel
object
4 properties
ExtensionDisableModel
object
Information regarding the disablement of an extension.
1 property
ExtensionDisabledStatusModel
object
Information regarding the disabled state of an extension, if applicable.
2 properties 1 required
ExtensionTestModel
object
A mock document on which to test the extension.
4 properties
PermissionSetModel
object
3 properties
DataStreamContentModel
object
A [data stream](https://docs.coveo.com/en/2891/) object. Allowed keys: - BODYTEXT - BODYHTML - THUMBNAIL - DOCUMENTDATA Example:"BODYTEXT":{"id":"47ce8655-3d0e…
3 properties 3 required
ExtensionContentVersionModel
object
An [extension](https://docs.coveo.com/en/206/) version.
2 properties 2 required
MetadataValueModel
object
Metadata for an [item](https://docs.coveo.com/en/210/). Default: []
2 properties
ExtensionCompileResultModel
object
Details regarding the outcome of an extension script compilation.
2 properties
ExtensionTimeoutModel
object
Timeout in seconds that are applicable for extensions.
1 property
ExtensionTestDataStreamUriModel
object
Information regarding a [data stream](https://docs.coveo.com/en/2891/) upload/download URI.
3 properties 3 required
DataStreamValueModel
object
A set of [data streams](https://docs.coveo.com/en/2891/).
2 properties 1 required
PageModelExtensionModel
object
3 properties
PermissionLevelModel
object
The document permissions.
2 properties
ExtensionModel
object
An [extension](https://docs.coveo.com/en/206/).
16 properties 10 required
ExtensionCompileModel
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-indexing-pipeline-extensions-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
Coveo Administration API - Version 15 API
Coveo Advanced Model Configurations API
Coveo Agent Configuration API API
Coveo Agent Orchestration API API
Coveo Analysis V3 API
Coveo Analytics API - Version 14 API
Coveo Analytics API - Version 15 API
Coveo Answer API
Coveo Api Keys API
Coveo Atlassian Connect App API
Coveo Badges API
Where this information came from

This is an independent, third-party profile of Coveo Indexing Pipeline Extensions 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.