openapi: 3.0.1
info:
title: Coveo Migration 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
paths:
/rest/organizations/{organizationId}/vaultentries/{key}:
get:
tags:
- Vault
summary: Get a Single Vault Entry
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"VAULT_ENTRY","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getVaultEntry
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: key
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/VaultEntryModel'
x-pretty-name: getVaultEntry
x-required-privilege:
owner: PLATFORM
targetDomain: VAULT_ENTRY
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: VAULT_ENTRY
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/vaultentries/paramId_get
put:
tags:
- Vault
summary: Update a Vault Entry
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"VAULT_ENTRY","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateVaultEntry
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: key
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VaultEntryModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/VaultEntryModel'
x-pretty-name: updateVaultEntry
x-required-privilege:
owner: PLATFORM
targetDomain: VAULT_ENTRY
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: VAULT_ENTRY
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/vaultentries/paramId_put
delete:
tags:
- Vault
summary: Delete a Vault Entry
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"VAULT_ENTRY","type":"EDIT","targetId":"*"}
```
</details>'
operationId: deleteVaultEntry
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: key
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: deleteVaultEntry
x-required-privilege:
owner: PLATFORM
targetDomain: VAULT_ENTRY
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: VAULT_ENTRY
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/vaultentries/paramId_delete
/rest/organizations/{organizationId}/vaultentries/fetch:
put:
tags:
- Vault
summary: Fetches Vault Entries Referenced in a Specific Snapshot from a Given Organization
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"VAULT_ENTRY","type":"EDIT","targetId":"*"}
```
</details>'
operationId: fetchVaultEntries
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: referenceSnapshotId
in: query
required: true
schema:
type: string
- name: sourceOrganizationId
in: query
required: true
schema:
type: string
- name: fetchStrategy
in: query
required: false
schema:
type: string
enum:
- ALL_OR_NOTHING
- OVERWRITE
- ONLY_MISSING
default: ALL_OR_NOTHING
responses:
'204':
description: No Content
x-pretty-name: fetchVaultEntries
x-required-privilege:
owner: PLATFORM
targetDomain: VAULT_ENTRY
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: VAULT_ENTRY
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/vaultentries/fetch_put
/rest/organizations/{organizationId}/snapshots/{snapshotId}/synchronization/{synchronizationPlanId}:
get:
tags:
- Snapshot Synchronization
summary: Show Synchronization Plan
description: 'Shows a snapshot synchronization plan.</br>**Required privileges:**<br/> - `Snapshot - View`<br/> - `Link
- View`<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SNAPSHOTS","type":"VIEW","targetId":"*"}
AND
{"owner":"PLATFORM","targetDomain":"LINK","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getSynchronizationPlan
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `destinationorganizationg7dg3gd`
required: true
schema:
type: string
- name: snapshotId
in: path
description: The unique identifier of the target snapshot.<br/>**Example:** `destinationorganization-xzgbf5rdaiqtaznvh74zdwcedi`
required: true
schema:
type: string
- name: synchronizationPlanId
in: path
description: The unique identifier of the target synchronization plan.<br/>**Example:** `destinationorganizationg7dg3gd-spnyvuywz6nbnqgujuwtlq2d7e`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SynchronizationPlanModel'
x-pretty-name: getSynchronizationPlan
x-required-privilege:
owner: PLATFORM
targetDomain: SNAPSHOTS
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SNAPSHOTS
type: VIEW
targetId: '*'
- owner: PLATFORM
targetDomain: LINK
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/snapshots/paramId/synchronization/paramId_get
put:
tags:
- Snapshot Synchronization
summary: Update Synchronization Plan
description: 'Updates a snapshot synchronization plan.</br>**Required privileges:**<br/> - `Snapshot - Edit`<br/> -
`Link - View`<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SNAPSHOTS","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateSynchronizationPlan
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `destinationorganizationg7dg3gd`
required: true
schema:
type: string
- name: snapshotId
in: path
description: The unique identifier of the target snapshot.<br/>**Example:** `destinationorganization-xzgbf5rdaiqtaznvh74zdwcedi`
required: true
schema:
type: string
- name: synchronizationPlanId
in: path
description: The unique identifier of the target synchronization plan.<br/>**Example:** `destinationorganizationg7dg3gd-spnyvuywz6nbnqgujuwtlq2d7e`
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SynchronizationPlanModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SynchronizationPlanModel'
x-pretty-name: updateSynchronizationPlan
x-required-privilege:
owner: PLATFORM
targetDomain: SNAPSHOTS
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SNAPSHOTS
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/snapshots/paramId/synchronization/paramId_put
/rest/organizations/{organizationId}/snapshots/{snapshotId}/synchronization/{synchronizationPlanId}/children:
put:
tags:
- Snapshot Synchronization
summary: Update Synchronization Plan Children
description: 'Updates child resource associations in a synchronization plan given a target parent association.</br>**Required
privileges:**<br/> - `Snapshot - Edit`<br/> - `Link - View`<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SNAPSHOTS","type":"VIEW","targetId":"*"}
AND
{"owner":"PLATFORM","targetDomain":"LINK","type":"VIEW","targetId":"*"}
```
</details>'
operationId: computeChildrenOperations
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `destinationorganizationg7dg3gd`
required: true
schema:
type: string
- name: snapshotId
in: path
description: The unique identifier of the target snapshot.<br/>**Example:** `destinationorganization-xzgbf5rdaiqtaznvh74zdwcedi`
required: true
schema:
type: string
- name: synchronizationPlanId
in: path
description: The unique identifier of the target synchronization plan.<br/>**Example:** `destinationorganizationg7dg3gd-spnyvuywz6nbnqgujuwtlq2d7e`
required: true
schema:
type: string
- name: parentResourceType
in: query
description: The `resourceType` of the parent resource.<br/>**Example:** `QUERY_PIPELINE`
required: true
schema:
type: string
enum:
- CATALOG_CONFIG
- CATALOG
- EXTENSION
- FIELD
- FILTER
- INSIGHT_PANEL_INTERFACE
- INSIGHT_PANEL_CONFIGURATION
- MAPPING
- ML_MODEL
- ML_MODEL_ASSOCIATION
- QUERY_PARAMETER
- QUERY_PIPELINE
- QUERY_PIPELINE_CONDITION
- RANKING_EXPRESSION
- RANKING_WEIGHT
- RESULT_RANKING
- FEATURED_RESULT
- SEARCH_PAGE
- SECURITY_PROVIDER
- SOURCE
- STATEMENT_GROUP
- SETTING
- STOP_WORD
- STOREFRONT_ASSOCIATION
- SUBSCRIPTION
- THESAURUS
- TRACKING_ID
- TRIGGER
- UNKNOWN
- name: snapshotParentResourceName
in: query
description: The `resourceName` of the parent resource.<br/>**Example:** `my_pipeline_aAePCD`
required: true
schema:
type: string
- name: targetParentId
in: query
description: The unique identifier of the parent resource in the target organization.<br/>**Example:** `destinationorganizationg7dg3gd-qvml6dkyvouchhehsjhxxbkgqq`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SynchronizationPlanModel'
x-pretty-name: computeChildrenOperations
x-required-privilege:
owner: PLATFORM
targetDomain: SNAPSHOTS
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SNAPSHOTS
type: VIEW
targetId: '*'
- owner: PLATFORM
targetDomain: LINK
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/snapshots/paramId/synchronization/paramId/children_put
/rest/organizations/{organizationId}/snapshots/{snapshotId}/synchronization/{synchronizationPlanId}/apply:
put:
tags:
- Snapshot Synchronization
summary: Apply Synchronization Plan
description: 'Applies a snapshot synchronization plan.</br>**Required privileges:**<br/> - `Snapshot - Edit`<br/> -
`Link - Edit`<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SNAPSHOTS","type":"EDIT","targetId":"*"}
AND
{"owner":"PLATFORM","targetDomain":"LINK","type":"EDIT","targetId":"*"}
```
</details>'
operationId: applySynchronizationPlan
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `destinationorganizationg7dg3gd`
required: true
schema:
type: string
- name: snapshotId
in: path
description: The unique identifier of the target snapshot.<br/>**Example:** `destinationorganization-xzgbf5rdaiqtaznvh74zdwcedi`
required: true
schema:
type: string
- name: synchronizationPlanId
in: path
description: The unique identifier of the target synchronization plan.<br/>**Example:** `destinationorganizationg7dg3gd-spnyvuywz6nbnqgujuwtlq2d7e`
required: true
schema:
type: string
- name: overrideExistingLinks
in: query
description: Whether to use the links in the target synchronization plan to override the ones already existing in
the organization if conflicts arise, rather than throwing an error.<br/>**Default:** `false`
required: false
schema:
type: boolean
default: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SynchronizationReportModel'
x-pretty-name: applySynchronizationPlan
x-required-privilege:
owner: PLATFORM
targetDomain: SNAPSHOTS
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SNAPSHOTS
type: EDIT
targetId: '*'
- owner: PLATFORM
targetDomain: LINK
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/snapshots/paramId/synchronization/paramId/apply_put
/rest/organizations/{organizationId}/snapshots/{snapshotId}/push:
put:
tags:
- Snapshot
summary: Push Snapshot to Target Organization
description: 'Pushes a snapshot to an organization.</br>**Required privileges:**<br/>- `Snapshot - Edit` in both organizations.<br/>-
`View` in the original organization on all [domains](https://docs.coveo.com/en/2819/) targeted by the snapshot.<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SNAPSHOTS","type":"EDIT","targetId":"*"}
```
</details>'
operationId: pushSnapshot
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`
required: true
schema:
type: string
- name: snapshotId
in: path
description: The unique identifier of the target snapshot.<br/>**Example:** `startingorganization-xzgbf5rdaiqtaznvh74zdwcedi`
required: true
schema:
type: string
- name: targetOrganizationId
in: query
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/) where to send the snapshot.<br/>**Example:**
`destinationorganizationg7dg3gd`
required: true
schema:
type: string
- name: developerNotes
in: query
description: A note you can attach to your snapshot.<br/>**Example:** `pipeline snapshot`
required: false
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: pushSnapshot
x-required-privilege:
owner: PLATFORM
targetDomain: SNAPSHOTS
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SNAPSHOTS
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/snapshots/paramId/push_put
/rest/organizations/{organizationId}/snapshots/{snapshotId}/dryrun:
put:
tags:
- Snapshot
summary: Validate Snapshot
description: 'Checks the effects of applying a snapshot to an organization.</br>**Required privileges:**<br/> - `Snapshot
- Edit`<br/> - `View` on all domains corresponding to the resources targeted by the snapshot<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"SNAPSHOTS","type":"EDIT","targetId":"*"}
```
</details>'
operationId: dryrun
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`
required: true
schema:
type: string
- name: snapshotId
in: path
description: The unique identifier of the target snapshot.<br/>**Example:** `startingorganization-xzgbf5rdaiqtaznvh74zdwcedi`
required: true
schema:
type: string
- name: deleteMissingResources
in: query
description: Whether to simulate the deletion of organization resources not present in the snapshot.<br/>**Default:**
`false`
required: false
schema:
type: boolean
default: false
- name: deletionScope
in: query
description: '**Note:** only applies when `deleteMissingResources` is set to `true`.<br/>The scope of the resources
on which to calculate deletions.<br/>**Default:** `ONLY_TYPES_FROM_SNAPSHOT`'
required: false
schema:
type: string
enum:
- ALL_MANAGED_RESOURCES
- ONLY_TYPES_FROM_SNAPSHOT
default: ONLY_TYPES_FROM_SNAPSHOT
- name: performAutoSynchronization
in: query
description: Whether to automatically synchronize resources in the snapshot with corresponding organization resources.<br/>**Default:**
`true`
required: false
schema:
type: boolean
default: true
- name: autoSynchronizationThreshold
in: query
description: If autoSynchronization is set to true, this score controls how lenient the pairing of values will be.<br/>The
value should be set to 1.00 or lower. A value of 1 will require an exact match for synchronization of fields.
required: false
schema:
type: number
format: float
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ReportModel'
x-pretty-name: dryrun
x-required-privilege:
owner: PLATFORM
targetDomain: SNAPSHOTS
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SNAPSHOTS
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/snapshots/paramId/dryrun_put
/rest/organizations/{organizationId}/snapshots/{snapshotId}/apply:
put:
tags:
- Snapshot
summary: Apply Snapshot
description: 'Applies a snapshot to an organization.</br>**Required privileges:**<br/> - `Snapshot - Edit`<br/> - `Edit`
on all domains corresponding to the resources targeted by the snapshot<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SNAPSHOTS","type":"EDIT","targetId":"*"}
```
</details>'
operationId: apply
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`
required: true
schema:
type: string
- name: snapshotId
in: path
description: The unique identifier of the target snapshot.<br/>**Example:** `startingorganization-xzgbf5rdaiqtaznvh74zdwcedi`
required: true
schema:
type: string
- name: deleteMissingResources
in: query
description: Whether to delete organization resources not present in the snapshot.<br/>**Default:** `false`
required: false
schema:
type: boolean
default: false
- name: deletionScope
in: query
description: '**Note:** only applies when `deleteMissingResources` is set to `true`.<br/>The scope of the resources
on which to calculate deletions.<br/>**Default:** `ONLY_TYPES_FROM_SNAPSHOT`'
required: false
schema:
type: string
enum:
- ALL_MANAGED_RESOURCES
- ONLY_TYPES_FROM_SNAPSHOT
default: ONLY_TYPES_FROM_SNAPSHOT
- name: isTransient
in: query
description: Whether to delete the snapshot after it has been applied.<br/>**Default:** `false`
required: false
schema:
type: boolean
default: false
- name: validationRequired
in: query
description: Whether to check the effects of applying the snapshot before actually applying it.When this parameter
is set to true, if an operation is found to be invalid during the validation, the service stops and returns an error
report.<br/>**Default:** `false`
required: false
schema:
type: boolean
default: false
- name: performAutoSynchronization
in: query
description: Whether to automatically synchronize resources in the snapshot with corresponding organization resources.<br/>**Default:**
`true`
required: false
schema:
type: boolean
default: true
- name: autoSynchronizationThreshold
in: query
description: If autoSynchronization is set to true, this score controls how lenient the pairing of values will be.<br/>The
value should be set to 1.00 or lower. A value of 1 will require an exact match for synchronization of fields.
required: false
schema:
type: number
format: float
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ReportModel'
x-pretty-name: apply
x-required-privilege:
owner: PLATFORM
targetDomain: SNAPSHOTS
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SNAPSHOTS
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/snapshots/paramId/apply_put
/rest/organizations/{organizationId}/links/{linkId}:
get:
tags:
- Link
summary: Show Link
description: 'Shows a link in an organization.</br>**Required privilege:**` Link - View`<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"LINK","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getLink
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`
required: true
schema:
type: string
- name: linkId
in: path
description: The unique identifier of the target link.<br/>**Example:** `ufacpg3aoi63vxoy6qoyhocfuy`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/LinkModel'
x-pretty-name: getLink
x-required-privilege:
owner: PLATFORM
targetDomain: LINK
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: LINK
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/links/paramId_get
put:
tags:
- Link
summary: Edit Link
description: 'Edits a link in an organization.</br>**Required privilege:**` Link - Edit`<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"LINK","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateLink
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`
required: true
schema:
type: string
- name: linkId
in: path
description: The unique identifier of the target link.<br/>**Example:** `ufacpg3aoi63vxoy6qoyhocfuy`
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LinkModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/LinkModel'
x-pretty-name: updateLink
x-required-privilege:
owner: PLATFORM
targetDomain: LINK
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: LINK
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/links/paramId_put
delete:
tags:
- Link
summary: Delete Link
description: 'Deletes a link in an organization.</br>**Required privilege:**` Link - Edit`<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"LINK","type":"EDIT","targetId":"*"}
```
</details>'
operationId: deleteLink
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`
required: true
schema:
type: string
- name: linkId
in: path
description: The unique identifier of the target link.<br/>**Example:** `ufacpg3aoi63vxoy6qoyhocfuy`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: deleteLink
x-required-privilege:
owner: PLATFORM
targetDomain: LINK
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: LINK
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/links/paramId_delete
/rest/organizations/{organizationId}/links/batch:
put:
tags:
- Link
summary: Edit Links
description: 'Edits a batch of links in an organization.</br>**Required privilege:**` Link - Edit`<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"LINK","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateLinkBatch
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
description: The link definitions.
items:
$ref: '#/components/schemas/LinkModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/LinkModel'
x-pretty-name: updateLinkBatch
x-required-privilege:
owner: PLATFORM
targetDomain: LINK
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: LINK
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/links/batch_put
post:
tags:
- Link
summary: Create Links
description: 'Creates a batch of links in an organization.</br>**Required privilege:**` Link - Edit`<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"LINK","type":"CREATE","targetId":"*"}
```
</details>'
operationId: createLinkBatch
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
description: The link definitions.
items:
$ref: '#/components/schemas/LinkModel'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/LinkModel'
x-pretty-name: createLinkBatch
x-required-privilege:
owner: PLATFORM
targetDomain: LINK
type: CREATE
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: LINK
type: CREATE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/links/batch_post
delete:
tags:
- Link
summary: Delete Links
description: 'Deletes a batch of links in an organization.</br>**Required privilege:**` Link - Edit`<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"LINK","type":"EDIT","targetId":"*"}
```
</details>'
operationId: deleteLinkBatch
parameters:
- name: organizationId
in: path
description: The unique identifier of the [organization](https://docs.coveo.com/en/185/).<br/>**Example:** `startingorganizationg8tp8wu3`
required: true
schema:
type: string
- name: linkIds
in: query
description: The unique identifier of the target links.<br/>To send multiple ids, either concatenate with `,` or send
multiple query parameters.For example, appending `?ids=link1,link2` is equivalent to appending `?ids=link1&ids=link2`.
required: true
schema:
uniqueItems
# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-migration-openapi-original.yml