v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Snapshots

Gets a Snapshot

Gets information about a Snapshot in a Project.

get/v2.0/snapshots/{snapshotId}

Path parameters

snapshotIdstring required

The unique identifier for the Snapshot.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

Snapshot object retrieved.

namestring

The name of the Snapshot

descriptionstring

The description of the Snapshot

isPackagedboolean

Whether the Snapshot has already been packaged and is ready for download

_idstring

hashstring

The hash identifying the contents of the Snapshot

createdBystring

createdAtinteger

Unix-timestamp

Example response

{
  "name": "New Snapshot",
  "description": "Version 1",
  "hash": "Version 1",
  "createdAt": 1694518620
}