Gets a Snapshot - Cognigy Documentation

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Headers

enum<string>

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.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

snapshotId

string

required

The Id of the Snapshot

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Response

Returns Snapshot Object

name

string

The name of the Snapshot

Example:

"New Snapshot"

description

string

The description of the Snapshot

Example:

"Version 1"

isPackaged

boolean

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

_id

string

Required string length: 24

Pattern: ^[a-z0-9]{24}$

hash

string

The hash identifying the contents of the Snapshot

Example:

"Version 1"

createdBy

string

Required string length: 24

Pattern: ^[a-z0-9]{24}$

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620