Skip to main content
POST
/
v1
/
orgs
/
{org_id}
/
rules
/
evaluate
Evaluate a rule expression
curl --request POST \
  --url https://api.arklow.io/v1/orgs/{org_id}/rules/evaluate \
  --header 'Content-Type: application/json' \
  --header 'x-arklow-auth: <api-key>' \
  --data '
{
  "expression": "<string>",
  "context": {
    "available_fields": [
      "<string>"
    ],
    "fields": {},
    "lists": {},
    "now": "2023-11-07T05:31:56Z",
    "phase": "<string>"
  }
}
'
{
  "data": {
    "expression": "<string>",
    "result": {
      "ast": "<unknown>",
      "missing_fields": [
        "<string>"
      ],
      "phase": "<string>",
      "status": "deferred",
      "value": true
    }
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

x-arklow-auth
string
header
required

Path Parameters

org_id
string
required
Pattern: ^[0-9]+$

Body

application/json
expression
string
required
context
object

Response

Default Response

data
object
required
errors
object[] | null
required