Coveo

Coveo Source API

API for Coveo Platform

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.coveo.com/en/1719/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-source-openapi-original.yml

Other Resources

🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/capabilities/source-mappings.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/capabilities/source-metadata.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/capabilities/source-salesforce-source-configuration.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/capabilities/source-source-extension-configurations.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/capabilities/source-source-item-types.yaml
🔗
NaftikoCapability
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/capabilities/source-sources.yaml

OpenAPI Specification

coveo-source-openapi-original.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Coveo Source 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: Sources
  description: Operations specific to source schedules
- name: Sources
  description: Operations specific to fields in sources
paths:
  /rest/organizations/{organizationId}/sources/{sourceId}:
    get:
      tags:
      - Sources
      summary: Get a Single Source
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}

        ```

        </details>'
      operationId: getSource
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                oneOf:
                - $ref: '#/components/schemas/SourceModel'
                - $ref: '#/components/schemas/AmazonS3SourceModel'
                - $ref: '#/components/schemas/BoxEnterprise2SourceModel'
                - $ref: '#/components/schemas/CatalogSourceModel'
                - $ref: '#/components/schemas/Confluence2HostedSourceModel'
                - $ref: '#/components/schemas/Confluence2SourceModel'
                - $ref: '#/components/schemas/CustomSourceModel'
                - $ref: '#/components/schemas/DatabaseSourceModel'
                - $ref: '#/components/schemas/DropboxForBusinessSourceModel'
                - $ref: '#/components/schemas/FileSourceModel'
                - $ref: '#/components/schemas/GenericRestSourceModel'
                - $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
                - $ref: '#/components/schemas/GraphQlSourceModel'
                - $ref: '#/components/schemas/Jira2HostedSourceModel'
                - $ref: '#/components/schemas/Jira2SourceModel'
                - $ref: '#/components/schemas/JiveHostedSourceModel'
                - $ref: '#/components/schemas/JiveSourceModel'
                - $ref: '#/components/schemas/KhorosSourceModel'
                - $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
                - $ref: '#/components/schemas/PushSourceModel'
                - $ref: '#/components/schemas/RSSSourceModel'
                - $ref: '#/components/schemas/SAPSourceModel'
                - $ref: '#/components/schemas/SalesforceSitesSourceModel'
                - $ref: '#/components/schemas/SalesforceSourceModel'
                - $ref: '#/components/schemas/ServiceNowSourceModel'
                - $ref: '#/components/schemas/SharePointOnline2SourceModel'
                - $ref: '#/components/schemas/SharePointSourceModel'
                - $ref: '#/components/schemas/ShopifySourceModel'
                - $ref: '#/components/schemas/SitecoreSourceModel'
                - $ref: '#/components/schemas/SitemapSourceModel'
                - $ref: '#/components/schemas/SlackSourceModel'
                - $ref: '#/components/schemas/Web2SourceModel'
                - $ref: '#/components/schemas/YouTubeSourceModel'
                - $ref: '#/components/schemas/ZendeskSourceModel'
      x-pretty-name: getSource
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId_get
    put:
      tags:
      - Sources
      summary: Update a Source from Simple Configuration
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: updateSource
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: updateSecurityProviders
        in: query
        required: false
        schema:
          type: boolean
          default: true
      - name: rebuild
        in: query
        required: false
        schema:
          type: boolean
          default: true
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/SourceModel'
              - $ref: '#/components/schemas/AmazonS3SourceModel'
              - $ref: '#/components/schemas/BoxEnterprise2SourceModel'
              - $ref: '#/components/schemas/CatalogSourceModel'
              - $ref: '#/components/schemas/Confluence2HostedSourceModel'
              - $ref: '#/components/schemas/Confluence2SourceModel'
              - $ref: '#/components/schemas/CustomSourceModel'
              - $ref: '#/components/schemas/DatabaseSourceModel'
              - $ref: '#/components/schemas/DropboxForBusinessSourceModel'
              - $ref: '#/components/schemas/FileSourceModel'
              - $ref: '#/components/schemas/GenericRestSourceModel'
              - $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
              - $ref: '#/components/schemas/GraphQlSourceModel'
              - $ref: '#/components/schemas/Jira2HostedSourceModel'
              - $ref: '#/components/schemas/Jira2SourceModel'
              - $ref: '#/components/schemas/JiveHostedSourceModel'
              - $ref: '#/components/schemas/JiveSourceModel'
              - $ref: '#/components/schemas/KhorosSourceModel'
              - $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
              - $ref: '#/components/schemas/PushSourceModel'
              - $ref: '#/components/schemas/RSSSourceModel'
              - $ref: '#/components/schemas/SAPSourceModel'
              - $ref: '#/components/schemas/SalesforceSitesSourceModel'
              - $ref: '#/components/schemas/SalesforceSourceModel'
              - $ref: '#/components/schemas/ServiceNowSourceModel'
              - $ref: '#/components/schemas/SharePointOnline2SourceModel'
              - $ref: '#/components/schemas/SharePointSourceModel'
              - $ref: '#/components/schemas/ShopifySourceModel'
              - $ref: '#/components/schemas/SitecoreSourceModel'
              - $ref: '#/components/schemas/SitemapSourceModel'
              - $ref: '#/components/schemas/SlackSourceModel'
              - $ref: '#/components/schemas/Web2SourceModel'
              - $ref: '#/components/schemas/YouTubeSourceModel'
              - $ref: '#/components/schemas/ZendeskSourceModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                oneOf:
                - $ref: '#/components/schemas/SourceModel'
                - $ref: '#/components/schemas/AmazonS3SourceModel'
                - $ref: '#/components/schemas/BoxEnterprise2SourceModel'
                - $ref: '#/components/schemas/CatalogSourceModel'
                - $ref: '#/components/schemas/Confluence2HostedSourceModel'
                - $ref: '#/components/schemas/Confluence2SourceModel'
                - $ref: '#/components/schemas/CustomSourceModel'
                - $ref: '#/components/schemas/DatabaseSourceModel'
                - $ref: '#/components/schemas/DropboxForBusinessSourceModel'
                - $ref: '#/components/schemas/FileSourceModel'
                - $ref: '#/components/schemas/GenericRestSourceModel'
                - $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
                - $ref: '#/components/schemas/GraphQlSourceModel'
                - $ref: '#/components/schemas/Jira2HostedSourceModel'
                - $ref: '#/components/schemas/Jira2SourceModel'
                - $ref: '#/components/schemas/JiveHostedSourceModel'
                - $ref: '#/components/schemas/JiveSourceModel'
                - $ref: '#/components/schemas/KhorosSourceModel'
                - $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
                - $ref: '#/components/schemas/PushSourceModel'
                - $ref: '#/components/schemas/RSSSourceModel'
                - $ref: '#/components/schemas/SAPSourceModel'
                - $ref: '#/components/schemas/SalesforceSitesSourceModel'
                - $ref: '#/components/schemas/SalesforceSourceModel'
                - $ref: '#/components/schemas/ServiceNowSourceModel'
                - $ref: '#/components/schemas/SharePointOnline2SourceModel'
                - $ref: '#/components/schemas/SharePointSourceModel'
                - $ref: '#/components/schemas/ShopifySourceModel'
                - $ref: '#/components/schemas/SitecoreSourceModel'
                - $ref: '#/components/schemas/SitemapSourceModel'
                - $ref: '#/components/schemas/SlackSourceModel'
                - $ref: '#/components/schemas/Web2SourceModel'
                - $ref: '#/components/schemas/YouTubeSourceModel'
                - $ref: '#/components/schemas/ZendeskSourceModel'
      x-pretty-name: updateSource
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId_put
    delete:
      tags:
      - Sources
      summary: Delete a Source
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: deleteSource
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                oneOf:
                - $ref: '#/components/schemas/SourceModel'
                - $ref: '#/components/schemas/AmazonS3SourceModel'
                - $ref: '#/components/schemas/BoxEnterprise2SourceModel'
                - $ref: '#/components/schemas/CatalogSourceModel'
                - $ref: '#/components/schemas/Confluence2HostedSourceModel'
                - $ref: '#/components/schemas/Confluence2SourceModel'
                - $ref: '#/components/schemas/CustomSourceModel'
                - $ref: '#/components/schemas/DatabaseSourceModel'
                - $ref: '#/components/schemas/DropboxForBusinessSourceModel'
                - $ref: '#/components/schemas/FileSourceModel'
                - $ref: '#/components/schemas/GenericRestSourceModel'
                - $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
                - $ref: '#/components/schemas/GraphQlSourceModel'
                - $ref: '#/components/schemas/Jira2HostedSourceModel'
                - $ref: '#/components/schemas/Jira2SourceModel'
                - $ref: '#/components/schemas/JiveHostedSourceModel'
                - $ref: '#/components/schemas/JiveSourceModel'
                - $ref: '#/components/schemas/KhorosSourceModel'
                - $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
                - $ref: '#/components/schemas/PushSourceModel'
                - $ref: '#/components/schemas/RSSSourceModel'
                - $ref: '#/components/schemas/SAPSourceModel'
                - $ref: '#/components/schemas/SalesforceSitesSourceModel'
                - $ref: '#/components/schemas/SalesforceSourceModel'
                - $ref: '#/components/schemas/ServiceNowSourceModel'
                - $ref: '#/components/schemas/SharePointOnline2SourceModel'
                - $ref: '#/components/schemas/SharePointSourceModel'
                - $ref: '#/components/schemas/ShopifySourceModel'
                - $ref: '#/components/schemas/SitecoreSourceModel'
                - $ref: '#/components/schemas/SitemapSourceModel'
                - $ref: '#/components/schemas/SlackSourceModel'
                - $ref: '#/components/schemas/Web2SourceModel'
                - $ref: '#/components/schemas/YouTubeSourceModel'
                - $ref: '#/components/schemas/ZendeskSourceModel'
      x-pretty-name: deleteSource
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId_delete
  /rest/organizations/{organizationId}/sources/{sourceId}/schedules/{scheduleId}:
    get:
      tags:
      - Sources
      summary: Get a Source Schedule
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}

        ```

        </details>'
      operationId: getSourceSchedule
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: scheduleId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ScheduleModel'
      x-pretty-name: getSourceSchedule
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/schedules/paramId_get
    put:
      tags:
      - Sources
      summary: Update a Source Schedule
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: updateSourceSchedule
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: scheduleId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleModel'
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ScheduleModel'
      x-pretty-name: updateSourceSchedule
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/schedules/paramId_put
    delete:
      tags:
      - Sources
      summary: Delete a Source Schedule
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: deleteSourceSchedule
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: scheduleId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      x-pretty-name: deleteSourceSchedule
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/schedules/paramId_delete
  /rest/organizations/{organizationId}/sources/{sourceId}/raw:
    get:
      tags:
      - Sources
      summary: Get the Raw Configuration of a Source
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}

        ```

        </details>'
      operationId: getRawSource
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: includeMappings
        in: query
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RawSourceConfig'
      x-pretty-name: getRawSource
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/raw_get
    put:
      tags:
      - Sources
      summary: Update a Source from Raw Configuration
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: updateRawSource
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      - name: updateSecurityProviders
        in: query
        required: false
        schema:
          type: boolean
          default: true
      - name: rebuild
        in: query
        required: false
        schema:
          type: boolean
          default: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RawSourceConfig'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                oneOf:
                - $ref: '#/components/schemas/SourceModel'
                - $ref: '#/components/schemas/AmazonS3SourceModel'
                - $ref: '#/components/schemas/BoxEnterprise2SourceModel'
                - $ref: '#/components/schemas/CatalogSourceModel'
                - $ref: '#/components/schemas/Confluence2HostedSourceModel'
                - $ref: '#/components/schemas/Confluence2SourceModel'
                - $ref: '#/components/schemas/CustomSourceModel'
                - $ref: '#/components/schemas/DatabaseSourceModel'
                - $ref: '#/components/schemas/DropboxForBusinessSourceModel'
                - $ref: '#/components/schemas/FileSourceModel'
                - $ref: '#/components/schemas/GenericRestSourceModel'
                - $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
                - $ref: '#/components/schemas/GraphQlSourceModel'
                - $ref: '#/components/schemas/Jira2HostedSourceModel'
                - $ref: '#/components/schemas/Jira2SourceModel'
                - $ref: '#/components/schemas/JiveHostedSourceModel'
                - $ref: '#/components/schemas/JiveSourceModel'
                - $ref: '#/components/schemas/KhorosSourceModel'
                - $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
                - $ref: '#/components/schemas/PushSourceModel'
                - $ref: '#/components/schemas/RSSSourceModel'
                - $ref: '#/components/schemas/SAPSourceModel'
                - $ref: '#/components/schemas/SalesforceSitesSourceModel'
                - $ref: '#/components/schemas/SalesforceSourceModel'
                - $ref: '#/components/schemas/ServiceNowSourceModel'
                - $ref: '#/components/schemas/SharePointOnline2SourceModel'
                - $ref: '#/components/schemas/SharePointSourceModel'
                - $ref: '#/components/schemas/ShopifySourceModel'
                - $ref: '#/components/schemas/SitecoreSourceModel'
                - $ref: '#/components/schemas/SitemapSourceModel'
                - $ref: '#/components/schemas/SlackSourceModel'
                - $ref: '#/components/schemas/Web2SourceModel'
                - $ref: '#/components/schemas/YouTubeSourceModel'
                - $ref: '#/components/schemas/ZendeskSourceModel'
      x-pretty-name: updateRawSource
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/raw_put
  /rest/organizations/{organizationId}/sources/{sourceId}/permissions/update:
    put:
      tags:
      - Sources
      summary: Update Source Permissions
      description: '<details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: updateSourcePermissions
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourcePermissionsUpdateModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                oneOf:
                - $ref: '#/components/schemas/SourceModel'
                - $ref: '#/components/schemas/AmazonS3SourceModel'
                - $ref: '#/components/schemas/BoxEnterprise2SourceModel'
                - $ref: '#/components/schemas/CatalogSourceModel'
                - $ref: '#/components/schemas/Confluence2HostedSourceModel'
                - $ref: '#/components/schemas/Confluence2SourceModel'
                - $ref: '#/components/schemas/CustomSourceModel'
                - $ref: '#/components/schemas/DatabaseSourceModel'
                - $ref: '#/components/schemas/DropboxForBusinessSourceModel'
                - $ref: '#/components/schemas/FileSourceModel'
                - $ref: '#/components/schemas/GenericRestSourceModel'
                - $ref: '#/components/schemas/GoogleDriveDomainWideSourceModel'
                - $ref: '#/components/schemas/GraphQlSourceModel'
                - $ref: '#/components/schemas/Jira2HostedSourceModel'
                - $ref: '#/components/schemas/Jira2SourceModel'
                - $ref: '#/components/schemas/JiveHostedSourceModel'
                - $ref: '#/components/schemas/JiveSourceModel'
                - $ref: '#/components/schemas/KhorosSourceModel'
                - $ref: '#/components/schemas/MicrosoftDynamicsSourceModel'
                - $ref: '#/components/schemas/PushSourceModel'
                - $ref: '#/components/schemas/RSSSourceModel'
                - $ref: '#/components/schemas/SAPSourceModel'
                - $ref: '#/components/schemas/SalesforceSitesSourceModel'
                - $ref: '#/components/schemas/SalesforceSourceModel'
                - $ref: '#/components/schemas/ServiceNowSourceModel'
                - $ref: '#/components/schemas/SharePointOnline2SourceModel'
                - $ref: '#/components/schemas/SharePointSourceModel'
                - $ref: '#/components/schemas/ShopifySourceModel'
                - $ref: '#/components/schemas/SitecoreSourceModel'
                - $ref: '#/components/schemas/SitemapSourceModel'
                - $ref: '#/components/schemas/SlackSourceModel'
                - $ref: '#/components/schemas/Web2SourceModel'
                - $ref: '#/components/schemas/YouTubeSourceModel'
                - $ref: '#/components/schemas/ZendeskSourceModel'
      x-pretty-name: updateSourcePermissions
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/permissions/update_put
  /rest/organizations/{organizationId}/sources/{sourceId}/mappings:
    get:
      tags:
      - Mappings
      summary: Show Mapping Configuration
      description: 'Shows the [mapping](https://docs.coveo.com/en/217/) configuration of a [source](https://docs.coveo.com/en/246/).<br
        /> See [Managing the Mapping Configuration of a Source](https://docs.coveo.com/en/29/).</br>**Required privilege:**
        Sources - View<br /><br /><details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}

        ```

        </details>'
      operationId: getMappingsConfiguration
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
          `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MappingsConfigurationModel'
      x-pretty-name: getMappingsConfiguration
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings_get
    put:
      tags:
      - Mappings
      summary: Update Mapping Configuration
      description: 'Updates the [mapping](https://docs.coveo.com/en/217/) configuration of a [source](https://docs.coveo.com/en/246/).<br
        /> See [Managing the Mapping Configuration of a  Source](https://docs.coveo.com/en/29/).</br>**Required privilege:**
        Sources - Edit<br /><br /><details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: updateMappingsConfiguration
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
          `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
        required: true
        schema:
          type: string
      - name: rebuild
        in: query
        description: Whether to rebuild the [source](https://docs.coveo.com/en/246/) after the operation.<br />**Default:**
          `false`
        required: false
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MappingsConfigurationModel'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MappingsConfigurationModel'
      x-pretty-name: updateMappingsConfiguration
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: EDIT
        targetId: '{sourceId}'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings_put
  /rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}:
    get:
      tags:
      - Mappings
      summary: List Specific Mappings of Given Type
      description: 'Lists the [mappings](https://docs.coveo.com/en/217/) of a specific [item](https://docs.coveo.com/en/210/)
        type.</br>**Required privilege:** Sources - View<br /><br /><details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"VIEW","targetId":"*"}

        ```

        </details>'
      operationId: getMappingTypeSettings
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
          `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        description: The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`
        required: true
        schema:
          type: string
      - name: typeId
        in: path
        description: The specific [mapping](https://docs.coveo.com/en/217/) type to show.<br />**Example:** `Video`
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TypedMappingSettingsModel'
      x-pretty-name: getMappingTypeSettings
      x-required-privilege:
        owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-required-privileges:
      - owner: PLATFORM
        targetDomain: SOURCE
        type: VIEW
        targetId: '*'
      x-ui-operation-id: /rest/organizations/paramId/sources/paramId/mappings/types/paramId_get
    put:
      tags:
      - Mappings
      summary: Update Specific Mappings of Given Type
      description: 'Updates the [mappings](https://docs.coveo.com/en/217/) of a specific [item](https://docs.coveo.com/en/210/)
        type.</br>**Required privilege:** Sources - Edit<br /><br /><details><summary>Privilege required</summary>

        ```

        {"owner":"PLATFORM","targetDomain":"SOURCE","type":"EDIT","targetId":"{sourceId}"}

        ```

        </details>'
      operationId: updateMappingTypeSettings
      parameters:
      - name: organizationId
        in: path
        description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
          `mycoveocloudv2organizationg8tp8wu3`
        required: true
        schema:
          type: string
      - name: sourceId
        in: path
        description: The unique identifier of the target [source](https://docs.coveo.

# --- truncated at 32 KB (296 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-source-openapi-original.yml