Report artifact

Create an artifact for organization.

POST /artifacts/{org}/{flow_name}

Report artifact

cURL

curl --request POST \
  --url https://app.kosli.com/api/v2/artifacts/{org}/{flow_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fingerprint": "<string>",
  "filename": "<string>",
  "build_url": "<string>",
  "commit_url": "<string>",
  "trail_name": "<string>",
  "template_reference_name": "<string>",
  "description": "<string>",
  "git_commit": "<string>",
  "git_commit_info": {
    "sha1": "<string>",
    "message": "<string>",
    "author": "<string>",
    "author_username": "<string>",
    "branch": "<string>",
    "timestamp": 123,
    "url": "<string>",
    "parents": [
      "<string>"
    ],
    "verified": true,
    "signature_state": "<string>"
  },
  "repo_info": {
    "name": "<string>",
    "url": "<string>",
    "id": "<string>",
    "description": "<string>"
  },
  "commits_list": [
    {
      "sha1": "<string>",
      "message": "<string>",
      "author": "<string>",
      "author_username": "<string>",
      "branch": "<string>",
      "timestamp": 123,
      "url": "<string>",
      "parents": [
        "<string>"
      ],
      "verified": true,
      "signature_state": "<string>"
    }
  ],
  "repo_url": "<string>",
  "is_compliant": true,
  "template": "<string>",
  "external_urls": {},
  "annotations": {},
  "user_data": {}
}
'

import requests

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

payload = {
    "fingerprint": "<string>",
    "filename": "<string>",
    "build_url": "<string>",
    "commit_url": "<string>",
    "trail_name": "<string>",
    "template_reference_name": "<string>",
    "description": "<string>",
    "git_commit": "<string>",
    "git_commit_info": {
        "sha1": "<string>",
        "message": "<string>",
        "author": "<string>",
        "author_username": "<string>",
        "branch": "<string>",
        "timestamp": 123,
        "url": "<string>",
        "parents": ["<string>"],
        "verified": True,
        "signature_state": "<string>"
    },
    "repo_info": {
        "name": "<string>",
        "url": "<string>",
        "id": "<string>",
        "description": "<string>"
    },
    "commits_list": [
        {
            "sha1": "<string>",
            "message": "<string>",
            "author": "<string>",
            "author_username": "<string>",
            "branch": "<string>",
            "timestamp": 123,
            "url": "<string>",
            "parents": ["<string>"],
            "verified": True,
            "signature_state": "<string>"
        }
    ],
    "repo_url": "<string>",
    "is_compliant": True,
    "template": "<string>",
    "external_urls": {},
    "annotations": {},
    "user_data": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fingerprint: '<string>',
    filename: '<string>',
    build_url: '<string>',
    commit_url: '<string>',
    trail_name: '<string>',
    template_reference_name: '<string>',
    description: '<string>',
    git_commit: '<string>',
    git_commit_info: {
      sha1: '<string>',
      message: '<string>',
      author: '<string>',
      author_username: '<string>',
      branch: '<string>',
      timestamp: 123,
      url: '<string>',
      parents: ['<string>'],
      verified: true,
      signature_state: '<string>'
    },
    repo_info: {name: '<string>', url: '<string>', id: '<string>', description: '<string>'},
    commits_list: [
      {
        sha1: '<string>',
        message: '<string>',
        author: '<string>',
        author_username: '<string>',
        branch: '<string>',
        timestamp: 123,
        url: '<string>',
        parents: ['<string>'],
        verified: true,
        signature_state: '<string>'
      }
    ],
    repo_url: '<string>',
    is_compliant: true,
    template: '<string>',
    external_urls: {},
    annotations: {},
    user_data: {}
  })
};

