Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
partitionManagement

Update a partition.

Update an existing partition in the organization.

put/v1/partitions/{id}

Path parameters

idstring required

Identifier of the partition to update.

Request body

retentionPeriodinteger

The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.

reduceRetentionPeriodImmediatelyboolean

This is required if the newly specified retentionPeriod is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.

isCompliantboolean

Whether to mark a partition as compliant. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition marked as compliant. A partition once marked compliant, cannot be marked non-compliant later.

isIncludedInDefaultSearchboolean

Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.

routingExpressionstring

The query that defines the data to be included in the partition.

Example request

{
  "retentionPeriod": 365,
  "routingExpression": "_sourcecategory=*/Apache"
}

Response

The partition was successfully modified.

namestring required

The name of the partition.

routingExpressionstring required

The query that defines the data to be included in the partition.

analyticsTierstring

The Data Tier where the data in the partition will reside. Possible values are: 1. continuous 2. frequent 3. infrequent Note: The "infrequent" and "frequent" tiers are only available to Cloud Flex Credits Enterprise Suite accounts.

retentionPeriodinteger

The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.

isCompliantboolean

Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.

isIncludedInDefaultSearchboolean

Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.

newRetentionPeriodinteger

If the retention period is scheduled to be updated in the future (i.e., if retention period is previously reduced with value of reduceRetentionPeriodImmediately as false), this property gives the future value of retention period while retentionPeriod gives the current value. retentionPeriod will take up the value of newRetentionPeriod after the scheduled time.

retentionEffectiveAtstring date-time

When the newRetentionPeriod will become effective in UTC format.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

idstring required

Unique identifier for the partition.

totalBytesinteger required

Size of data in partition in bytes.

isActiveboolean

This has the value true if the partition is active and false if it has been decommissioned.

indexTypestring

This has the value DefaultIndex, AuditIndexor Partition depending upon the type of partition.

dataForwardingIdstring

Id of the data forwarding configuration to be used by the partition.

Example response

{
  "name": "apache",
  "routingExpression": "_sourcecategory=*/Apache",
  "analyticsTier": "continuous",
  "retentionPeriod": 365,
  "isIncludedInDefaultSearch": true,
  "newRetentionPeriod": 300,
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006743FE8",
  "id": "1",
  "totalBytes": 42,
  "indexType": "Partition"
}