Get trail

Get a Trail for a Flow in an organization.

GET /trails/{org}/{flow_name}/{trail_name}

Get trail

cURL

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

import requests

url = "https://app.kosli.com/api/v2/trails/{org}/{flow_name}/{trail_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/trails/{org}/{flow_name}/{trail_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/trails/{org}/{flow_name}/{trail_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/trails/{org}/{flow_name}/{trail_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/trails/{org}/{flow_name}/{trail_name}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kosli.com/api/v2/trails/{org}/{flow_name}/{trail_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

{
  "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": {}
}

Authorizations

Authorization · string · header · required

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

Path Parameters

flow_name · string · required

trail_name · string · required

org · string · required

Response

200 - application/json

Successful Response

Response model for getting a Trail.

This represents the full trail data returned by the get_trail endpoint.

name · string · required

Name of the trail

last_modified_at · number · required

Timestamp when the trail was last modified

created_at · number · required

Timestamp when the trail was created

compliance_status · TrailComplianceStatus · object · required

Compliance status of the trail

Show child attributes

template · Template · object · required

Flow template associated with the trail

Show child attributes

compliance_state · enum<string> · required

Overall compliance state of the trail

Available options: INCOMPLETE, COMPLIANT, NON-COMPLIANT

is_compliant · boolean · required

Whether the trail is compliant

created_by · string · required

Display name of the user who created the trail

flow · FlowInfo · object · required

Information about the flow containing this trail

Show child attributes

html_url · string · required

URL of the trail's web page

description · string | null

Description of the trail

git_commit_info · GitCommitInfo · object | null

Git commit information for the trail

Show child attributes

origin_url · string | null

Origin URL where the trail was reported from

user_data · User Data · object any[]

User-defined data attached to the trail

repo_ids · string[]

List of repository IDs associated with the trail

events · Events · object[]

List of events that occurred on the trail

external_urls · External Urls · object | null

External URLs associated with the trail

Show child attributes