fetch('https://app.kosli.com/api/v2/artifacts/{org}/{flow_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/artifacts/{org}/{flow_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fingerprint' => '<string>',
    'filename' => '<string>',
    'build_url' => '<string>',
    'commit_url' => '<string>',
    'trail_name' => '<string>',
    'template_reference_name' => '<string>',
    'description' => '<string>',
    'git_commit' => '<string>',
    'git_commit_info' => [
        'sha1' => '<string>',
        'message' => '<string>',
        'author' => '<string>',
        'author_username' => '<string>',
        'branch' => '<string>',
        'timestamp' => 123,
        'url' => '<string>',
        'parents' => [
                '<string>'
        ],
        'verified' => true,
        'signature_state' => '<string>'
    ],
    'repo_info' => [
        'name' => '<string>',
        'url' => '<string>',
        'id' => '<string>',
        'description' => '<string>'
    ],
    'commits_list' => [
        [
                'sha1' => '<string>',
                'message' => '<string>',
                'author' => '<string>',
                'author_username' => '<string>',
                'branch' => '<string>',
                'timestamp' => 123,
                'url' => '<string>',
                'parents' => [
                                '<string>'
                ],
                'verified' => true,
                'signature_state' => '<string>'
        ]
    ],
    'repo_url' => '<string>',
    'is_compliant' => true,
    'template' => '<string>',
    'external_urls' => [
        
    ],
    'annotations' => [
        
    ],
    'user_data' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"fingerprint\": \"<string>\",\n  \"filename\": \"<string>\",\n  \"build_url\": \"<string>\",\n  \"commit_url\": \"<string>\",\n  \"trail_name\": \"<string>\",\n  \"template_reference_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"git_commit\": \"<string>\",\n  \"git_commit_info\": {\n    \"sha1\": \"<string>\",\n    \"message\": \"<string>\",\n    \"author\": \"<string>\",\n    \"author_username\": \"<string>\",\n    \"branch\": \"<string>\",\n    \"timestamp\": 123,\n    \"url\": \"<string>\",\n    \"parents\": [\n      \"<string>\"\n    ],\n    \"verified\": true,\n    \"signature_state\": \"<string>\"\n  },\n  \"repo_info\": {\n    \"name\": \"<string>\",\n    \"url\": \"<string>\",\n    \"id\": \"<string>\",\n    \"description\": \"<string>\"\n  },\n  \"commits_list\": [\n    {\n      \"sha1\": \"<string>\",\n      \"message\": \"<string>\",\n      \"author\": \"<string>\",\n      \"author_username\": \"<string>\",\n      \"branch\": \"<string>\",\n      \"timestamp\": 123,\n      \"url\": \"<string>\",\n      \"parents\": [\n        \"<string>\"\n      ],\n      \"verified\": true,\n      \"signature_state\": \"<string>\"\n    }\n  ],\n  \"repo_url\": \"<string>\",\n  \"is_compliant\": true,\n  \"template\": \"<string>\",\n  \"external_urls\": {},\n  \"annotations\": {},\n  \"user_data\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.kosli.com/api/v2/artifacts/{org}/{flow_name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fingerprint\": \"<string>\",\n  \"filename\": \"<string>\",\n  \"build_url\": \"<string>\",\n  \"commit_url\": \"<string>\",\n  \"trail_name\": \"<string>\",\n  \"template_reference_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"git_commit\": \"<string>\",\n  \"git_commit_info\": {\n    \"sha1\": \"<string>\",\n    \"message\": \"<string>\",\n    \"author\": \"<string>\",\n    \"author_username\": \"<string>\",\n    \"branch\": \"<string>\",\n    \"timestamp\": 123,\n    \"url\": \"<string>\",\n    \"parents\": [\n      \"<string>\"\n    ],\n    \"verified\": true,\n    \"signature_state\": \"<string>\"\n  },\n  \"repo_info\": {\n    \"name\": \"<string>\",\n    \"url\": \"<string>\",\n    \"id\": \"<string>\",\n    \"description\": \"<string>\"\n  },\n  \"commits_list\": [\n    {\n      \"sha1\": \"<string>\",\n      \"message\": \"<string>\",\n      \"author\": \"<string>\",\n      \"author_username\": \"<string>\",\n      \"branch\": \"<string>\",\n      \"timestamp\": 123,\n      \"url\": \"<string>\",\n      \"parents\": [\n        \"<string>\"\n      ],\n      \"verified\": true,\n      \"signature_state\": \"<string>\"\n    }\n  ],\n  \"repo_url\": \"<string>\",\n  \"is_compliant\": true,\n  \"template\": \"<string>\",\n  \"external_urls\": {},\n  \"annotations\": {},\n  \"user_data\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fingerprint\": \"<string>\",\n  \"filename\": \"<string>\",\n  \"build_url\": \"<string>\",\n  \"commit_url\": \"<string>\",\n  \"trail_name\": \"<string>\",\n  \"template_reference_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"git_commit\": \"<string>\",\n  \"git_commit_info\": {\n    \"sha1\": \"<string>\",\n    \"message\": \"<string>\",\n    \"author\": \"<string>\",\n    \"author_username\": \"<string>\",\n    \"branch\": \"<string>\",\n    \"timestamp\": 123,\n    \"url\": \"<string>\",\n    \"parents\": [\n      \"<string>\"\n    ],\n    \"verified\": true,\n    \"signature_state\": \"<string>\"\n  },\n  \"repo_info\": {\n    \"name\": \"<string>\",\n    \"url\": \"<string>\",\n    \"id\": \"<string>\",\n    \"description\": \"<string>\"\n  },\n  \"commits_list\": [\n    {\n      \"sha1\": \"<string>\",\n      \"message\": \"<string>\",\n      \"author\": \"<string>\",\n      \"author_username\": \"<string>\",\n      \"branch\": \"<string>\",\n      \"timestamp\": 123,\n      \"url\": \"<string>\",\n      \"parents\": [\n        \"<string>\"\n      ],\n      \"verified\": true,\n      \"signature_state\": \"<string>\"\n    }\n  ],\n  \"repo_url\": \"<string>\",\n  \"is_compliant\": true,\n  \"template\": \"<string>\",\n  \"external_urls\": {},\n  \"annotations\": {},\n  \"user_data\": {}\n}"

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

201

"<string>"

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

org · string · required

Body

application/json

fingerprint · string · required

Pattern: ^[a-f0-9]{64}$

filename · string · required

build_url · string · required

commit_url · string · required

trail_name · string | null

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_.~]*$

template_reference_name · string | null

Pattern: ^[a-zA-Z0-9\-_]+$

description · string | null

git_commit · string | null

Pattern: ^[a-f0-9]{40}$

git_commit_info · GitCommit · object | null

Show child attributes

repo_info · RepoInfoPostInput · object | null

Show child attributes

commits_list · GitCommit · object[] | null

Show child attributes

repo_url · Repo Url · string Repo Url · string

is_compliant · boolean | null

template · string string[]

external_urls · External Urls · object | null

annotations · Annotations · object | null

user_data · User Data · object any[]

Response

201 - application/json

Successful Response

The response is of type string.