GET
/
rules
curl --request GET \
  --url https://proxy.qualifire.ai/api/rules \
  --header 'X-Qualifire-API-Key: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "created_at": "<string>",
    "active": true,
    "trigger": "<string>",
    "error_threshold": 50,
    "warning_threshold": 50,
    "evaluations": {
      "request_evaluation": "<string>",
      "response_evaluation": "<string>"
    },
    "actions": {
      "block": true,
      "default_response": "<string>",
      "retry": true,
      "retry_cap": 5,
      "alert": {
        "email": "<string>",
        "message": "<string>",
        "cooldown": 0
      }
    }
  }
]

Authorizations

X-Qualifire-API-Key
string
header
required

Query Parameters

limit
integer

The maximum number of Rules to return

offset
integer

The offset of the Rules to return

Response

200
application/json
OK
id
string

The ID of the Rule

name
string

The name of the Rule

description
string

The description of the Rule

created_at
string

The creation date of the Rule

active
boolean
default:true

Whether the Rule is active

trigger
string

The trigger of the Rule

error_threshold
integer

The error threshold of the Rule

Required range: 0 <= x <= 100
warning_threshold
integer

The warning threshold of the Rule

Required range: 0 <= x <= 100
evaluations
object
actions
object