Get an available action
curl --request GET \
--url https://api.katilyst.com/v1/available-actions/{availableActionId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.katilyst.com/v1/available-actions/{availableActionId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.katilyst.com/v1/available-actions/{availableActionId}', 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://api.katilyst.com/v1/available-actions/{availableActionId}",
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: <api-key>"
],
]);
$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://api.katilyst.com/v1/available-actions/{availableActionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.katilyst.com/v1/available-actions/{availableActionId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.katilyst.com/v1/available-actions/{availableActionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "1111-111-11111-example",
"projectId": "1111-111-11111-example",
"name": "Take Security Awareness Course",
"description": "Awarded for for completing a security awareness course.",
"attribute": "Points",
"operator": "+",
"result": "50 | Green Belt",
"conditions": "When (Points > 50) AND (Belt Level = Green Belt) Stars + 50",
"stateful": true,
"frequencyLimit": "Once per month",
"type": "PARTICIPANT",
"expirationPeriod": "6 weeks",
"approvalRequired": false,
"autoAddUsers": true,
"autoAddUsersRole": "ADMIN",
"timesLogged": 12
}Discovery
Get an available action
GET
/
v1
/
available-actions
/
{availableActionId}
Get an available action
curl --request GET \
--url https://api.katilyst.com/v1/available-actions/{availableActionId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.katilyst.com/v1/available-actions/{availableActionId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.katilyst.com/v1/available-actions/{availableActionId}', 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://api.katilyst.com/v1/available-actions/{availableActionId}",
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: <api-key>"
],
]);
$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://api.katilyst.com/v1/available-actions/{availableActionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.katilyst.com/v1/available-actions/{availableActionId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.katilyst.com/v1/available-actions/{availableActionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "1111-111-11111-example",
"projectId": "1111-111-11111-example",
"name": "Take Security Awareness Course",
"description": "Awarded for for completing a security awareness course.",
"attribute": "Points",
"operator": "+",
"result": "50 | Green Belt",
"conditions": "When (Points > 50) AND (Belt Level = Green Belt) Stars + 50",
"stateful": true,
"frequencyLimit": "Once per month",
"type": "PARTICIPANT",
"expirationPeriod": "6 weeks",
"approvalRequired": false,
"autoAddUsers": true,
"autoAddUsersRole": "ADMIN",
"timesLogged": 12
}Authorizations
Your full Authorization header value, including the prefix: API-Key katilyst_xxxx_yourkey
Path Parameters
Response
Example:
"1111-111-11111-example"
Example:
"1111-111-11111-example"
Example:
"Take Security Awareness Course"
Example:
"Awarded for for completing a security awareness course."
Example:
"Points"
Example:
"+"
Example:
"50 | Green Belt"
Example:
"When (Points > 50) AND (Belt Level = Green Belt) Stars + 50"
Example:
true
Example:
"Once per month"
Example:
"PARTICIPANT"
Example:
"6 weeks"
Example:
false
Example:
true
Example:
"ADMIN"
Example:
12
