openapi: 3.0.1
info:
title: Coveo Activity Activities Indexing Pipeline Extensions API
description: API for Coveo Platform
termsOfService: https://www.coveo.com/en/support/terms-agreements
contact:
name: Coveo
url: https://connect.coveo.com/s/discussions
version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
description: Coveo public API endpoint
security:
- oauth2:
- full
tags:
- name: Indexing Pipeline Extensions
paths:
/rest/organizations/{organizationId}/extensions/{extensionId}:
get:
tags:
- Indexing Pipeline Extensions
summary: Show Extension
description: 'Shows an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getExtension
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: extensionId
in: path
description: The unique identifier of the extension to show.<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3n-vwlyqfbtjkotxqkmrxqjcbcpoy`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ExtensionModel'
x-pretty-name: getExtension
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId_get
put:
tags:
- Indexing Pipeline Extensions
summary: Update Extension
description: 'Updates an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"EDIT","targetId":"{extensionId}"}
```
</details>'
operationId: updateExtension
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: extensionId
in: path
description: The unique identifier of the extension to update.<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3-vwlyqfbtjkotxqkmrxqjcbcpoy`
required: true
schema:
type: string
requestBody:
description: The new configuration to use for the updated extension.
content:
application/json:
schema:
$ref: '#/components/schemas/EditExtensionModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ExtensionModel'
x-pretty-name: updateExtension
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId_put
delete:
tags:
- Indexing Pipeline Extensions
summary: Delete Extension
description: 'Deletes an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"EDIT","targetId":"{extensionId}"}
```
</details>'
operationId: deleteExtension
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: extensionId
in: path
description: The unique identifier of the extension to delete.<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3-vwlyqfbtjkotxqkmrxqjcbcpoy`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: deleteExtension
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId_delete
/rest/organizations/{organizationId}/extensions/{extensionId}/timeouts:
put:
tags:
- Indexing Pipeline Extensions
summary: Set Timeout for a Given Extension for an Organization.
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"EDIT","targetId":"{extensionId}"}
```
</details>'
operationId: updateExtensionTimeout
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: extensionId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionTimeoutModel'
required: true
responses:
'204':
description: No Content
x-pretty-name: updateExtensionTimeout
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId/timeouts_put
/rest/organizations/{organizationId}/extensions/{extensionId}/code:
get:
tags:
- Indexing Pipeline Extensions
summary: Show Extension Code
description: 'Shows an [extension] code(https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getExtensionCode
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: extensionId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
text/plain:
schema:
type: string
x-pretty-name: getExtensionCode
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId/code_get
put:
tags:
- Indexing Pipeline Extensions
summary: Update Extension Code
description: 'Updates an [extension] code(https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"EDIT","targetId":"{extensionId}"}
```
</details>'
operationId: updateExtensionCode
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: extensionId
in: path
required: true
schema:
type: string
requestBody:
content:
text/plain:
schema:
type: string
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ExtensionModel'
x-pretty-name: updateExtensionCode
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId/code_put
/rest/organizations/{organizationId}/extensions:
get:
tags:
- Indexing Pipeline Extensions
summary: List Extensions
description: 'Lists all [extensions](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getExtensions
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/ExtensionModel'
x-pretty-name: getExtensions
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/extensions_get
post:
tags:
- Indexing Pipeline Extensions
summary: Create Extension
description: 'Creates an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - Create<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"CREATE","targetId":"*"}
```
</details>'
operationId: createExtension
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
requestBody:
description: The configuration to use for the new extension.
content:
application/json:
schema:
$ref: '#/components/schemas/EditExtensionModel'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/ExtensionModel'
x-pretty-name: createExtension
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: CREATE
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: CREATE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/extensions_post
/rest/organizations/{organizationId}/extensions/{extensionId}/test:
post:
tags:
- Indexing Pipeline Extensions
summary: Test Extension
description: 'Tests an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"EDIT","targetId":"{extensionId}"}
```
</details>'
operationId: testExtension
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: extensionId
in: path
description: The unique identifier of the extension to test.<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3-vwlyqfbtjkotxqkmrxqjcbcpoy`
required: true
schema:
type: string
requestBody:
description: A mock document on which to test the extension.
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionTestModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ExtensionTestExecutionReportModel'
x-pretty-name: testExtension
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId/test_post
/rest/organizations/{organizationId}/extensions/{extensionId}/test/datastream:
post:
tags:
- Indexing Pipeline Extensions
summary: Create Test Data Stream Upload URI
description: 'Creates an upload URI to host a [data stream](https://docs.coveo.com/en/2891/) when testing an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br />See [Uploading a Data Stream for an Extension Test](https://docs.coveo.com/en/2916).<br /><br />**Required privilege:** Extensions - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"EDIT","targetId":"{extensionId}"}
```
</details>'
operationId: generateTestDataStreamUploadUri
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: extensionId
in: path
description: The unique identifier of the extension for which to create an upload URI.<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3-vwlyqfbtjkotxqkmrxqjcbcpoy`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ExtensionTestDataStreamUriModel'
x-pretty-name: generateTestDataStreamUploadUri
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId/test/datastream_post
/rest/organizations/{organizationId}/extensions/{extensionId}/enable:
post:
tags:
- Indexing Pipeline Extensions
summary: Enable Extension
description: 'Enables a disabled [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><b>Note:</b> Disabled extensions are not executed.<br /><br />**Required privilege:** Extensions - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"EDIT","targetId":"{extensionId}"}
```
</details>'
operationId: enableExtension
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: extensionId
in: path
description: The unique identifier of the extension to enable.<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3-vwlyqfbtjkotxqkmrxqjcbcpoy`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: enableExtension
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId/enable_post
/rest/organizations/{organizationId}/extensions/{extensionId}/disable:
post:
tags:
- Indexing Pipeline Extensions
summary: Disable Extension
description: 'Disables an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><b>Note:</b> Disabled extensions are not executed.<br /><br />**Required privilege:** Extensions - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"EDIT","targetId":"{extensionId}"}
```
</details>'
operationId: disableExtension
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: extensionId
in: path
description: The unique identifier of the extension to disable.<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3-vwlyqfbtjkotxqkmrxqjcbcpoy`
required: true
schema:
type: string
requestBody:
description: A JSON containing information regarding the disablement of an extension.
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionDisableModel'
required: true
responses:
'204':
description: No Content
x-pretty-name: disableExtension
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: EDIT
targetId: '{extensionId}'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId/disable_post
/rest/organizations/{organizationId}/extensions/test/compile:
post:
tags:
- Indexing Pipeline Extensions
summary: Try to Compile Code for an Extension
description: 'Tries to compile code that would be used in an extension for [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: compileExtension
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionCompileModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ExtensionCompileResultModel'
x-pretty-name: compileExtension
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/extensions/test/compile_post
/rest/organizations/{organizationId}/extensions/ids:
post:
tags:
- Indexing Pipeline Extensions
summary: Get a Subset of Extensions by Ids for an Organization.
description: 'Lists subset of [extensions](https://docs.coveo.com/en/206/) by their respective ids in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getExtensionsByIds
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
- name: perPage
in: query
required: false
schema:
type: integer
format: int32
default: 100
- name: filter
in: query
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PageModelExtensionModel'
x-pretty-name: getExtensionsByIds
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/extensions/ids_post
/rest/organizations/{organizationId}/extensions/{extensionId}/versions:
get:
tags:
- Indexing Pipeline Extensions
summary: List Extension Versions
description: 'Lists all versions of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getExtensionVersions
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: extensionId
in: path
description: The unique identifier of the target extension.<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3-vwlyqfbtjkotxqkmrxqjcbcpoy`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/ExtensionContentVersionModel'
x-pretty-name: getExtensionVersions
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId/versions_get
/rest/organizations/{organizationId}/extensions/{extensionId}/versions/{versionId}:
get:
tags:
- Indexing Pipeline Extensions
summary: Show Extension Version
description: 'Shows a specific version of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getExtensionVersion
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: extensionId
in: path
description: The unique identifier of the target extension.<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3-vwlyqfbtjkotxqkmrxqjcbcpoy`
required: true
schema:
type: string
- name: versionId
in: path
description: The unique identifier of the extension version to show.<br /><b>Example</b>:`hdJSDb4hTkdnsCynNtF.d657FgLSDydcj`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ExtensionModel'
x-pretty-name: getExtensionVersion
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/extensions/paramId/versions/paramId_get
/rest/organizations/{organizationId}/extensions/project:
get:
tags:
- Indexing Pipeline Extensions
summary: Get Extensions Associated with Specified Project.
description: 'Lists subset of [extensions](https://docs.coveo.com/en/206/) by their respective project id in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getExtensionsByProjectId
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: projectId
in: query
required: false
schema:
type: string
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
- name: perPage
in: query
required: false
schema:
type: integer
format: int32
default: 100
- name: filter
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PageModelExtensionModel'
x-pretty-name: getExtensionsByProjectId
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/extensions/project_get
/rest/organizations/{organizationId}/extensions/page:
get:
tags:
- Indexing Pipeline Extensions
summary: List Extensions by Page with Filter.
description: 'Lists pages of [extensions](https://docs.coveo.com/en/206/) matching filter in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br />**Required privilege:** Extensions - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"INDEXING_PIPELINE_EXTENSION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getExtensionsByPage
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
- name: perPage
in: query
required: false
schema:
type: integer
format: int32
default: 100
- name: filter
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PageModelExtensionModel'
x-pretty-name: getExtensionsByPage
x-required-privilege:
owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: INDEXING_PIPELINE_EXTENSION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/extensions/page_get
components:
schemas:
ExtensionContentVersionModel:
required:
- id
- lastModified
type: object
properties:
lastModified:
type: string
description: 'The date at which the extension version was created (in number of milliseconds since UNIX epoch), i.e., the date of the modification of the extension when this extension version was created.<br />**Example**: `1556308241000`'
format: date-time
id:
type: string
description: The unique identifier of the extension target version.<br />**Example**:`hdJSDb4hTkdnsCynNtF.d657FgLSDydcj`
description: An [extension](https://docs.coveo.com/en/206/) version.
PageModelExtensionModel:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ExtensionModel'
totalEntries:
type: integ
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-indexing-pipeline-extensions-api-openapi.yml