Allow artifact for environment

Allow an artifact for an environment.

PUT /allowlists/{org}/{env_name}

Allow artifact for environment

cURL

curl --request PUT \
  --url https://app.kosli.com/api/v2/allowlists/{org}/{env_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "artifact_name": "<string>",
  "artifact_fingerprint": "<string>",
  "description": "<string>"
}
'

import requests

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

payload = {
    "artifact_name": "<string>",
    "artifact_fingerprint": "<string>",
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    artifact_name: '<string>',
    artifact_fingerprint: '<string>',
    description: '<string>'
  })
};

fetch('https://app.kosli.com/api/v2/allowlists/{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/allowlists/{org}/{env_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'artifact_name' => '<string>',
    'artifact_fingerprint' => '<string>',
    'description' => '<string>'
  ]),
  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/allowlists/{org}/{env_name}"

	payload := strings.NewReader("{\n  \"artifact_name\": \"<string>\",\n  \"artifact_fingerprint\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://app.kosli.com/api/v2/allowlists/{org}/{env_name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"artifact_name\": \"<string>\",\n  \"artifact_fingerprint\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"artifact_name\": \"<string>\",\n  \"artifact_fingerprint\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

201

{
  "artifact_name": "<string>",
  "artifact_fingerprint": "<string>",
  "description": "<string>"
}

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

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

Body

application/json

Input model for an allowlist record

artifact_name · string · required

The name of the artifact that is allowed

artifact_fingerprint · string · required

The sha256 fingerprint of the artifact that is allowed

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

description · string · required

The reason for allow listing this artifact

Response

201

application/json

Successful Response

Input model for an allowlist record

artifact_name · string · required

The name of the artifact that is allowed

artifact_fingerprint · string · required

The sha256 fingerprint of the artifact that is allowed

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

description · string · required

The reason for allow listing this artifact