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 IPX Configuration API

The IPX Configuration API from Coveo — 12 operation(s) for ipx configuration.

Coveo IPX 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 IPX 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 15 operations across 12 paths, and defines 12 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.

15 operations 12 paths 12 schemas 1 DELETE9 GET3 POST2 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 IPX 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 15

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

IPX Configuration 15
GET
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces
List All IPX Interface Configurations
get-all-ipx-interface-configs 5 params → 200
POST
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces
Create IPX Interface Configuration
create-ipx-interface-config 2 params body → 201
GET
/rest/organizations/{organizationId}/ipxinterface/v1/projects/interfaces
List IPX Interface Configurations in Project
get-project-ipx-interface-configs 6 params → 200
GET
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}
Show IPX Interface Configuration
get-ipx-interface-config 2 params → 200404
PUT
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}
Update IPX Interface Configuration
update-ipx-interface-config 2 params body → 200404
DELETE
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}
Delete IPX Interface Configuration
delete-ipx-interface-config 2 params → 204404
GET
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions
Get Versions for an IPX Interface
get-ipx-interface-versions 6 params → 200
GET
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}
Get an IPX Interface Version
get-ipx-interface-version 3 params → 200
POST
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/restore
Restore an IPX Interface Version
restore-ipx-interface-version 3 params body → 200
PUT
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/versions/{versionNumber}/label
Update an IPX Interface Version Label
update-ipx-interface-version-label 3 params body → 200
POST
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/preview
Preview IPX Interface
preview-ipx-interface 2 params body → 200404401
GET
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/edit
Get IPX Interface Builder
get-ipx-interface-edit 2 params → 200404
GET
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/login
Get IPX Interface Login
get-ipx-interface-login 1 param → 200404
GET
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/token
Get IPX Interface Search Token
get-ipx-interface-token 1 param → 200404
GET
/rest/organizations/{organizationId}/ipxinterface/v1/interfaces/{interfaceId}/pipelines
Get IPX Interface Pipelines
get-ipx-interface-pipelines 2 params → 200404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ipx-interface-config-id (15 properties), ipx-interface-config (9 properties), InterfaceVersionInfo (6 properties), associated-pipeline (5 properties). Each schema is shown below with its type and property counts.

pipelines-status
array
A list containing the pipeline(s) used by the interface.
InterfaceVersionInfoPage
associated-pipeline
object
The associated pipeline.
5 properties
ChangeInfo
object
4 properties
InterfaceVersionInfo
object
6 properties
pipeline-status
object
The status of a pipeline.
5 properties
UpdatedChangeInfo
CreatedChangeInfo
ipx-interface-config
object
9 properties 1 required
VersionLabelParams
object
1 property
Page
object
2 properties
ipx-interface-config-id
object
15 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-ipx-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 IPX 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.