GET /config/event_retention_buckets/{id}

Retrieves an event retention bucket.

Retrieves an event retention bucket.

Table 1. GET /config/event_retention_buckets/{id} resource details
MIME Type

application/json

Table 2. GET /config/event_retention_buckets/{id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

id

path

Required

Number (Integer)

text/plain

null

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.
Table 3. GET /config/event_retention_buckets/{id} response codes
HTTP Response Code Unique Code Description

200

The event retention bucket was retrieved.

404

1002

The event retention bucket does not exist.

500

1020

An error occurred during the attempt to retrieve the event retention bucket.

Response Description

The retention bucket after it has been retrieved. 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 that is 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"
}