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 Vault API

The Vault API from Coveo — 4 operation(s) for vault.

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

This API exposes 7 operations across 4 paths, and defines 5 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.

7 operations 4 paths 5 schemas 1 DELETE3 GET1 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
Terms of Service
Resource Areas
1

Authentication & Security 1

Coveo Vault 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 7

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

Vault 7
GET
/rest/organizations/{organizationId}/vaultentries/{key}
Get a Single Vault Entry
getVaultEntry 2 params → 200
PUT
/rest/organizations/{organizationId}/vaultentries/{key}
Update a Vault Entry
updateVaultEntry 2 params body → 200
DELETE
/rest/organizations/{organizationId}/vaultentries/{key}
Delete a Vault Entry
deleteVaultEntry 2 params → 204
PUT
/rest/organizations/{organizationId}/vaultentries/fetch
Fetches Vault Entries Referenced in a Specific Snapshot from a Given Organization
fetchVaultEntries 4 params → 204
GET
/rest/organizations/{organizationId}/vaultentries
Get All Vault Entries for an Organization
getAllVaultEntries 3 params → 200
POST
/rest/organizations/{organizationId}/vaultentries
Create a Vault Entry
createVaultEntry 1 param body → 201
GET
/rest/organizations/{organizationId}/vaultentries/missing
Retrieve State of Vault Entries for Specified Snapshot
getSnapshotVaultEntryState 2 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are VaultEntryModel (8 properties), AttributeReferenceModel (3 properties), PageModelVaultEntryModel (3 properties), ScopeModel (2 properties). Each schema is shown below with its type and property counts.

ScopeModel
object
2 properties
SnapshotVaultEntryState
object
1 property
PageModelVaultEntryModel
object
3 properties
AttributeReferenceModel
object
3 properties
VaultEntryModel
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-vault-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 Vault 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.