POST /config/flow_retention_buckets/{id}

Updates the flow retention bucket owner, or enabled/disabled only.

Table 1. POST /config/flow_retention_buckets/{id} resource details
MIME Type
application/json

Table 2. POST /config/flow_retention_buckets/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	null
fields	header	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. POST /config/flow_retention_buckets/{id} request body details
Parameter	Data Type	MIME Type	Description	Sample
retention_bucket	Object	application/json	null	{ "bucket_id": 42, "database": "String", "description": "String", "enabled": true, "id": 42, "name": "String", "period": 42, "priority": 42, "saved_search_id": "String" }

Table 4. POST /config/flow_retention_buckets/{id} response codes
HTTP Response Code	Unique Code	Description
200		The flow retention bucket was updated.
404	1002	The Flow Retention Bucket does not exist.
409	1004	The provided user does not have the required capabilities to own the flow retention bucket.
422	1005	A request parameter is not valid.
500	1020	An error occurred during the attempt to update the flow retention bucket.

Response Description

The Retention Bucket after it is updated. A Retention Bucket object contains the following fields:

id - Integer - The ID of the retention bucket.
bucket_id - Integer - The Bucket ID of the retention bucket. ( 0 - 10 ).
priority - Integer - The priority of the retention bucket ( 0 - 10 ).
name - String - The name of the retention bucket.
database - String - The database of the retention bucket, EVENTS or FLOWS.
description - String - The description of the retention bucket.
period - Integer - The retention period in hours.
delete - String - The delete protocol of the retention bucket, IMMEDIATELY or ON_DEMAND.
created - Long - The time in milliseconds since epoch since the retention bucket was created.
modified - Long - The time in milliseconds since epoch since the retention bucket was last modified.
saved_search_id - String - The ID of the saved search used by the retention bucket.
enabled - Boolean - True if the retention bucket is enabled.

Response Sample


{
    "bucket_id": 42,
    "created": 42,
    "database": "String",
    "deletion": "String <one of: ON_DEMAND, IMMEDIATELY>",
    "description": "String",
    "enabled": true,
    "id": 42,
    "modified": 42,
    "name": "String",
    "period": 42,
    "priority": 42,
    "saved_search_id": "String"
}