Skip to main content
GET
/
api
/
policies
Get all policy definitions
curl --request GET \
  --url https://app.herondata.io/api/policies \
  --header 'x-api-key: <api-key>'
[
  {
    "heron_id": "<string>",
    "name": "<string>",
    "checks": [
      {
        "attribute_label": "<string>",
        "boolean_check": {
          "auto_decline": false,
          "decline_description": null,
          "email_template_name": null,
          "ignore_metric_availability": false,
          "is_mandatory": false,
          "on_failure": "fail",
          "pass_description": null,
          "value": true
        },
        "composite_check": {
          "auto_decline": false,
          "checks": "<array>",
          "decline_description": null,
          "email_template_name": null,
          "ignore_metric_availability": false,
          "is_mandatory": false,
          "on_failure": "fail",
          "pass_description": null
        },
        "date_check": {
          "auto_decline": false,
          "decline_description": null,
          "email_template_name": null,
          "ignore_metric_availability": false,
          "is_mandatory": false,
          "on_failure": "fail",
          "pass_description": null,
          "value": "2023-12-25"
        },
        "date_delta_to_now_check": {
          "auto_decline": false,
          "decline_description": null,
          "email_template_name": null,
          "ignore_metric_availability": false,
          "is_mandatory": false,
          "on_failure": "fail",
          "pass_description": null,
          "value": null
        },
        "enhanced_sql_check": {
          "column_name": "<string>",
          "comparison_value": "<unknown>",
          "query_name": "<string>",
          "auto_decline": false,
          "decline_description": null,
          "email_template_name": null,
          "ignore_metric_availability": false,
          "is_mandatory": false,
          "on_failure": "fail",
          "pass_description": null
        },
        "group": "<string>",
        "name": "<string>",
        "numeric_check": {
          "auto_decline": false,
          "decline_description": null,
          "email_template_name": null,
          "ignore_metric_availability": false,
          "is_mandatory": false,
          "on_failure": "fail",
          "pass_description": null,
          "value": "<string>"
        },
        "sql_check": {
          "column_name": "<string>",
          "query_name": "<string>",
          "auto_decline": false,
          "decline_description": null,
          "email_template_name": null,
          "ignore_metric_availability": false,
          "is_mandatory": false,
          "on_failure": "fail",
          "pass_description": null
        },
        "string_check": {
          "auto_decline": false,
          "decline_description": null,
          "email_template_name": null,
          "ignore_metric_availability": false,
          "is_mandatory": false,
          "on_failure": "fail",
          "pass_description": null,
          "value": "<string>"
        }
      }
    ],
    "display_order": null,
    "use_case": null
  }
]

Authorizations

x-api-key
string
header
required

Response

200 - application/json

Ok

heron_id
string
required
name
string
required
checks
object[]
display_order
integer | null
use_case
any | null
Available options:
background_check,
cashflow,
null