Skip to main content
GET
/
v2.0
/
snapshots
/
{snapshotId}
Gets a Snapshot
curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/snapshots/{snapshotId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "name": "New Snapshot",
  "description": "Version 1",
  "isPackaged": true,
  "_id": "<string>",
  "hash": "Version 1",
  "createdBy": "<string>",
  "createdAt": 1694518620
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

ā€‹
api_key
string
query
required

Supply the API Key in the Url-Query

ā€‹
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

ā€‹
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

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