Create or update environment notification

Create or Update an environments-notification for an org.

PUT /organizations/{org}/environments_notifications

Create or update environment notification

cURL

curl --request PUT \
  --url https://app.kosli.com/api/v2/organizations/{org}/environments_notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "targets": [
    {}
  ],
  "environments": [
    "<string>"
  ],
  "triggers": [],
  "type": "env"
}
'

import requests

url = "https://app.kosli.com/api/v2/organizations/{org}/environments_notifications"

payload = {
    "name": "<string>",
    "targets": [{}],
    "environments": ["<string>"],
    "triggers": [],
    "type": "env"
}
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({
    name: '<string>',
    targets: [{}],
    environments: ['<string>'],
    triggers: [],
    type: 'env'
  })
};

fetch('https://app.kosli.com/api/v2/organizations/{org}/environments_notifications', 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/organizations/{org}/environments_notifications",
  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([
    'name' => '<string>',
    'targets' => [
        [
                
        ]
    ],
    'environments' => [
        '<string>'
    ],
    'triggers' => [
        
    ],
    'type' => 'env'
  ]),
  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/organizations/{org}/environments_notifications"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"targets\": [\n    {}\n  ],\n  \"environments\": [\n    \"<string>\"\n  ],\n  \"triggers\": [],\n  \"type\": \"env\"\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/organizations/{org}/environments_notifications")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"targets\": [\n    {}\n  ],\n  \"environments\": [\n    \"<string>\"\n  ],\n  \"triggers\": [],\n  \"type\": \"env\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"<string>\",\n  \"targets\": [\n    {}\n  ],\n  \"environments\": [\n    \"<string>\"\n  ],\n  \"triggers\": [],\n  \"type\": \"env\"\n}"

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

200

"<string>"

"<string>"

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

Authorizations

Authorization · string · header · required

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

Path Parameters

org · string · required

Body

application/json

name · string · required

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

Example:

"production-action"

targets · (object | SlackActionTarget · object | WebhookActionTarget · object | EmailActionTarget · object)[] · required

Option 1

SlackActionTarget

WebhookActionTarget

EmailActionTarget

environments · string[] · required

triggers · enum<string>[] · required

Available options: ON_STARTED_ARTIFACT, ON_EXITED_ARTIFACT, ON_SCALED_ARTIFACT, ON_ALLOWED_ARTIFACT, ON_NON_COMPLIANT_ENV, ON_COMPLIANT_ENV

type · string · default: env

Allowed value: "env"

Response

200

application/json

Successfully updated environments notification.

The response is of type string.