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 Api Keys API

The Api Keys API from Coveo — 10 operation(s) for api keys.

Coveo Api Keys 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 APIKeys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 13 operations across 10 paths, and defines 22 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.

13 operations 10 paths 22 schemas 1 DELETE2 GET3 POST7 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
Terms of Service
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 13

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

Api Keys 13
PUT
/rest/organizations/{organizationId}/apikeys/{sourceApiKeyId}/duplicate
Duplicate API Key
duplicateApiKey 2 params body → 201
GET
/rest/organizations/{organizationId}/apikeys/{apiKeyId}
Show API Key
getApiKey 2 params → 200
PUT
/rest/organizations/{organizationId}/apikeys/{apiKeyId}
Update API Key
updateApiKey 2 params body → 204
DELETE
/rest/organizations/{organizationId}/apikeys/{apiKeyId}
Delete API Key
deleteApiKey 2 params → 204
PUT
/rest/organizations/{organizationId}/apikeys/{apiKeyId}/disable
Disable API Key
disableApiKey 2 params → 204
PUT
/rest/organizations/{organizationId}/apikeys/{apiKeyId}/activation/extend
Extend API Key Activation
extendActivation 2 params → 204
PUT
/rest/organizations/{organizationId}/apikeys/{apiKeyId}/activate
Activate API Key
activateApiKey 2 params → 204
PUT
/rest/organizations/{organizationId}/apikeys/disable/bulk
Disable Multiple API Keys
bulkDisableApiKey 1 param body → 412204
PUT
/rest/organizations/{organizationId}/apikeys/activate/bulk
Activate API Keys
bulkActivateApiKey 1 param body → 412204
GET
/rest/organizations/{organizationId}/apikeys
List API Keys
getApiKeys 2 params → 200
POST
/rest/organizations/{organizationId}/apikeys
Create API Key
createApiKey 2 params body → 201
POST
/rest/organizations/{organizationId}/apikeys/rotate
Rotate API Key
rotateApiKey 1 param body → 200
POST
/rest/organizations/{organizationId}/apikeys/delete/bulk
Delete API Keys
bulkDeleteApiKey 1 param body → 412204

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ApiKeyWithValueResponse (25 properties), ApiKeyResponse (24 properties), UserModel (21 properties), ApiKeyCreationRequest (12 properties). Each schema is shown below with its type and property counts.

ApiKeyAdditionalConfigurationModel
object
The additional configuration to attach to the API key.
3 properties
IdAndDisplayNameModel
object
The unique identifiers of the organizations by which the SAML identity provider is used.
2 properties
RestException
object
3 properties
ApiKeyWithValueResponse
object
An API key with a non-masked value
25 properties
ApiKeyExposureReportReasonResponse
object
Response containing the reason for API key exposure, it contain at least one of the reason or url
5 properties
UserRealmModel
object
The realms the user is a part of.
3 properties
EventModel
object
The user information to send along with usage analytics events.
2 properties
EnforcedQueryPipelineConfigurationModel
object
The query pipeline configuration to enforce on the API key.
1 property
ApiKeyCreationRequest
object
Model for the creation of an API key.
12 properties
RealmModel
object
The realm to add.
4 properties
AnalyticsConfigurationModel
object
The user information to send to Coveo Usage Analytics
1 property
UserModel
object
A user.
21 properties
DuplicatedApiKeyRequest
object
Request model for the duplication of an API key
3 properties
ApiKeyExposureReportResponse
object
An API key Exposure Report
7 properties
ApiKeyResponse
object
An API key with masked value
24 properties
PrivilegeModel
object
The [privilege](https://docs.coveo.com/en/228/) of a resource.
4 properties
ImpersonatedUserModel
object
The security identities to impersonate when authenticating queries with the API key. Note: If specified, the API key must have the IMPERSONATE privilege.
3 properties
CommerceApiKeyConfigurationModel
object
The commerce configuration to enforce on the queries using the API key.
1 property
ImpersonationRestrictionsModel
object
The security identities to impersonate when authenticating queries with the API key.
1 property
SearchApiKeyConfigurationModel
object
The Search API configuration to enforce in the API key.
3 properties
ApiKeyRotationRequest
object
Request Model to rotate an API key
3 properties 1 required
ApiKeyUpdateRequest
object
Model for the creation of an API key.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-api-keys-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 Atlassian Connect App API
Coveo Badges API
Coveo Built-in Groups API
Where this information came from

This is an independent, third-party profile of Coveo Api Keys 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.