Skip to main content
PATCH
/
v1
/
policy-engine
/
policies
/
{policyId}
Update Policy
curl --request PATCH \
  --url https://api.example.com/v1/policy-engine/policies/{policyId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "rule": {},
  "priority": 123,
  "enabled": true
}
'
{
  "policy": {}
}

Update Policy

Update an existing policy’s configuration.

Request

policyId
string
required
Policy identifier
name
string
New policy name
description
string
New description
rule
object
Updated rule configuration
priority
integer
New priority
enabled
boolean
Enable/disable policy

Response

policy
object
Updated policy object

Example

curl -X PATCH https://api.axonvault.io/v1/policy-engine/policies/pol_abc123 \
  -H "X-Access-Key: ak_live_abc123" \
  -H "X-Signature: ..." \
  -H "X-Timestamp: 2024-01-15T10:30:00Z" \
  -H "Content-Type: application/json" \
  -d '{
    "rule": {
      "approvalFlow": {
        "enabled": true,
        "threshold": "25000",
        "approvers": ["usr_admin1", "usr_admin2", "usr_admin3"],
        "requiredApprovals": 2
      }
    }
  }'

Response Example

{
  "policy": {
    "policyId": "pol_abc123",
    "name": "High Value Approval",
    "rule": {
      "approvalFlow": {
        "enabled": true,
        "threshold": "25000",
        "approvers": ["usr_admin1", "usr_admin2", "usr_admin3"],
        "requiredApprovals": 2
      }
    },
    "priority": 100,
    "enabled": true,
    "updateAt": "2024-01-15T11:00:00Z"
  }
}