PUT /v1/partitions/{id}

Update an existing partition in the organization.

Servers

https://api.au.sumologic.com/api/
https://api.ca.sumologic.com/api/
https://api.de.sumologic.com/api/
https://api.eu.sumologic.com/api/
https://api.fed.sumologic.com/api/
https://api.jp.sumologic.com/api/
https://api.kr.sumologic.com/api/
https://api.in.sumologic.com/api/
https://api.sumologic.com/api/
https://api.us2.sumologic.com/api/

Path parameters

Name	Type	Required	Description
`id`	String	Yes	Identifier of the partition to update.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`isIncludedInDefaultSearch`	Boolean	No	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.
`retentionPeriod`	Integer	No	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.
`isCompliant`	Boolean	No	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. Default value: false
`routingExpression`	String	No	The query that defines the data to be included in the partition.
`reduceRetentionPeriodImmediately`	Boolean	No	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. Default value: false

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.