Create approval

Create an approval.

POST /approvals/{org}/{flow_name}

Create approval

cURL

curl --request POST \
  --url https://app.kosli.com/api/v2/approvals/{org}/{flow_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "artifact_fingerprint": "<string>",
  "description": "<string>",
  "src_commit_list": [
    "<string>"
  ],
  "environment": "<string>",
  "oldest_commit": "<string>",
  "approvals": [
    {
      "comment": "<string>",
      "approved_by": "<string>",
      "approval_url": "<string>"
    }
  ],
  "user_data": {}
}
'

import requests

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

payload = {
    "artifact_fingerprint": "<string>",
    "description": "<string>",
    "src_commit_list": ["<string>"],
    "environment": "<string>",
    "oldest_commit": "<string>",
    "approvals": [
        {
            "comment": "<string>",
            "approved_by": "<string>",
            "approval_url": "<string>"
        }
    ],
    "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({
    artifact_fingerprint: '<string>',
    description: '<string>',
    src_commit_list: ['<string>'],
    environment: '<string>',
    oldest_commit: '<string>',
    approvals: [{comment: '<string>', approved_by: '<string>', approval_url: '<string>'}],
    user_data: {}
  })
};

fetch('https://app.kosli.com/api/v2/approvals/{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/approvals/{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([
    'artifact_fingerprint' => '<string>',
    'description' => '<string>',
    'src_commit_list' => [
        '<string>'
    ],
    'environment' => '<string>',
    'oldest_commit' => '<string>',
    'approvals' => [
        [
                'comment' => '<string>',
                'approved_by' => '<string>',
                'approval_url' => '<string>'
        ]
    ],
    '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/approvals/{org}/{flow_name}"

	payload := strings.NewReader("{\n  \"artifact_fingerprint\": \"<string>\",\n  \"description\": \"<string>\",\n  \"src_commit_list\": [\n    \"<string>\"\n  ],\n  \"environment\": \"<string>\",\n  \"oldest_commit\": \"<string>\",\n  \"approvals\": [\n    {\n      \"comment\": \"<string>\",\n      \"approved_by\": \"<string>\",\n      \"approval_url\": \"<string>\"\n    }\n  ],\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/approvals/{org}/{flow_name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"artifact_fingerprint\": \"<string>\",\n  \"description\": \"<string>\",\n  \"src_commit_list\": [\n    \"<string>\"\n  ],\n  \"environment\": \"<string>\",\n  \"oldest_commit\": \"<string>\",\n  \"approvals\": [\n    {\n      \"comment\": \"<string>\",\n      \"approved_by\": \"<string>\",\n      \"approval_url\": \"<string>\"\n    }\n  ],\n  \"user_data\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kosli.com/api/v2/approvals/{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  \"artifact_fingerprint\": \"<string>\",\n  \"description\": \"<string>\",\n  \"src_commit_list\": [\n    \"<string>\"\n  ],\n  \"environment\": \"<string>\",\n  \"oldest_commit\": \"<string>\",\n  \"approvals\": [\n    {\n      \"comment\": \"<string>\",\n      \"approved_by\": \"<string>\",\n      \"approval_url\": \"<string>\"\n    }\n  ],\n  \"user_data\": {}\n}"

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

201

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

flow_name · string · required

org · string · required

Body

application/json

Create approval for an artifact.

artifact_fingerprint · string · required

The sha256 fingerprint of the artifact that is approved

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

description · string · required

Description for the approval

src_commit_list · string[] · required

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

environment · string | null

Environment the approval is valid for

oldest_commit · string | null

The oldest commit

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

approvals · Approval · object[] | null

List of approvals

Show child attributes

user_data · User Data · object any[]

Response

201

application/json

Successful Response

Create approval for an artifact.

Example:

{
  "approvals": [
    {
      "approval_url": "https://example.com",
      "approved_by": "bob",
      "comment": "I like this",
      "state": "APPROVED"
    }
  ],
  "artifact_fingerprint": "73d75bf7cac2f24845deeb51e05babd2514e91eb4fdd2352fbc2fcf267ff21fb",
  "description": "Approved since it is good",
  "environment": "production",
  "oldest_commit": "7e8a2cc65e4679bb7bea3605f9245f2214aad585",
  "src_commit_list": [
    "602ed54b6dec955d348201fa411faa3f92dc8bc7",
    "af2705a9da720cbf1b166c668d5ed17fa371af0d"
  ]
}