List snapshots

Get list of snapshots for an environment.

GET /snapshots/{org}/{env_name}

List snapshots

cURL

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

import requests

url = "https://app.kosli.com/api/v2/snapshots/{org}/{env_name}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.kosli.com/api/v2/snapshots/{org}/{env_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kosli.com/api/v2/snapshots/{org}/{env_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kosli.com/api/v2/snapshots/{org}/{env_name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.kosli.com/api/v2/snapshots/{org}/{env_name}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kosli.com/api/v2/snapshots/{org}/{env_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "index": 123,
    "from": 123,
    "to": 123,
    "compliant": true,
    "duration": 123
  }
]

{
  "message": "<string>",
  "errors": {}
}

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

org · string · required

Query Parameters

page · integer | null · default: 1

The page number of response

Required range: x >= 1

per_page · integer | null · default: 15

How many results to return per page of response

Required range: x >= 1

interval · string | null · default: 1..NOW

Expression to specify the interval of snapshots to query. Must be two snapshot expressions separated by '..' ie: '5..10', or '~5..NOW

reverse · boolean | null · default: false

Return results in reverse order. Expected values: True or False. Defaults to False.

Response

200

application/json

Successful Response

index · integer · required

from · number · required

to · number · required

compliant · boolean · required

duration · number · required