Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /config/flow_retention_buckets

SUMMARY Retrieves a list of flow retention buckets.

Retrieves a list of flow retention buckets.

Table 1: GET /config/flow_retention_buckets resource details:

GET /config/flow_retention_buckets resource details
MIME Type

application/json

Table 2: GET /config/flow_retention_buckets request parameter details:

GET /config/flow_retention_buckets request parameter details
Parameter Type Optionality Data Type MIME Type Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

fields

query

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.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
Table 3: GET /config/flow_retention_buckets response codes:

GET /config/flow_retention_buckets response codes
HTTP Response Code Unique Code Description

200

The flow retention buckets were retrieved.

422

1010

A request parameter is not valid.

500

1020

An error occurred during the attempt to retrieve the flow retention buckets.

Response Description

An array of Retention Bucket objects. An 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