List trails for organization

Get a paginated list of trails for an organization based on filters provided as query parameters.

GET /trails/{org}

List trails for organization

cURL

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

import requests

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

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/trails/{org}', 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/trails/{org}",
  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/trails/{org}"

	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/trails/{org}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "data": [
    {
      "name": "<string>",
      "last_modified_at": 123,
      "created_at": 123,
      "compliance_status": {
        "is_compliant": true,
        "attestations_statuses": [
          {
            "attestation_name": "<string>",
            "attestation_type": "<string>",
            "attestation_id": "<string>",
            "overridden_attestation_id": "<string>",
            "is_compliant": true,
            "unexpected": false
          }
        ],
        "artifacts_statuses": {},
        "evaluated_at": 123,
        "flow_template_id": "<string>"
      },
      "template": {
        "trail": {
          "attestations": [
            {
              "name": "<string>",
              "type": "<string>"
            }
          ],
          "artifacts": [
            {
              "name": "<string>",
              "attestations": [
                {
                  "name": "<string>",
                  "type": "<string>"
                }
              ]
            }
          ]
        },
        "version": 1,
        "content": "<string>"
      },
      "is_compliant": true,
      "created_by": "<string>",
      "flow": {
        "name": "<string>",
        "tags": {}
      },
      "html_url": "<string>",
      "description": "<string>",
      "git_commit_info": {
        "sha1": "<string>",
        "message": "<string>",
        "author": "<string>",
        "branch": "<string>",
        "timestamp": 123,
        "url": "<string>"
      },
      "origin_url": "<string>",
      "user_data": {},
      "repo_ids": [
        "<string>"
      ],
      "events": [
        {}
      ],
      "external_urls": {}
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "per_page": 123,
    "page_count": 123
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

org · string · required

Query Parameters

flow · string | null

The name of the flow to filter trails by

flow_tag · string | null

Filter trails by flows that have this tag (format: key=value, e.g., team=backend)

fingerprint · string | null

The fingerprint of the artifact reported to the trail or trails

page · integer | null · default: 1

The page number of response

Required range: x >= 1

per_page · integer | null · default: 20

How many results to return per page of response

Required range: 1 <= x <= 100

Response

200 - application/json

Successful Response

Response model for listing Trails with pagination.

When pagination is not requested, returns a list of trails directly. When pagination is requested, returns data with optional pagination info.

data · ListTrailItem · object[] · required

List of trails

Show child attributes

pagination · ListTrailsPagination · object | null

Pagination info (only present when there are multiple pages)

Show child attributes