Coveo

Coveo Sources API

The Sources API from Coveo — 45 operation(s) for sources.

GitHub OpenAPI

Operations 55

POST /rest/organizations/{organizationId}/schema/sources/SLACK/validateToken Validates a Slack OAuth Token #
GET /rest/organizations/{organizationId}/schema/sources/{sourceType}/defaultObjectsToGet Retrieves the Default Objects for a Source of Type Specified. #
GET /rest/organizations/{organizationId}/schema/sources/{sourceType}/entities Retrieves the List of Entities Present in a Source, in Alphabetical Order of Display Names. #
GET /rest/organizations/{organizationId}/schema/sources/{sourceType}/entities/{entityId} Retrieves the Entity Specified with Its Fields. #
GET /rest/organizations/{organizationId}/schema/sources/{sourceType}/entities/{entityId}/fields Retrieves the Specified Entity, with Its Fields in Alphabetical Order of Display Names. #
POST /rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/generic Computes the Generic Objects to Get from a Specific Objects to Get. #
POST /rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/specific Computes the Specific Objects to Get from a Generic Objects to Get. #
POST /rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/specificWithMappings Computes the Specific Objects to Get from a Generic Objects to Get with a List of Mapping Description #
GET /rest/organizations/{organizationId}/sources/{sourceId} Get a Single Source #
PUT /rest/organizations/{organizationId}/sources/{sourceId} Update a Source from Simple Configuration #
DELETE /rest/organizations/{organizationId}/sources/{sourceId} Delete a Source #
GET /rest/organizations/{organizationId}/sources/{sourceId}/schedules/{scheduleId} Get a Source Schedule #
PUT /rest/organizations/{organizationId}/sources/{sourceId}/schedules/{scheduleId} Update a Source Schedule #
DELETE /rest/organizations/{organizationId}/sources/{sourceId}/schedules/{scheduleId} Delete a Source Schedule #
GET /rest/organizations/{organizationId}/sources/{sourceId}/raw Get the Raw Configuration of a Source #
PUT /rest/organizations/{organizationId}/sources/{sourceId}/raw Update a Source from Raw Configuration #
PUT /rest/organizations/{organizationId}/sources/{sourceId}/permissions/update Update Source Permissions #
GET /rest/organizations/{organizationId}/sources/fields/{fieldId} Get a Single Field for an Organization #
PUT /rest/organizations/{organizationId}/sources/fields/{fieldId} Update a Field for an Organization #
DELETE /rest/organizations/{organizationId}/sources/fields/{fieldId} Removes a Specific Field from an Organization #
PUT /rest/organizations/{organizationId}/sources/fields/batch/update Update a Field for an Organization #
GET /rest/organizations/{organizationId}/sources Get a Subset of Sources for an Organization #
POST /rest/organizations/{organizationId}/sources Create a Source from Simple Configuration #
POST /rest/organizations/{organizationId}/sources/{sourceId}/tasks/abort Abort a Source Task Related to a Given Activity. #
POST /rest/organizations/{organizationId}/sources/{sourceId}/stopRefresh Stop the Current Refresh Operation on a Source #
POST /rest/organizations/{organizationId}/sources/{sourceId}/startRefresh Start a Refresh Operation on a Source #
GET /rest/organizations/{organizationId}/sources/{sourceId}/schedules Get All Source Schedules #
POST /rest/organizations/{organizationId}/sources/{sourceId}/schedules Create a New Schedule for the Source #
POST /rest/organizations/{organizationId}/sources/{sourceId}/resumeRefresh Resume the Current Refresh Operation on a Source #
POST /rest/organizations/{organizationId}/sources/{sourceId}/rebuild Apply a Rebuild Operation on a Source #
POST /rest/organizations/{organizationId}/sources/{sourceId}/pushRefresh Sets the Refreshing State of a Push Source #
POST /rest/organizations/{organizationId}/sources/{sourceId}/pauseRefresh Pause the Current Refresh Operation on a Source #
POST /rest/organizations/{organizationId}/sources/{sourceId}/incrementalRefresh Apply an Incremental Refresh Operation on a Source #
POST /rest/organizations/{organizationId}/sources/{sourceId}/fullRefresh Apply a Full Refresh Operation on a Source #
POST /rest/organizations/{organizationId}/sources/{sourceId}/enable Enable Schedules on a Source #
POST /rest/organizations/{organizationId}/sources/{sourceId}/duplicate Duplicate a Source #
POST /rest/organizations/{organizationId}/sources/{sourceId}/disable Disable Schedules on a Source #
POST /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/evict Evict the Salesforce Schema of a Source. #
POST /rest/organizations/{organizationId}/sources/{sourceId}/applyChanges Apply Pending Changes on a Source #
POST /rest/organizations/{organizationId}/sources/raw Create a Source from Raw Configuration #
POST /rest/organizations/{organizationId}/sources/pages/ids Get a Page Containing a Subset of Sources by Ids for an Organization. #
GET /rest/organizations/{organizationId}/sources/fields Get All Fields for an Organization #
POST /rest/organizations/{organizationId}/sources/fields Creates a Field for an Organization #
POST /rest/organizations/{organizationId}/sources/fields/batch/create Creates Fields for an Organization #
GET /rest/organizations/{organizationId}/sources/{sourceId}/light Get a Single Source #
GET /rest/organizations/{organizationId}/sources/{sourceId}/configuration/snapshot Get the Snapshot of the Source Configuration at the Provided Activity. #
GET /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName} Get an Object Fields for a Given Source. #
GET /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName}/{relationshipName} Get a Relationship for a Given Source and Object. #
GET /rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName}/fields Get an Object Fields for a Given Source. #
GET /rest/organizations/{organizationId}/sources/raw/all Get the Raw Configuration of All Sources #
GET /rest/organizations/{organizationId}/sources/pages Get a Page Containing a Subset of Sources for an Organization. #
GET /rest/organizations/{organizationId}/sources/pages/project Get a Page Containing a Subset of Sources Part of a Project Id. with the Total Number of Sources and the Total Number of Pages #
GET /rest/organizations/{organizationId}/sources/page/fields Get a Page of Fields for an Organization #
GET /rest/organizations/{organizationId}/sources/document/configuration/default Get the Default Document Configuration #
DELETE /rest/organizations/{organizationId}/sources/fields/batch/delete Removes Fields from an Organization #

