openapi: 3.0.1
info:
title: Coveo Activity Activities Search Pages API
description: API for Coveo Platform
termsOfService: https://www.coveo.com/en/support/terms-agreements
contact:
name: Coveo
url: https://connect.coveo.com/s/discussions
version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
description: Coveo public API endpoint
security:
- oauth2:
- full
tags:
- 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>'
produces:
- application/json
tags:
- Search Pages
summary: List Search Pages
parameters:
- type: string
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
- type: string
description: The _name_ metadata value of a specific search page to retrieve (e.g., _mysearchpage_).
name: name
in: query
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/swaggermodels.ResponsePage'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/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>'
consumes:
- application/json
produces:
- application/json
tags:
- Search Pages
summary: Create Search Page
parameters:
- type: string
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
- description: The new page metadata.
name: payload
in: body
required: true
schema:
$ref: '#/definitions/swaggermodels.RequestCreateEmptyPage'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/swaggermodels.ResponsePage'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorInternalServerError'
/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>'
produces:
- application/json
tags:
- Search Pages
summary: List Search Pages by Ids
parameters:
- type: string
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
- description: The list of ids
name: payload
in: body
required: true
schema:
type: array
items:
type: string
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/swaggermodels.ResponsePage'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorInternalServerError'
/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>'
produces:
- application/json
tags:
- Search Pages
summary: List Pages by Project ID
parameters:
- type: string
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
- type: string
description: The _projectid_ of the pages.
name: projectid
in: query
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/swaggermodels.ResponsePage'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/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>'
produces:
- application/json
tags:
- Search Pages
summary: Get Search Page
parameters:
- type: string
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
- 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
responses:
'200':
description: OK
schema:
$ref: '#/definitions/swaggermodels.ResponsePage'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/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:
- type: string
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
- 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
- description: The updated search page metadata.
name: payload
in: body
required: true
schema:
$ref: '#/definitions/swaggermodels.RequestUpdatePageMetadata'
responses:
'204':
description: The search page was successfully updated.
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorInternalServerError'
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:
- type: string
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
- 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
responses:
'204':
description: The search page was successfully deleted
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/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>'
produces:
- application/json
tags:
- Search Pages
summary: Get Search Page Header
parameters:
- type: string
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
- 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
responses:
'200':
description: OK
schema:
$ref: '#/definitions/swaggermodels.PageHeaderSharedModel'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/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:
- type: string
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
- type: string
description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
name: pageID
in: path
required: true
- description: The reordered resources.
name: payload
in: body
required: true
schema:
$ref: '#/definitions/swaggermodels.UpdateHeaderResourcesModel'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/swaggermodels.PageHeaderSharedModel'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorInternalServerError'
/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:
- type: string
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
- type: string
description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
name: pageID
in: path
required: true
- description: The CSS resource to append.
name: payload
in: body
required: true
schema:
$ref: '#/definitions/swaggermodels.CSSResourceSharedModel'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/swaggermodels.CSSResourceSharedModel'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorInternalServerError'
/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:
- type: string
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
- type: string
description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
name: pageID
in: path
required: true
- type: string
description: The name identifier of the CSS resource (e.g., 'myresource').
name: resourceName
in: path
required: true
- description: The updated CSS resource.
name: payload
in: body
required: true
schema:
$ref: '#/definitions/swaggermodels.CSSResourceSharedModel'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/swaggermodels.CSSResourceSharedModel'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'404':
description: Not Found
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorNotFound'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorInternalServerError'
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:
- type: string
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
- type: string
description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
name: pageID
in: path
required: true
- type: string
description: The name identifier of the CSS resource (e.g., 'myresource').
name: resourceName
in: path
required: true
responses:
'204':
description: The resource was successfully deleted
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'404':
description: Not Found
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorNotFound'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/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:
- type: string
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
- type: string
description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
name: pageID
in: path
required: true
- description: The JavaScript resource to append.
name: payload
in: body
required: true
schema:
$ref: '#/definitions/swaggermodels.JavaScriptResourceSharedModel'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/swaggermodels.JavaScriptResourceSharedModel'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorInternalServerError'
/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:
- type: string
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
- type: string
description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
name: pageID
in: path
required: true
- type: string
description: The name identifier of the JavaScript resource (e.g., 'myresource').
name: resourceName
in: path
required: true
- description: The updated JavaScript resource.
name: payload
in: body
required: true
schema:
$ref: '#/definitions/swaggermodels.JavaScriptResourceSharedModel'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/swaggermodels.JavaScriptResourceSharedModel'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'404':
description: Not Found
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorNotFound'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorInternalServerError'
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:
- type: string
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
- type: string
description: The unique identifier of the search page (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e').
name: pageID
in: path
required: true
- type: string
description: The name identifier of the JavaScript resource (e.g., 'myresource').
name: resourceName
in: path
required: true
responses:
'204':
description: The resource was successfully deleted
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'404':
description: Not Found
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorNotFound'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/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:
- type: string
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
- 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
responses:
'200':
description: OK
schema:
$ref: '#/definitions/swaggermodels.ResponseSearchUIUpgradeInfo'
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorInternalServerError'
put:
security:
- OAuth2:
- full
description: 'Change the JavaScript Search Framework resources associated 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: Change the JavaScript Search Framework Resources
parameters:
- type: string
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
- 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
- type: string
description: The major version identifier of the JavaScript Search Framework version to upgrade the target search page to (e.g., _2_).
name: major
in: query
required: true
- type: string
description: The minor version identifier of the JavaScript Search Framework version to upgrade the target search page to (e.g., _4710_).
name: minor
in: query
required: true
responses:
'204':
description: The search page was successfully updated.
'400':
description: Bad Request
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorBadRequest'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorUnauthorized'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/swaggermodels.ResponseApplicationErrorInternalServerError'
components:
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://platform.cloud.coveo.com/oauth/authorize
tokenUrl: https://platform.cloud.coveo.com/oauth/token
scopes:
full: required
definitions:
swaggermodels.CSSResourceSharedModel:
type: object
properties:
inlineContent:
description: The content of the header "style" tag.
type: string
example: 'body { color: #e0e0e0; background-color: #2a2aa2; }'
name:
description: The identifier of the header "style" tag.
type: string
example: CoveoSearchUI
url:
description: The URL of CSS stylesheet.
type: string
example: https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css
swaggermodels.RequestUpdatePageMetadata:
type: object
properties:
html:
type: string
name:
description: A human-readable unique name for this search page. Can contain up to 50 alphanumeric, underscore, and hyphen characters.
type: string
maxLength: 50
minLength: 1
example: My-Search-Page_name
title:
description: A human-readable HTML title for this search page. Can contain up to 200 characters.
type: string
maxLength: 200
minLength: 1
example: My Search Page title
coveo_com_searchpages_pkg_http_rest_viewroutes_hostedsearchpages.aliasJavaScript:
type: object
properties:
InlineContent:
type: string
Name:
type: string
URL:
type: string
coveo_com_searchpages_pkg_http_rest_viewroutes_hostedsearchpages.aliasCSS:
type: object
properties:
InlineContent:
type: string
Name:
type: string
URL:
type: string
swaggermodels.ResponseApplicationErrorInternalServerError:
type: object
p
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-search-pages-api-openapi.yml