Update archive settings
PATCH
/tenants/me/settings/archive
Updates the archive settings for the authenticated tenant. Only provided fields will be updated.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”Request to update archive settings for a tenant.
object
archive_batch_size
Archive batch size (number of events). Must be between 100 and 100000.
integer | null format: int32
archive_batch_timeout_secs
Archive batch timeout in seconds. Must be between 1 and 300.
integer | null format: int32
purge_after_archive
Whether to purge events after archiving.
boolean | null
snapshot_min_interval_secs
Minimum seconds between snapshots for a view. Must be between 5 and 3600.
integer | null format: int32
Example
{ "archive_batch_size": 5000, "archive_batch_timeout_secs": 60, "purge_after_archive": true, "snapshot_min_interval_secs": 60}Responses
Section titled “ Responses ”Archive settings updated
Response after updating archive settings.
object
archive_batch_size
required
Archive batch size (number of events).
integer format: int32
archive_batch_timeout_secs
required
Archive batch timeout in seconds.
integer format: int32
purge_after_archive
required
Whether to purge events after archiving.
boolean
snapshot_min_interval_secs
required
Minimum seconds between snapshots for a view.
integer format: int32
Example
{ "archive_batch_size": 5000, "archive_batch_timeout_secs": 60, "purge_after_archive": true, "snapshot_min_interval_secs": 60}Invalid request
Generic error response for OpenAPI documentation.
object
error
required
Error message.
string
Example
{ "error": "Short name or email conflict"}Unauthorized
Server error