Skip to content

Modify



POST /api/v1/workspace/{workspace_uuid}/modify

Overview

Route Parameters

Parameter Name Type Required Description
workspace_uuid string Y Workspace UUID

Body Request Parameters

Parameter Name Type Required Description
isOpenCustomMappingRule boolean Whether to enable custom mapping rules
Example: False
Nullable: False
maxSearchResultCount integer Maximum number of search results
Example: 0
Nullable: False
name string Name
Example: supper_workspace
Nullable: False
Max length: 256
esIndexMerged boolean Whether to merge indexes, default is true
Example: False
Nullable: False
isOpenLogMultipleIndex boolean Whether to enable log multiple index configuration, default is true (i.e., disabled)
Example: False
Nullable: False
logMultipleIndexCount int After enabling log multiple index configuration, the limit on the number of log multiple indexes at the workspace level
Example: 3
Nullable: False
loggingCutSize int Unit for cutting large logs, used in bytes during transmission
Example: False
Nullable: False
leftWildcard boolean Whether to enable left wildcard matching, default is false (i.e., disabled)
Example: False
Nullable: False
durationSet object Data retention duration information
durationSet.rp string Duration of time series RP
Example: 30d
Nullable: False
durationSet.logging string Duration of log RP
Example: 14d
Nullable: False
durationSet.backup_log string Duration of backup logs
Example: 180d
Nullable: False
durationSet.security string Duration of inspection data
Example: 90d
Nullable: False
durationSet.keyevent string Duration of event RP
Example: 14d
Nullable: False
durationSet.tracing string Duration of tracing
Example: 7d
Nullable: False
durationSet.rum string Duration of RUM
Example: 7d
Nullable: False
durationSet.apm string Duration of APM (effective when indexes are merged)
Example: 7d
Nullable: False
durationSet.network string Duration of network data (effective when indexes are merged)
Example: 7d
Nullable: False
disableQueryAcceleration integer Disable query acceleration
Nullable: True
Optional values: [0, 1]
enableRumMultipleTable integer Whether to enable RUM multi-table (i.e., whether to split tables), default value is 1
Nullable: True
Optional values: [0, 1]
storagePolicy json Long-term storage policy. Key only supports rp and logging, value includes longStorageEnabled and longStorageDuration; for logs, only workspaces with scopedb storage can enable it, metrics are validated based on workspace billing type.
Example: {'rp': {'longStorageEnabled': True, 'longStorageDuration': '180d'}, 'logging': {'longStorageEnabled': True, 'longStorageDuration': '180d'}}
Nullable: False

Additional Parameter Notes

Response


Feedback

Is this page helpful?