openapi: 3.0.1
info:
title: Coveo Platform 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}:
get:
tags:
- Organizations
summary: Show Organization
description: 'Shows an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getOrganization
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: additionalFields
in: query
description: A line-separated list of additional fields to include.</br>**Example:** `license`</br>`status`
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/OrganizationModel_Response'
x-pretty-name: getOrganization
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId_get
put:
tags:
- Organizations
summary: Update Organization
description: 'Updates an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateOrganization
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
requestBody:
description: The JSON configuration to update the target organization to.
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationModel_Request'
required: true
responses:
'204':
description: No Content
x-pretty-name: updateOrganization
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId_put
delete:
tags:
- Organizations
summary: Delete Organization
description: 'Delete an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"EDIT","targetId":"*"}
```
</details>'
externalDocs:
description: Delete an organization
url: https://docs.coveo.com/en/22/
operationId: deleteOrganization
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: deleteOrganization
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId_delete
/rest/organizations/{organizationId}/crawlingmodule/{crawlingModuleId}:
put:
tags:
- Crawling Module
summary: Report Crawling Module Deployment
description: 'Reports a crawling module deployment in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).</br>**Required
privilege:** On-Premise Administration - Edit or Crawling Module - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ON_PREMISE_ADMINISTRATION","type":"EDIT","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"CRAWLING_MODULE","type":"EDIT","targetId":"*"}
```
</details>'
operationId: reportCrawlingModule
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: crawlingModuleId
in: path
description: 'The unique identifier of the target crawling module.</br>**Example:** mycoveocloudv2organization76kcam-1e7c13e2-afe7-4510-bd00-cd5fd8ba9b0d
'
required: true
schema:
type: string
requestBody:
description: The JSON configuration of the crawling module.
content:
application/json:
schema:
$ref: '#/components/schemas/ReportCrawlingModuleModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CrawlingModuleModel'
x-pretty-name: reportCrawlingModule
x-required-privilege:
owner: PLATFORM
targetDomain: ON_PREMISE_ADMINISTRATION
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ON_PREMISE_ADMINISTRATION
type: EDIT
targetId: '*'
- owner: PLATFORM
targetDomain: CRAWLING_MODULE
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/crawlingmodule/paramId_put
delete:
tags:
- Crawling Module
summary: Remove a Crawling Module Deployment
description: 'Remove an inactive Crawling Module Deployment</br>**Required privilege:** On-Premise Administration -
Edit or Crawling Module - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ON_PREMISE_ADMINISTRATION","type":"EDIT","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"CRAWLING_MODULE","type":"EDIT","targetId":"*"}
```
</details>'
operationId: removeCrawlingModule
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: crawlingModuleId
in: path
description: 'The unique identifier of the target crawling module.</br>**Example:** mycoveocloudv2organization76kcam-1e7c13e2-afe7-4510-bd00-cd5fd8ba9b0d
'
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: removeCrawlingModule
x-required-privilege:
owner: PLATFORM
targetDomain: ON_PREMISE_ADMINISTRATION
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ON_PREMISE_ADMINISTRATION
type: EDIT
targetId: '*'
- owner: PLATFORM
targetDomain: CRAWLING_MODULE
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/crawlingmodule/paramId_delete
/rest/organizations/{organizationId}/configuration/servingExperiment:
put:
tags:
- Organizations
summary: Allow or Disallow Serving Experiments on the Organization. It Is Allowed by Default.
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"EDIT","targetId":"*"}
```
</details>'
operationId: setServingExperiment
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: allowed
in: query
description: Whether serving experiments are allowed
required: true
schema:
type: boolean
responses:
'204':
description: No Content
x-pretty-name: setServingExperiment
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/configuration/servingExperiment_put
/rest/crawlingmodule/upgradechannels/{upgradeChannel}/version/{version}:
put:
tags:
- Crawling Module
summary: Sets the Crawling Module Version for an Upgrade Channel
operationId: setCrawlingModuleUpgradeChannelVersion
parameters:
- name: upgradeChannel
in: path
required: true
schema:
type: string
enum:
- INTERNAL
- LATEST
- STABLE
- name: version
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
x-pretty-name: setCrawlingModuleUpgradeChannelVersion
x-ui-operation-id: /rest/crawlingmodule/upgradechannels/paramId/version/paramId_put
/rest/organizations:
get:
tags:
- Organizations
summary: List Organizations
description: Lists all [organizations](https://docs.coveo.com/en/185/) you have access to.
operationId: getOrganizations
parameters:
- name: additionalFields
in: query
description: A line-separated list of additional fields to include.</br>**Example:** `license`</br>`status`
required: false
schema:
type: array
items:
type: string
- name: filter
in: query
description: The free-form string to filter the returned list based on the values of the organization attributes.
Using spaces is not recommended as it will prevent correct filtering.
required: false
schema:
type: string
- name: type
in: query
description: The type of organization to include in the returned list.</br>**Example:** `Test`</br>By default, organizations
of all types may be included in the response.
required: false
schema:
type: string
- name: sortBy
in: query
description: The field to sort the returned organizations by.</br>**Example:** `createdDate`</br>**Default:** `displayName`
required: false
schema:
type: string
default: displayName
- name: order
in: query
description: 'The `sortBy` order to list the organizations in.</br>**Allowed values:**</br> - `ASC`: Ascending order.</br>-
`DESC`: Descending order. </br>**Example:** `DESC`</br>**Default:** `ASC`'
required: false
schema:
type: string
default: asc
- name: page
in: query
description: The 0-based index number of the page to list.</br>**Example:** `5`</br>**Default:** `0`
required: false
schema:
type: integer
format: int32
default: 0
- name: perPage
in: query
description: The maximum number of organizations to list per page.</br>**Example:** `50`</br>**Default:** `100`
required: false
schema:
type: integer
format: int32
default: 100
- name: productTypes
in: query
description: The license product types to filter the returned list by.
required: false
schema:
type: array
items:
type: string
enum:
- INTERNAL
- SALES
- ALLIANCE
- SANDBOX
- STANDARD
- TRIAL
- TEST
- name: accountId
in: query
description: The license accountId to filter the returned list by.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PageModelOrganizationModel_Response'
x-pretty-name: getOrganizations
x-ui-operation-id: /rest/organizations_get
post:
tags:
- Organizations
summary: Create Organization
description: Creates an [organization](https://docs.coveo.com/en/185/).
operationId: createOrganization
parameters:
- name: name
in: query
description: The name to assign to the new organization.
required: true
schema:
type: string
- name: owner
in: query
description: The email of the owner to assign to the new organization.
required: false
schema:
type: string
default: ''
- name: organizationTemplate
in: query
description: The name of the template to base the new organization on.
required: false
schema:
type: string
default: ''
example: TRIAL
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/OrganizationCreatedModel'
x-pretty-name: createOrganization
x-ui-operation-id: /rest/organizations_post
/rest/organizations/{organizationId}/resume:
post:
tags:
- Organizations
summary: Resume Organization
description: 'Resumes a paused [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
```
</details>'
externalDocs:
description: About inactive organizations
url: https://docs.coveo.com/en/2959#about-inactive-organizations
operationId: resumeOrganization
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ValueModelBoolean'
x-pretty-name: resumeOrganization
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/resume_post
/rest/organizations/{organizationId}/limits/reset/{sectionName}/{limitKey}:
post:
tags:
- Limits
summary: Manually Reset Limit Statuses for a Specific Section and Limit Key
description: 'Admin operation to manually trigger the reset job for a specific limit. This only resets LimitStatus last
updated before today. '
operationId: resetExpiredLimitStatuses
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sectionName
in: path
description: The name of the target license section.</br>**Example:** `content`
required: true
schema:
type: string
- name: limitKey
in: path
description: The unique identifier of the target [limit](https://docs.coveo.com/en/262/) status to show.<br>**Example:**`pushApiMaximumDailyDocumentLimit`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: resetExpiredLimitStatuses
x-ui-operation-id: /rest/organizations/paramId/limits/reset/paramId/paramId_post
/rest/organizations/{organizationId}/launchprovisioning:
post:
tags:
- Organizations
summary: Provision Organization
description: 'Launches the provisioning of an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"EDIT","targetId":"*"}
```
</details>'
operationId: launchProvisioning
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: launchProvisioning
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/launchprovisioning_post
/rest/organizations/{organizationId}/crawlingmodule:
get:
tags:
- Crawling Module
summary: List Crawling Modules
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ON_PREMISE_ADMINISTRATION","type":"VIEW","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"CRAWLING_MODULE","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getCrawlingModulesForOrganization
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/CrawlingModuleModel'
x-pretty-name: getCrawlingModulesForOrganization
x-required-privilege:
owner: PLATFORM
targetDomain: ON_PREMISE_ADMINISTRATION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ON_PREMISE_ADMINISTRATION
type: VIEW
targetId: '*'
- owner: PLATFORM
targetDomain: CRAWLING_MODULE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/crawlingmodule_get
post:
tags:
- Crawling Module
summary: List Crawling Modules by Ids
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ON_PREMISE_ADMINISTRATION","type":"VIEW","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"CRAWLING_MODULE","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getCrawlingModulesByIdsForOrganization
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/CrawlingModuleModel'
x-pretty-name: getCrawlingModulesByIdsForOrganization
x-required-privilege:
owner: PLATFORM
targetDomain: ON_PREMISE_ADMINISTRATION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ON_PREMISE_ADMINISTRATION
type: VIEW
targetId: '*'
- owner: PLATFORM
targetDomain: CRAWLING_MODULE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/crawlingmodule_post
/rest/organizations/{organizationId}/status:
get:
tags:
- Organizations
summary: Show Organization Status
description: 'Shows the status of an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
```
</details>'
externalDocs:
description: About Coveo system issue notifications
url: https://docs.coveo.com/en/1684/
operationId: getOrganizationStatus
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/OrganizationStatusModel'
x-pretty-name: getOrganizationStatus
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/status_get
/rest/organizations/{organizationId}/limits:
get:
tags:
- Limits
summary: Show Organization Limits and Their Statuses
description: 'Shows an [organization''s](https://docs.coveo.com/en/185/) [limits](https://docs.coveo.com/en/262/) and
their statuses.<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
```
</details>'
externalDocs:
description: Get the Organization Limit Status
url: https://docs.coveo.com/en/165/
operationId: getOrganizationLimits
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: limitType
in: query
description: The type of limit you are wishing to retrieve.
required: false
schema:
type: string
enum:
- TECHNICAL
- USAGE
- ENTITLEMENT
default: USAGE
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
additionalProperties:
type: object
additionalProperties:
$ref: '#/components/schemas/LimitStatusModel'
x-pretty-name: getOrganizationLimitsByType
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/limits_get
/rest/organizations/{organizationId}/limits/{sectionName}:
get:
tags:
- Limits
summary: List Section Limits and Their Statuses
description: 'Shows [limits](https://docs.coveo.com/en/262/) and their statuses for a specified license section of an
[organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getSectionLimits
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sectionName
in: path
description: The name of the target license section.</br>**Example:** `content`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/LimitStatusModel'
x-pretty-name: getSectionLimits
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/limits/paramId_get
/rest/organizations/{organizationId}/limits/{sectionName}/{limitKey}:
get:
tags:
- Limits
summary: Show Specific Limit Status
description: 'Shows the status of a specific [limit](https://docs.coveo.com/en/262/) in an [organization](https://docs.coveo.com/en/185/).<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
```
</details>'
externalDocs:
description: Review your license and usage
url: https://docs.coveo.com/en/q2ik0227/manage-an-organization/review-your-license-and-usage
operationId: getLimit
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sectionName
in: path
description: The name of the target license section.</br>**Example:** `content`
required: true
schema:
type: string
- name: limitKey
in: path
description: The unique identifier of the target [limit](https://docs.coveo.com/en/262/) status to show.<br>**Example:**`pushApiMaximumDailyDocumentLimit`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/LimitStatusModel'
x-pretty-name: getLimit
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/limits/paramId/paramId_get
/rest/organizations/{organizationId}/limits/{sectionName}/{limitKey}/history:
get:
tags:
- Limits
summary: Show Limit History
description: 'Shows the history of a specific [limit](https://docs.coveo.com/en/262/) for a given date range.<br /><br
/><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getLimitHistory
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sectionName
in: path
description: The name of the target license section.</br>**Example:** `content`
required: true
schema:
type: string
- name: limitKey
in: path
description: The unique identifier of the target [limit](https://docs.coveo.com/en/262/) status to show.<br>**Example:**`pushApiMaximumDailyDocumentLimit`
required: true
schema:
type: string
- name: from
in: query
description: The beginning of the date range for which to show limit history in [ISO 8601](https://www.w3.org/TR/NOTE-datetime)
format.</br>**Example:**`2022-05-08T01:30:00.000-05:00`
required: false
schema:
type: string
format: date-time
- name: to
in: query
description: The ending of the date range for which to show limit history in [ISO 8601](https://www.w3.org/TR/NOTE-datetime)
format.</br>**Example:**`2022-05-10T01:30:00.000-05:00`
required: false
schema:
type: string
format: date-time
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/LimitHistoryDataPointModel'
x-pretty-name: getLimitHistory
x-required-privilege:
owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: ORGANIZATION
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/limits/paramId/paramId/history_get
/rest/organizations/{organizationId}/license:
get:
tags:
- License
summary: Show Organization License
description: 'Get the license of an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).<br /><br
/><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
```
</details>'
externalDocs:
description: Get the Organization License Information
url: https://docs.coveo.com/en/77/
operationId: getLicense
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/LicenseModel'
x-pretty-name: getLicen
# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-platform-openapi-original.yml