List Deployments

List deployments for an organization.

• end_ts defaults to now.
• start_ts defaults to 28 days before end_ts.

GET /deployments/{org}

List Deployments

cURL

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

import requests

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

require 'uri'
require 'net/http'

url = URI("https://app.kosli.com/api/v2/deployments/{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,
  "deployments": [
    {
      "fingerprint": "<string>",
      "deployed_at": 123,
      "artifact_name": "<string>",
      "env_name": "<string>",
      "snapshot_index": 123,
      "_links": {}
    }
  ],
  "_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 · default: 1

Page number

Required range: x >= 1

per_page · integer · default: 15

Number of deployments per page

Required range: 0 <= x <= 50

repo_name · string | null

Filter by repo name (e.g. 'kosli-dev/server')

env_name · string | null

Filter by environment name

start_ts · number | null

Include deployments at or after this timestamp. Defaults to 28 days before end_ts

end_ts · number | null

Include deployments at or before this timestamp. Defaults to now

Response

200 - application/json

Successful Response

page · integer · required

per_page · integer · required

total_pages · integer · required

total_count · integer · required

deployments · DeploymentListItemResponse · object[] · required

Show child attributes

_links · Links · object | null