Skip to content
Authrim

Update a logging quota policy

PATCH
/api/admin/logging-policies/quota-policies/{id}
Code sample: Shell / cURL 
curl --request PATCH \
  --url https://auth.example.com/api/admin/logging-policies/quota-policies/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "scope_type": "tenant", "scope_id": "tenant_123", "metric_name": "byte_count", "window_kind": "day", "soft_limit": 1000000, "hard_limit": 2000000, "warning_ratio": 0.8, "enforcement_mode": "warn_only", "status": "active" }'

Update a logging quota policy and increment its version. An expected_version mismatch returns a conflict.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
scope_type
string
Allowed values: platform tenant
scope_id
string
log_type
string
plane
string
lane
string
metric_name
string
window_kind
string
Allowed values: hour day month
soft_limit
integer
hard_limit
integer
warning_ratio
number
enforcement_mode
string
status
string
expected_version
integer
key
additional properties
Example 
{
  "scope_type": "tenant",
  "scope_id": "tenant_123",
  "metric_name": "byte_count",
  "window_kind": "day",
  "soft_limit": 1000000,
  "hard_limit": 2000000,
  "warning_ratio": 0.8,
  "enforcement_mode": "warn_only",
  "status": "active"
}

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"
}