Skip to content
Authrim

Publish a logging policy snapshot

POST
/api/admin/logging-policies/snapshots
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/logging-policies/snapshots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "scope_type": "tenant", "scope_id": "tenant_123" }'

Build and publish a runtime logging policy snapshot to KV or object storage, then persist the published snapshot metadata.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
scope_type
string
Allowed values: platform tenant
scope_id
string
tenant_id
string
confirmation
string
expected_version
integer
key
additional properties
Example 
{
  "scope_type": "tenant",
  "scope_id": "tenant_123"
}

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": "snap_123",
    "scope_type": "tenant",
    "scope_id": "tenant_123",
    "version": 4,
    "status": "published",
    "policy_hash": "sha256:policy",
    "object_ref": "kv://logging/policies/tenant_123/4",
    "pointer_key": "logging:policy:tenant:tenant_123",
    "created_at": 1770000000,
    "published_at": 1770000000
  },
  "audit_id": "audit_123",
  "version": 4
}

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