Coveo Search Pages API

openapi: 3.2.0
info:
  description: Service in charge of CRUD operations for Coveo Cloud hosted search pages
  title: Coveo Search Pages API
  termsOfService: http://www.coveo.com/en/support/terms-agreements
  contact:
    name: Coveo Community
    url: https://answers.coveo.com/
  version: '1.0'
servers:
- url: https://platform.cloud.coveo.com
  description: Coveo public API endpoint
tags:
- description: Manage Classic hosted search pages
  name: Search Pages
paths:
  /rest/organizations/{organizationID}/pages:
    get:
      security:
      - OAuth2:
        - full
      description: 'Gets the JSON definition of search pages hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "VIEW", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: List Search Pages
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The _name_ metadata value of a specific search page to retrieve (e.g., _mysearchpage_).
        name: name
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/swaggermodels.ResponsePage'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
    post:
      security:
      - OAuth2:
        - full
      description: 'Creates a new empty search page in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Create<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "CREATE", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Create Search Page
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponsePage'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/swaggermodels.RequestCreateEmptyPage'
        description: The new page metadata.
        required: true
  /rest/organizations/{organizationID}/pages/ids:
    post:
      security:
      - OAuth2:
        - full
      description: 'Gets the JSON definition of search pages hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "VIEW", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: List Search Pages by Ids
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/swaggermodels.ResponsePage'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        description: The list of ids
        required: true
  /rest/organizations/{organizationID}/pages/project/id:
    get:
      security:
      - OAuth2:
        - full
      description: 'lists Pages by project id in a [Coveo Cloud organization](https://docs.coveo.com/en/185/). <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "VIEW", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: List Pages by Project ID
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The _projectid_ of the pages.
        name: projectid
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/swaggermodels.ResponsePage'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
  /rest/organizations/{organizationID}/pages/{pageID}:
    get:
      security:
      - OAuth2:
        - full
      description: 'Gets the JSON definition of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "VIEW", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Get Search Page
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page to retrieve (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponsePage'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
    put:
      security:
      - OAuth2:
        - full
      description: 'Updates metadata pertaining to a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "EDIT", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Update Search Page Metadata
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page to delete (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The search page was successfully updated.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/swaggermodels.RequestUpdatePageMetadata'
        description: The updated search page metadata.
        required: true
    delete:
      security:
      - OAuth2:
        - full
      description: 'Delete a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "EDIT", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Delete a Search Page or in-App Widget
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page to delete (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The search page was successfully deleted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
  /rest/organizations/{organizationID}/pages/{pageID}/header:
    get:
      security:
      - OAuth2:
        - full
      description: 'Gets the JSON definition of a specific search page header hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "VIEW", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Get Search Page Header
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page to view (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.PageHeaderSharedModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
    put:
      security:
      - OAuth2:
        - full
      description: 'Updates the order of the JavaScript and CSS resources in the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "EDIT", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Reorder Resources in Search Page Header
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.PageHeaderSharedModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/swaggermodels.UpdateHeaderResourcesModel'
        description: The reordered resources.
        required: true
  /rest/organizations/{organizationID}/pages/{pageID}/header/css:
    post:
      security:
      - OAuth2:
        - full
      description: 'Create a CSS resource in the header pertaining to a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "EDIT", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Create CSS Resource in a Search Page Header
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.CSSResourceSharedModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/swaggermodels.CSSResourceSharedModel'
        description: The CSS resource to append.
        required: true
  /rest/organizations/{organizationID}/pages/{pageID}/header/css/{resourceName}:
    put:
      security:
      - OAuth2:
        - full
      description: 'Updates a CSS resource in the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "EDIT", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Update CSS Resource in Search Page Header.
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      - description: The name identifier of the CSS resource (e.g., 'myresource').
        name: resourceName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.CSSResourceSharedModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/swaggermodels.CSSResourceSharedModel'
        description: The updated CSS resource.
        required: true
    delete:
      security:
      - OAuth2:
        - full
      description: 'Removes a CSS resource from the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "EDIT", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Delete CSS Resource in Search Page Header.
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      - description: The name identifier of the CSS resource (e.g., 'myresource').
        name: resourceName
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The resource was successfully deleted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
  /rest/organizations/{organizationID}/pages/{pageID}/header/javascript:
    post:
      security:
      - OAuth2:
        - full
      description: 'Appends a JavaScript resource to the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "EDIT", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Append JavaScript Resource to Search Page Header.
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.JavaScriptResourceSharedModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/swaggermodels.JavaScriptResourceSharedModel'
        description: The JavaScript resource to append.
        required: true
  /rest/organizations/{organizationID}/pages/{pageID}/header/javascript/{resourceName}:
    put:
      security:
      - OAuth2:
        - full
      description: 'Updates a JavaScript resource in the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "EDIT", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Update JavaScript Resource in Search Page Header.
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      - description: The name identifier of the JavaScript resource (e.g., 'myresource').
        name: resourceName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.JavaScriptResourceSharedModel'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/swaggermodels.JavaScriptResourceSharedModel'
        description: The updated JavaScript resource.
        required: true
    delete:
      security:
      - OAuth2:
        - full
      description: 'Removes a JavaScript resource from the header of a specific search page hosted in the target Coveo Cloud organization. <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "EDIT", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Delete JavaScript Resource in Search Page Header.
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      - description: The name identifier of the JavaScript resource (e.g., 'myresource').
        name: resourceName
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The resource was successfully deleted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorBadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorUnauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorNotFound'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/swaggermodels.ResponseApplicationErrorInternalServerError'
  /rest/organizations/{organizationID}/pages/{pageID}/searchui:
    get:
      security:
      - OAuth2:
        - full
      description: 'Gets the identifier of the JavaScript Search Framework version currently being used for a specific search page hosted in the target Coveo Cloud organization, and lists the newer versions this search page can be upgraded to. <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ "owner": "SEARCH_API", "targetDomain": "SEARCH_PAGES", "type": "VIEW", "targetId": "*" }```</details>'
      tags:
      - Search Pages
      summary: Get Search Page JavaScript Search Framework Information
      parameters:
      - description: The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3').
        name: organizationID
        in: path
        required: true
        schema:
          type: string
      - description: The unique identifier of the search page to delete (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
        name: pageID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
           

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