Get all policy definitions
curl --request GET \
--url https://app.herondata.io/api/policies \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/policies"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.herondata.io/api/policies', 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.herondata.io/api/policies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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://app.herondata.io/api/policies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://app.herondata.io/api/policies")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"heron_id": "<string>",
"name": "<string>",
"checks": [
{
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": false,
"checks": "<array>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>"
},
"date_check": {
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"pass_if_value_missing": false,
"value": {}
},
"enhanced_sql_check": {
"column_name": "<string>",
"comparison_value": "<unknown>",
"query_name": "<string>",
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>"
},
"group": "<string>",
"name": "<string>",
"numeric_check": {
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"value": "<string>"
},
"sql_check": {
"column_name": "<string>",
"query_name": "<string>",
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>"
},
"string_check": {
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"value": "<string>"
}
}
],
"display_order": 123
}
]Policy
Get all policy definitions
Gets all policy definitions set up for a user
GET
/
api
/
policies
Get all policy definitions
curl --request GET \
--url https://app.herondata.io/api/policies \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/policies"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.herondata.io/api/policies', 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.herondata.io/api/policies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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://app.herondata.io/api/policies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://app.herondata.io/api/policies")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"heron_id": "<string>",
"name": "<string>",
"checks": [
{
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": false,
"checks": "<array>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>"
},
"date_check": {
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"pass_if_value_missing": false,
"value": {}
},
"enhanced_sql_check": {
"column_name": "<string>",
"comparison_value": "<unknown>",
"query_name": "<string>",
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>"
},
"group": "<string>",
"name": "<string>",
"numeric_check": {
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"value": "<string>"
},
"sql_check": {
"column_name": "<string>",
"query_name": "<string>",
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>"
},
"string_check": {
"auto_decline": false,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": false,
"is_mandatory": false,
"on_failure": "fail",
"pass_description": "<string>",
"value": "<string>"
}
}
],
"display_order": 123
}
]Was this page helpful?
⌘I