Get snapshot

Get a snapshot for an environment. `snapshot_expression` can be specified as follows: - `N`: the Nth snapshot, counting from 1. Negative values count from the latest snapshot i.e. -1 is the latest snapshot. example: 42 - `~N`: the Nth snapshot behind the latest, at the time of the request example: ~5 - `@{YYYY-MM-DDTHH:MM:SS}`: the snapshot at specific moment in time in UTC example: @{2023-10-02T12:00:00} - `@{N.<hours|days|weeks|months>.ago}`: the snapshot at a time relative to the time of the request. N is a positive integer. example: @{2.hours.ago} - `@{now}`: the snapshot at the time of the request example: @{now}

GET /snapshots/{org}/{env_name}/{snapshot_expression}

Get snapshot

cURL

curl --request GET \
  --url https://app.kosli.com/api/v2/snapshots/{org}/{env_name}/{snapshot_expression} \
  --header 'Authorization: Bearer <token>'

200

{
  "index": 123,
  "is_latest": true,
  "artifact_compliance_count": {},
  "timestamp": 123,
  "type": "<string>",
  "compliant": true,
  "html_url": "<string>",
  "artifacts": [
    {}
  ],
  "applied_policies": [
    {}
  ],
  "next_snapshot_timestamp": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

env_name · string · required

snapshot_expression · string · required

org · string · required

Response

200 - application/json

Successful Response

index · integer · required

The index of the snapshot

is_latest · boolean · required

True if this snapshot is the most recent

artifact_compliance_count · Artifact Compliance Count · object · required

The number of compliant and non-compliant artifacts in the snapshot

Show child attributes

timestamp · number · required

The timestamp of the snapshot creation

type · string · required

The type of the environment

compliant · boolean · required

Whether the snapshot is compliant

html_url · string · required

The HTML URL to the snapshot

artifacts · Artifacts · object[] · required

The list of artifacts in the snapshot

applied_policies · Applied Policies · object[] · required

The list of policies applied to this snapshot

next_snapshot_timestamp · number | null

The creation timestamp of the next snapshot if one exists