List environments

List environments of an organization.

GET /environments/{org}

List environments

cURL

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

import requests

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

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/environments/{org}', 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/environments/{org}",
  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/environments/{org}"

	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/environments/{org}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "page": 123,
  "per_page": 123,
  "total_pages": 123,
  "total_count": 123,
  "environments": [
    {
      "org": "<string>",
      "name": "<string>",
      "type": "<string>",
      "description": "<string>",
      "last_modified_at": 123,
      "include_scaling": true,
      "tags": {},
      "last_reported_at": 123,
      "last_changed_at": 123,
      "state": true,
      "policies": [
        "<string>"
      ],
      "included_environments": [
        "<string>"
      ]
    }
  ],
  "_links": {}
}

Authorizations

Authorization · string · header · required

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

Path Parameters

org · string · required

Query Parameters

page · integer | null

Page number

Required range: x >= 1

per_page · integer | null

Number of environments per page

Required range: 1 <= x <= 50

sort · enum<string> · default: name

Sort field

Available options: name, last_modified_at, last_changed_at

sort_direction · enum<string> · default: asc

Sort direction

Available options: asc, desc

space_id · string[] | null

Filter by space ID. Can be repeated for OR semantics, e.g. space_id=a&space_id=b

name · string | null

Filter by name (case-insensitive substring match)

type · enum<string>[] | null

Filter by environment type. Can be repeated, e.g. type=K8S&type=ECS

Available options: K8S, ECS, S3, lambda, server, docker, azure-apps, cloud-run, logical

tag · string[] | null

Filter by tag key or key:value. Can be repeated, e.g. tag=team or tag=team:platform

Response

200 - application/json

Successful Response

EnvironmentListResponse · object

GetEnvironmentResponse · object[]

page · integer · required

per_page · integer · required

total_pages · integer · required

total_count · integer · required

environments · GetEnvironmentResponse · object[] · required

Show child attributes

_links · Links · object | null