Documentation

📖
Documentation
https://docs.coveo.com/en/124/
📖
Documentation
https://docs.coveo.com/en/365/
📖
Documentation
https://docs.coveo.com/en/56/
📖
Documentation
https://docs.coveo.com/en/3343/
📖
Documentation
https://docs.coveo.com/en/3265/
📖
Documentation
https://docs.coveo.com/en/1727/
📖
Documentation
https://docs.coveo.com/en/68/
📖
Documentation
https://docs.coveo.com/en/nbhe0427/
📖
Documentation
https://docs.coveo.com/en/52/
📖
Documentation
https://docs.coveo.com/en/2986/
📖
Documentation
https://docs.coveo.com/en/1719/

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-passagev3-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetrequest-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restfacetresultvalue-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupby-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupbyresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restgroupbyvalue-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-resthighlightresponse-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restquerycorrection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryfunction-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryparameters-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryparentresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryresponse-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restqueryresult-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-restrankingfunction-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-retrievepassagesrequestv3-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-schema/coveo-search-retrievepassagesresponsev3-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-passagev3-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetrequest-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restfacetresultvalue-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupby-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupbyresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restgroupbyvalue-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-resthighlightresponse-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restquerycorrection-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryfunction-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryparameters-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryparentresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryresponse-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restqueryresult-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-restrankingfunction-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-retrievepassagesrequestv3-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-structure/coveo-search-retrievepassagesresponsev3-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-ld/coveo-commerce-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/examples/coveo-search-querysuggestpostv3-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/examples/coveo-search-retrievepassagev3-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/examples/coveo-search-searchusingpost-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/examples/coveo-search-searchusingpostv3-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/examples/coveo-search-valuespost-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-ld/coveo-context.jsonld
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/json-ld/coveo-analytics-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/coveo-sources-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

coveo-sources-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Coveo Sources API
  version: 1.0.0
  description: 'Operations tagged Sources across 2 of this provider''s published API definitions: coveo-schema-service-openapi-original.yml, coveo-source-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://platform.cloud.coveo.com
  description: Coveo public API endpoint
