Get policy

Get a Policy in an organization.

GET /policies/{org}/{policy_name}

Get policy

cURL

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

import requests

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

require 'uri'
require 'net/http'

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

{
  "name": "<string>",
  "description": "<string>",
  "created_by": "<string>",
  "created_at": 123,
  "last_modified_at": 123,
  "archived": false,
  "versions": [],
  "events": [],
  "consuming_envs": []
}

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

Authorizations

Authorization · string · header · required

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

Path Parameters

policy_name · string · required

org · string · required

Response

200

application/json

Successful Response

Response model for a policy

This represents the response structure when retrieving, creating or updating a policy.

name · string · required

description · string · required

created_by · string · required

created_at · number | null

last_modified_at · number | null

archived · boolean · default: false

versions · VersionedPolicy · object[]

Show child attributes

events · PolicyEvent · object[]

Show child attributes

consuming_envs · string[]