Get live artifacts for a repo

Get the live status of artifacts from a repository across all environments.

Returns a RepoLiveStatusResponse object that includes:

• _embedded.environments: environments that currently have running artifacts from this repo
• _embedded.artifacts: the corresponding artifacts for those environments
• live_artifacts: a flattened view of currently running artifacts, including each artifact’s compliance status, fingerprint, commit SHA, and start timestamp.

Repo names are not unique within an org, so pass id to resolve an exact repo. Otherwise, if multiple repos share the same name across different VCS providers, use the provider parameter to disambiguate; without either, the most recently created match is used.

GET /repos/{org}/live-artifacts/{repo_name}

Get live artifacts for a repo

cURL

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

import requests

url = "https://app.kosli.com/api/v2/repos/{org}/live-artifacts/{repo_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/repos/{org}/live-artifacts/{repo_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/repos/{org}/live-artifacts/{repo_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/repos/{org}/live-artifacts/{repo_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/repos/{org}/live-artifacts/{repo_name}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kosli.com/api/v2/repos/{org}/live-artifacts/{repo_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

{
  "live_artifacts": [
    {
      "environment_id": "<string>",
      "artifact_id": "<string>",
      "artifact_name": "<string>",
      "snapshot_index": 123,
      "started_at": 123,
      "compliance": "<string>",
      "snapshot_timestamp": 123,
      "_links": {}
    }
  ],
  "_links": {},
  "_embedded": {
    "artifacts": [
      {
        "id": "<string>",
        "fingerprint": "<string>",
        "commit_sha": "<string>",
        "commit_url": "<string>",
        "commit_author": "<string>",
        "commit_message": "<string>",
        "commit_timestamp": 123,
        "_links": {}
      }
    ],
    "environments": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "_links": {}
      }
    ]
  }
}

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

Authorizations

Authorization · string · header · required

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

Path Parameters

repo_name · string · required

org · string · required

Query Parameters

provider · enum<string> | null

VCS provider (e.g. github, gitlab, bitbucket, azure-devops, circleci). Required when multiple repos share the same name across providers.

Available options: github, gitlab, bitbucket, bitbucket_cloud, bitbucket_dc, azure-devops, azure_devops_services, azure_devops_server, circleci, git, subversion

id · string | null

The repo's internal id (returned as id in the repo response). If given, this unambiguously identifies the repo and 'provider' is ignored.

Response

200

application/json

Successful Response

live_artifacts · LiveArtifactEntryResponse · object[] · required

Show child attributes

_links · Links · object | null

_embedded · RepoLiveStatusEmbedded · object | null

Show child attributes