Skip to content
Authrim

Update Logging Policy.

PATCH
/api/admin/logging-policies/{policy_id}
Code sample: Shell / cURL 
curl --request PATCH \
  --url https://auth.example.com/api/admin/logging-policies/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "tenant_id": "tenant_123", "log_type": "security", "plane": "control", "destination_id": "dest_123", "enabled": true, "change_protection": "confirm" }'

Update Logging Policy in the Logging - Policies area. The request body is JSON unless the detailed schema for this operation states otherwise.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
policy_id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
tenant_id
One of:
string
log_type
required
string
plane
required
string
destination_id
required
string
fallback_policy_id
One of:
string
enabled
boolean
change_protection
string
Allowed values: confirm approval_required config_only
approval_policy_id
One of:
string
confirmation
string
expected_version
integer
key
additional properties
Example 
{
  "tenant_id": "tenant_123",
  "log_type": "security",
  "plane": "control",
  "destination_id": "dest_123",
  "enabled": true,
  "change_protection": "confirm"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
item
required
object
key
additional properties
audit_id
One of:
string
version
integer
key
additional properties
Example 
{
  "item": {
    "id": "pol_123",
    "tenant_id": "tenant_123",
    "log_type": "security",
    "plane": "control",
    "destination_id": "dest_123",
    "fallback_policy_id": null,
    "enabled": 1,
    "managed_by": "platform",
    "change_protection": "confirm",
    "approval_policy_id": null,
    "policy_hash": "sha256:abc123",
    "version": 1,
    "created_at": 1770000000000,
    "updated_at": 1770000000000
  },
  "audit_id": "audit_123",
  "version": 1
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}