API docs by Redocly

Organization API (v1)

Organization Global Configuration

Get all organization global configurations

Authorizations:
oauth2
query Parameters
page
integer <int32>
Default: 0
perPage
integer <int32>
Default: 100

Responses

Get organization global configuration

Privilege required ``` {"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"} ```
Authorizations:
oauth2
path Parameters
organizationId
required
string

Responses

Region Configuration

List region configurations

Lists all available region configurations to access Coveo Cloud.

Authorizations:
oauth2

Responses

Show region configuration

Shows the configuration of a specific region.

Authorizations:
oauth2
path Parameters
region
required
string
Enum: "ca-central-1" "ca-west-1" "us-gov-west-1" "us-gov-east-1" "us-east-1" … 23 more

Responses

Organization Endpoints Monitoring

Get the customer endpoint usage status for an organization.

Privilege required ``` {"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"} ```
Authorizations:
oauth2
path Parameters
organizationId
required
string
query Parameters
numberOfDaysToInclude
integer <int32>
Default: 7

Responses

Get the endpoints usage for an organization.

Privilege required ``` {"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"} ```
Authorizations:
oauth2
path Parameters
organizationId
required
string
query Parameters
numberOfDaysToInclude
integer <int32>
Default: 7

Responses

Get usage per region for an organization.

Privilege required ``` {"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"} ```
Authorizations:
oauth2
path Parameters
organizationId
required
string
query Parameters
numberOfDaysToInclude
integer <int32>
Default: 7

Responses

Organizations

List organizations

Lists all organizations you have access to.

Authorizations:
oauth2
query Parameters
additionalFields
Array of strings

A line-separated list of additional fields to include.
Example: license
status

filter
string

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.

order
string
Default: "asc"

The sortBy order to list the organizations in.
Allowed values:
- ASC: Ascending order.
- DESC: Descending order.
Example: DESC
Default: ASC

page
integer <int32>
Default: 0

The 0-based index number of the page to list.
Example: 5
Default: 0

perPage
integer <int32>
Default: 100

The maximum number of organizations to list per page.
Example: 50
Default: 100

sortBy
string
Default: "displayName"

The field to sort the returned organizations by.
Example: createdDate
Default: displayName

type
string

The type of organization to include in the returned list.
Example: Test
By default, organizations of all types may be included in the response.

Responses

Create organization

Creates an organization.

Authorizations:
oauth2
query Parameters
name
required
string

The name to assign to the new organization.

organizationTemplate
string
Default: ""
Example: organizationTemplate=TRIAL

The name of the template to base the new organization on.

owner
string
Default: ""

The email of the owner to assign to the new organization.

Responses

Delete organization

Delete an organization.

Delete an organization
Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses

Show organization

Shows an organization.

Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

query Parameters
additionalFields
Array of strings

A line-separated list of additional fields to include.
Example: license
status

Responses

Update organization

Updates an organization.

Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required

The JSON configuration to update the target organization to.

displayName
string <= 255 characters

The display name of the organization.

object (OrganizationOwnerModel_Request)

The owner of the organization.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "owner": {
    }
}

Allow or disallow serving experiments on the organization. It is allowed by default.

Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

query Parameters
allowed
required
boolean

Whether serving experiments are allowed

Responses

Provision organization

Launches the provisioning of an organization.

Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses

Resume organization

Resumes a paused organization.

Resume a paused organization
Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses

Show organization status

Shows the status of an organization.

Organization and Coveo Status
Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses