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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Coveo

Coveo Snapshot API

The Snapshot API from Coveo — 10 operation(s) for snapshot.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

12 operations 10 paths 15 schemas 1 DELETE5 GET3 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
Coveo
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Coveo Snapshot 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 12

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

Snapshot 12
PUT
/rest/organizations/{organizationId}/snapshots/{snapshotId}/push
Push Snapshot to Target Organization
pushSnapshot 4 params → 204
PUT
/rest/organizations/{organizationId}/snapshots/{snapshotId}/dryrun
Validate Snapshot
dryrun 6 params → 200
PUT
/rest/organizations/{organizationId}/snapshots/{snapshotId}/apply
Apply Snapshot
apply 8 params → 200
GET
/rest/organizations/{organizationId}/snapshots
List Snapshots
getAllSnapshots 5 params → 200
POST
/rest/organizations/{organizationId}/snapshots
Create Snapshot from Configuration
createSnapshot 1 param body → 201
POST
/rest/organizations/{organizationId}/snapshots/self
Create Organization Snapshot
createSnapshotFromSelf 4 params body → 201
POST
/rest/organizations/{organizationId}/snapshots/file
Create Snapshot from File
createSnapshotFromFile 3 params body → 201
GET
/rest/organizations/{organizationId}/snapshots/{snapshotId}
Show Snapshot
getSnapshot 4 params → 200
DELETE
/rest/organizations/{organizationId}/snapshots/{snapshotId}
Delete Snapshot
deleteSnapshot 2 params → 204
GET
/rest/organizations/{organizationId}/snapshots/{snapshotId}/url
Create URL to Retrieve Snapshot Content
generatePresignedUrl 3 params → 200
GET
/rest/organizations/{organizationId}/snapshots/{snapshotId}/diff
Show Snapshot Diff Report
diff 4 params → 200
GET
/rest/organizations/{organizationId}/snapshots/{snapshotId}/content
Retrieve Snapshot Content
getArchivedSnapshotContent 3 params → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ReportResourceOperationsModel (14 properties), ReportModel (11 properties), SnapshotModel (11 properties), SynchronizationReportModel (9 properties). Each schema is shown below with its type and property counts.

DiffGenerationReportModel
object
7 properties
CurrentStage
object
The current stage being executed, with its related progress value.
3 properties
SnapshotModel
object
The snapshot configuration.
11 properties
StreamingResponseBody
object
SnapshotMetadataModel
object
Metadata about the snapshot.
1 property
UrlWithExpirationAndNumberOfLinesModel
object
The generated content patch files, separated by resource type.
3 properties
SnapshotContentModel
object
The snapshot content.
2 properties
SnapshotResourceModel
object
The snapshot of a resource.
3 properties
UrlWithExpirationModel
object
2 properties
ResultInformation
object
For each type of resource, an object containing failure details, if applicable.
2 properties
ReportResourceOperationsModel
object
A summary of the outcome of the link operations.
14 properties
SynchronizationReportLinkOperationsModel
object
A summary of the outcome of the link operations.
3 properties
ReportModel
object
A snapshot event report.
11 properties
SynchronizationReportModel
object
A snapshot synchronization report.
9 properties
ExportConfigurationModel
object
The export configuration model that specifies the resources to include in the snapshot.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-snapshot-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
AE Profile APIs.io
Coveo Administration API - Version 15 API
AE Profile APIs.io
Coveo Advanced Model Configurations API
AE Profile APIs.io
Coveo Agent Configuration API API
AE Profile APIs.io
Coveo Agent Orchestration API API
AE Profile APIs.io
Coveo Analysis V3 API
AE Profile APIs.io
Coveo Analytics API - Version 14 API
AE Profile APIs.io
Coveo Analytics API - Version 15 API
AE Profile APIs.io
Coveo Answer API
AE Profile APIs.io
Coveo Api Keys API
AE Profile APIs.io
Coveo Atlassian Connect App API
AE Profile APIs.io
Coveo Badges API
AE Profile APIs.io
#Snapshot
← Back to C APIs
API Details
ID
coveo:coveo-snapshot-api
Base URL
https://platform.cloud.coveo.com
Docs
https://docs.coveo.com/en/124/
Provider
Coveo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=coveo-snapshot-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/coveo-snapshot-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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