How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coveo Configuration API

The Configuration API from Coveo — 5 operation(s) for configuration.

Coveo Configuration API is one of 152 APIs that Coveo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 34 JSON Schema definitions.

Tagged areas include Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 11 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://platform.cloud.coveo.com.

11 operations 5 paths 7 schemas 1 DELETE5 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Contact
support@coveo.com
Terms of Service
Resource Areas
1

Authentication & Security 1

Coveo Configuration API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

  • oauth2 — This API uses OAuth 2 with the implicit grant flow

Paths & Operations 11

Across 5 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Configuration 11
GET
/rest/organizations/{organizationId}/searchinterfaces
List Search Interface Configurations
get-all-interface-config 5 params → 200
POST
/rest/organizations/{organizationId}/searchinterfaces
Create Search Interface Configuration
create-interface-config 1 param body → 200
GET
/rest/organizations/{organizationId}/searchinterfaces/projects/interfaces
List Search Interface Configurations in a Project
get-project-interface-config 6 params → 200
GET
/rest/organizations/{organizationId}/searchinterfaces/{interfaceId}
Show Search Interface Configuration
get-interface-config 2 params → 200404
PUT
/rest/organizations/{organizationId}/searchinterfaces/{interfaceId}
Update Search Interface Configuration
update-interface-config 2 params body → 200404
DELETE
/rest/organizations/{organizationId}/searchinterfaces/{interfaceId}
Delete Search Interface Configuration
delete-interface-config 2 params → 204404
GET
/rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/accesses
List Search Interface Accesses
get-interface-access 2 params → 200404
PUT
/rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/accesses
Update Search Interface Accesses
update-interface-access 2 params body → 200404
GET
/rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/accesses/users
List Search Interface User Accesses
get-interface-user-access 2 params → 200404
PUT
/rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/accesses/users
Update Search Interface User Accesses
update-interface-user-access 2 params body → 200404
POST
/rest/organizations/{organizationId}/searchinterfaces/{interfaceId}/accesses/users
Add Search Interface User Accesses
add-interface-user-access 3 params body → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are interface-config-id (10 properties), interface-config (7 properties), interface-access (4 properties), interface-content (2 properties). Each schema is shown below with its type and property counts.

interface-config
object
7 properties 1 required
interface-add-user
object
2 properties
interface-content
object
2 properties
interface-user-list
array
The list of users that are allowed to access the search interface.
interface-config-id
object
10 properties 2 required
interface-pipeline-content
object
1 property
interface-access
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-configuration-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
Coveo Administration API - Version 15 API
Coveo Advanced Model Configurations API
Coveo Agent Configuration API API
Coveo Agent Orchestration API API
Coveo Analysis V3 API
Coveo Analytics API - Version 14 API
Coveo Analytics API - Version 15 API
Coveo Answer API
Coveo Api Keys API
Coveo Atlassian Connect App API
Coveo Badges API
Where this information came from

This is an independent, third-party profile of Coveo Configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.