tags:
- name: Sources
paths:
  /rest/organizations/{organizationId}/schema/sources/SLACK/validateToken:
    post:
      operationId: validateSlackToken
      summary: Validates a Slack OAuth Token
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: accessTokenGuid
        description: The OAuth token Guid linked with the token to validate.
        required: false
        in: query
        schema:
          type: string
      - name: accessToken
        description: The OAuth token to validate.
        required: false
        in: query
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackTokenValidationStatus'
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/defaultObjectsToGet:
    get:
      operationId: getDefaultObjectsToGet
      summary: Retrieves the Default Objects for a Source of Type Specified.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericObjectsToGet'
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/entities:
    get:
      operationId: getSchemaEntities
      summary: Retrieves the List of Entities Present in a Source, in Alphabetical Order of Display Names.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: accessTokenGuid
        description: The source's access token Guid (if authentified through access token)
        required: false
        in: query
        schema:
          type: string
      - name: entityIds
        description: IDs of the entities to retrieve (comma-separated list)
        required: false
        in: query
        schema:
          type: string
      - name: limit
        description: The number of entities to retrieve
        required: false
        in: query
        schema:
          type: integer
          format: int32
      - name: offset
        description: Starting index of the first entity to retrieve
        required: false
        in: query
        schema:
          type: integer
          format: int32
      - name: query
        description: A query used to match specific entities
        required: false
        in: query
        schema:
          type: string
      - name: username
        description: The source's username (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: passwordGuid
        description: The source's password Guid (if authentified through Basic Auth)
        required: false
        in: query
        schema:
          type: string
      - name: clientId
        description: The source's client id(if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: clientSecretGuid
        description: The source's client secret Guid (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: oauthRefreshTokenGuid
        description: The source's refresh token Guid (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: instanceUrl
        description: The source's instance Url.
        required: true
        in: query
        schema:
          type: string
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaEntities'
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/entities/{entityId}:
    get:
      operationId: getSchemaEntity
      summary: Retrieves the Entity Specified with Its Fields.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: filter
        description: The record count filter
        required: false
        in: query
        schema:
          type: string
      - name: username
        description: The source's username (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: passwordGuid
        description: The source's password Guid (if authentified through Basic Auth)
        required: false
        in: query
        schema:
          type: string
      - name: clientId
        description: The source's client id(if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: clientSecretGuid
        description: The source's client secret Guid (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: oauthRefreshTokenGuid
        description: The source's refresh token Guid (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: instanceUrl
        description: The source's instance Url.
        required: true
        in: query
        schema:
          type: string
      - name: entityId
        description: The id of the entity
        required: true
        in: path
        schema:
          type: string
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaEntities'
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/entities/{entityId}/fields:
    get:
      operationId: getSchemaEntityFields
      summary: Retrieves the Specified Entity, with Its Fields in Alphabetical Order of Display Names.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: username
        description: The source's username (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: passwordGuid
        description: The source's password Guid (if authentified through Basic Auth)
        required: false
        in: query
        schema:
          type: string
      - name: clientId
        description: The source's client id(if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: clientSecretGuid
        description: The source's client secret Guid (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: oauthRefreshTokenGuid
        description: The source's refresh token Guid (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: instanceUrl
        description: The source's instance Url.
        required: true
        in: query
        schema:
          type: string
      - name: entityId
        description: The name of the entity
        required: true
        in: path
        schema:
          type: string
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaEntities'
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/generic:
    post:
      operationId: translateToGeneric
      summary: Computes the Generic Objects to Get from a Specific Objects to Get.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericObjectsToGet'
      security:
      - oauth2:
        - full
      requestBody:
        content:
          application/json:
            schema:
              type: string
        description: Specific objects to get
        required: true
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/specific:
    post:
      operationId: translateToSpecific
      summary: Computes the Specific Objects to Get from a Generic Objects to Get.
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpecificObjectsToGet'
      security:
      - oauth2:
        - full
      requestBody:
        content:
          application/json:
            schema:
              type: string
        description: Generic objects to get
        required: true
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/specificWithMappings:
    post:
      operationId: translateToSpecificWithMappings
      summary: Computes the Specific Objects to Get from a Generic Objects to Get with a List of Mapping Description
      tags:
      - Sources
      deprecated: false
      parameters:
      - name: accessTokenGuid
        description: The source's access token Guid (if authentified through access token)
        required: false
        in: query
        schema:
          type: string
      - name: username
        description: The source's username (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: passwordGuid
        description: The source's password Guid (if authentified through Basic Auth)
        required: false
        in: query
        schema:
          type: string
      - name: clientId
        description: The source's client id(if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: clientSecretGuid
        description: The source's client secret Guid (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: oauthRefreshTokenGuid
        description: The source's refresh token Guid (if authentified through OAuth).
        required: false
        in: query
        schema:
          type: string
      - name: instanceUrl
        description: The source's instance Url.
        required: true
        in: query
        schema:
          type: string
      - name: sourceType
        description: The type of the source
        required: true
        in: path
        schema:
          type: string
      - name: organizationId
        description: The organization ID
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JValue'
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
      security:
      - oauth2:
        - full
    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
      security:
      - oauth2:
        - full
    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
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
      security:
      - oauth2:
        - full
    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
      security:
      - oauth2:
        - full
    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
      security:
      - oauth2:
        - full
    servers:
    - url: https://platform.cloud.coveo.com
      description: Coveo public API endpoint
  /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
      security:
      - oauth2:
       

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