Update audit storage settings

PUT

/api/admin/settings/audit-storage

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/settings/audit-storage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "auditProfileId": "managed-audit-profile", "batchConfig": { "maxBatchSize": 100 } }'

Updates the managed audit storage profile or selects a configured audit profile after validating the environment and backend settings.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Audit storage configuration patch.

Media type application/json

object

auditProfileId

string

defaultEventBackend

string

defaultPiiBackend

string

batchConfig

Audit batching configuration.

object

key

additional properties

backends

Array<object>

Audit backend definition.

object

key

additional properties

key

additional properties

Example

{
  "auditProfileId": "managed-audit-profile",
  "batchConfig": {
    "maxBatchSize": 100
  }
}

Responses

200

Successful JSON response.

Media type application/json

object

success

boolean

config

object

auditProfileId

string

defaultEventBackend

string

defaultPiiBackend

string

batchConfig

Audit batching configuration.

object

key

additional properties

backends

Array<object>

Audit backend definition.

object

key

additional properties

key

additional properties

source

string

profile_id

string

note

string

key

additional properties

Example

{
  "success": true,
  "config": {
    "defaultEventBackend": "D1",
    "batchConfig": {
      "maxBatchSize": 100
    }
  },
  "source": "runtime_profile",
  "profile_id": "managed-audit-profile",
  "note": "Storage configuration updated via the managed audit profile. Batch settings remain transitional."
}

400

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

401

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

403

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

404

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

500

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