Coveo
Search Interface Service

Documentation for Search Interface Service
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.0
info:
  title: Search Interface Service
  version: 1.0.0
  description: Documentation for Search Interface Service
  termsOfService: https://www.coveo.com/en/support/terms-agreements
  contact:
    name: [email protected]
tags:
- name: Configuration
- name: Search Interface
- name: IPX Configuration
- name: Insight Panel
paths:
  /rest/organizations/{organizationId}/searchinterfaces:
    get:
      operationId: get-all-interface-config
      summary: List Search Interface Configurations
      description: Lists the search interface configurations in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      responses:
        '200':
          description: Ok
    post:
      operationId: create-interface-config
      summary: Create Search Interface Configuration
      description: Creates a search interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-config'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-config-id'
  /rest/organizations/{organizationId}/searchinterfaces/projects/interfaces:
    get:
      operationId: get-project-interface-config
      summary: List Search Interface Configurations in a Project
      description: Lists the search interface configurations in a [Coveo organization](https://docs.coveo.com/en/185/) and
        a [project](https://docs.coveo.com/en/n7ef0517/manage-an-organization/manage-projects).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/projectId'
      responses:
        '200':
          description: Ok
  /rest/organizations/{organizationId}/searchinterfaces/{interfaceId}:
    get:
      operationId: get-interface-config
      summary: Show Search Interface Configuration
      description: Shows a search interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-config-id'
        '404':
          description: Not Found
    put:
      operationId: update-interface-config
      summary: Update Search Interface Configuration
      description: Updates a search interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-config'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-config-id'
        '404':
          description: Not Found
    delete:
      operationId: delete-interface-config
      summary: Delete Search Interface Configuration
      description: Deletes a search interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/accesses:
    get:
      operationId: get-interface-access
      summary: List Search Interface Accesses
      description: Lists the accesses to a target search interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-access'
        '404':
          description: Not Found
    put:
      operationId: update-interface-access
      summary: Update Search Interface Accesses
      description: Updates the accesses to a target search interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-access'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-access'
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/accesses/users:
    get:
      operationId: get-interface-user-access
      summary: List Search Interface User Accesses
      description: Lists the accesses to a target search interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-user-list'
        '404':
          description: Not Found
    put:
      operationId: update-interface-user-access
      summary: Update Search Interface User Accesses
      description: Updates the accesses to a target search interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-user-list'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-user-list'
        '404':
          description: Not Found
    post:
      operationId: add-interface-user-access
      summary: Add Search Interface User Accesses
      description: Adds user accesses to a target search interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      - $ref: '#/components/parameters/notify'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-add-user'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-user-list'
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/html:
    get:
      operationId: get-interface-html
      summary: Retrieve Search Interface
      description: Retrieves a search interface in HTML page format from a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Interface
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              encoding:
                text/html:
                  contentType: text/html
      security:
      - {}
  /rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/manifest/v1:
    post:
      operationId: post-manifest
      summary: Retrieve Search Interface Manifest
      description: Retrieves a search interface manifest with detailed information from a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Interface
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/interface-manifest-request'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-manifest'
        '404':
          description: Not Found
      security:
      - {}
  /rest/organizations/{organizationId}/hostedpages:
    get:
      operationId: get-all-hostedpages
      summary: List Hosted Pages
      description: Lists the hosted pages in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      responses:
        '200':
          description: Ok
    post:
      operationId: create-hostedpage
      summary: Create Hosted Page
      description: Creates a hosted page in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hostedpage'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hostedpage-id'
  /rest/organizations/{organizationId}/hostedpages/projects/pages:
    get:
      operationId: get-project-hostedpages
      summary: List Hosted Pages in a Project
      description: Lists the hosted pages in a [Coveo organization](https://docs.coveo.com/en/185/) and a [project](https://docs.coveo.com/en/n7ef0517/manage-an-organization/manage-projects).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/projectId'
      responses:
        '200':
          description: Ok
  /rest/organizations/{organizationId}/hostedpages/{pageId}:
    get:
      operationId: get-hostedpage
      summary: Retrieve Hosted Page Configuration
      description: Retrieves a hosted page configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/page-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hostedpage-id'
        '404':
          description: Not Found
    put:
      operationId: update-hostedpage
      summary: Update Hosted Page
      description: Updates an hosted page in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/page-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/hostedpage'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hostedpage-id'
        '404':
          description: Not Found
    delete:
      operationId: delete-hostedpage
      summary: Delete Hosted Page
      description: Deletes an hosted page in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/page-id'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/hostedpages/{pageId}/html/v1:
    get:
      operationId: get-hostedpage-html
      summary: Show Hosted Page
      description: Shows a hosted page in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Hosted Page
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/page-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              encoding:
                text/html:
                  contentType: text/html
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces:
    get:
      operationId: get-all-ipx-interface-configs
      summary: List All IPX Interface Configurations
      description: Lists the IPX interface configurations in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      responses:
        '200':
          description: Ok
    post:
      operationId: create-ipx-interface-config
      summary: Create IPX Interface Configuration
      description: Create an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - in: query
        name: createPipelines
        description: If true, pipelines, conditions and models will be created for the IPX interface.
        schema:
          type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ipx-interface-config'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipx-interface-config-id'
  /rest/organizations/{organizationId}/ipxinterface/v1/projects/interfaces:
    get:
      operationId: get-project-ipx-interface-configs
      summary: List IPX Interface Configurations in Project
      description: Lists the IPX interface configurations in a [Coveo organization](https://docs.coveo.com/en/185/) and a
        [project](https://docs.coveo.com/en/n7ef0517/manage-an-organization/manage-projects).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/projectId'
      responses:
        '200':
          description: Ok
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}:
    get:
      operationId: get-ipx-interface-config
      summary: Show IPX Interface Configuration
      description: Shows an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipx-interface-config-id'
        '404':
          description: Not Found
    put:
      operationId: update-ipx-interface-config
      summary: Update IPX Interface Configuration
      description: Updates an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ipx-interface-config'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipx-interface-config-id'
        '404':
          description: Not Found
    delete:
      operationId: delete-ipx-interface-config
      summary: Delete IPX Interface Configuration
      description: Deletes an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions:
    get:
      operationId: get-ipx-interface-versions
      summary: Get Versions for an IPX Interface
      description: Get a list of versions of the [IPX](https://docs.coveo.com/en/n47d1000/) interface of a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      - $ref: '#/components/parameters/versions-page'
      - $ref: '#/components/parameters/versions-per-page'
      - $ref: '#/components/parameters/versions-filter'
      - $ref: '#/components/parameters/versions-order'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceVersionInfoPage'
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}:
    get:
      operationId: get-ipx-interface-version
      summary: Get an IPX Interface Version
      description: Get information about a specific version of an [IPX](https://docs.coveo.com/en/n47d1000/) interface.
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      - $ref: '#/components/parameters/version-number'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#components/schemas/IpxInterfaceVersionInfo'
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/restore:
    post:
      operationId: restore-ipx-interface-version
      summary: Restore an IPX Interface Version
      description: Restore the current [IPX](https://docs.coveo.com/en/n47d1000/) interface to a specific version.
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      - $ref: '#/components/parameters/version-number'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VersionLabelParams'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipx-interface-config-id'
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/label:
    put:
      operationId: update-ipx-interface-version-label
      summary: Update an IPX Interface Version Label
      description: Update the label for a specific [IPX](https://docs.coveo.com/en/n47d1000/) interface version.
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      - $ref: '#/components/parameters/version-number'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VersionLabelParams'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterfaceVersionInfo'
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/loader:
    get:
      operationId: get-ipx-interface-loader
      summary: Show an IPX Interface Loader
      description: Shows an IPX interface loader in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX loader
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/preview:
    post:
      operationId: preview-ipx-interface
      summary: Preview IPX Interface
      description: Generate the markup of an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ipx-interface-config-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              schema:
                type: string
                example: <atomic-search-interface></atomic-search-interface>
        '404':
          description: Not Found
        '401':
          description: Unauthorized
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/edit:
    get:
      operationId: get-ipx-interface-edit
      summary: Get IPX Interface Builder
      description: Get the builder for an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              schema:
                type: string
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/login:
    get:
      operationId: get-ipx-interface-login
      summary: Get IPX Interface Login
      description: Get the login page for an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      responses:
        '200':
          description: Ok
          content:
            text/html:
              schema:
                type: string
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/token:
    get:
      operationId: get-ipx-interface-token
      summary: Get IPX Interface Search Token
      description: Get the search token for an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  token:
                    type: string
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/pipelines:
    get:
      operationId: get-ipx-interface-pipelines
      summary: Get IPX Interface Pipelines
      description: Get the pipelines used by an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/) in
        the builder context.
      tags:
      - IPX Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pipelines-status'
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchpage/v1/interfaces:
    get:
      operationId: get-all-search-page-interfaces
      summary: Get All Search Page Interfaces
      description: Get all search page interfaces in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/search-page-interface-config-id'
    post:
      operationId: create-search-page-interface
      summary: Create a Search Page Interface
      description: Create a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/search-page-interface-config'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-page-interface-config-id'
  /organizations/{organizationId}/searchpage/v1/projects/interfaces:
    get:
      operationId: get-project-search-page-interfaces
      summary: Get Project Search Page Interfaces
      description: Get all search page interfaces in a [Coveo organization](https://docs.coveo.com/en/185/) and a [project](https://docs.coveo.com/en/n7ef0517/manage-an-organization/manage-projects).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/projectId'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/search-page-interface-config-project'
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}:
    get:
      operationId: get-search-page-interface
      summary: Get a Search Page Interface
      description: Get a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-page-interface-config-id'
        '404':
          description: Not Found
    put:
      operationId: update-search-page-interface
      summary: Update a Search Page Interface
      description: Update a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/search-page-interface-config'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-page-interface-config-id'
        '404':
          description: Not Found
    delete:
      operationId: delete-search-page-interface
      summary: Delete a Search Page Interface
      description: Delete a search page interface in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/accesses:
    get:
      operationId: get-search-page-interface-access
      summary: Get a Search Page Interface's Access Configuration
      description: Get a search page interface access in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/interface-access'
        '404':
          description: Not Found
    put:
      operationId: update-search-page-interface-access
      summary: Update a Search Page Interface's Access Configuration
      description: Update a search page interface access in a [Coveo organization](https://docs.coveo.com/en/185/).
      tags:
      - Search Page Configuration
      parameters:
      - $ref: '#/components/parameters/organization-id'
      - $ref: '#/components/parameters/interface-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/search-page-interface-access'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search-page-interface-access'
        '404':
          description: Not Found
  /rest/organizations/{organizationId}/searchpage/v1/interfaces/{interface

# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-search-interface-openapi-original.yml
Search Interface Service

Documentation

Specifications

Other Resources

OpenAPI Specification
