Sign in
latestSwagger 2.02026-08-2358186392.0 KB

ae0e90c2c794

Rehydrations

Returns list of rehydrations based on given filters

get/v1/orgs/{org_id}/rehydration

Path parameters

org_idstring required

Org ID

Query parameters

rehydration_idstring

If rehydration_id is given only matching item is returned in the response

lookbackstring

Lookback period in golang duration format. e.g. '1h'. Either provide from/to or provide lookback/to or just lookback

fromstring

From datetime in ISO format 2006-01-02T15:04:05.000Z

tostring

To datetime in ISO format 2006-01-02T15:04:05.000Z

hoststring

Host filter. Not filtered by host if not provided

tagstring

Tag filter. Not filtered by tag if not provided

sourcetypestring

Source type filter. e.g. 'File', 'Docker'. Not filtered by source type if not provided

cluster_idstring

Cluster ID filter. Not filtered by cluster id if not provided

Response

OK

archive_flush_intervalstring

Archive Flush Interval is the flush interval for the agent with this tag, this helps us calculate which files overflowed into the next s3 bucket due to flush latency

assigned_clusterstring

AssignedCluster is the cluster that this rehydration is assigned to This is used to route the retries of the rehydration to the correct cluster and preventing multiple clusters from processing the same rehydration

bucketstring
checkpointstring

Checkpoint is the last object key the rehydration job processed. Shouldn't be shown to user

checkpoint_v2string

CheckpointV2 saves pending files instead of processed ones. It also differs structurally so they are not compatible with Checkpoint field. Used in the rehydration with queue and parallel workers. Shouldn't be shown to user

cql_querystring
createdstring

Created & Updated are timestamps in core.StorageTimeFormat

creatorstring
destinationstring
dynamic_urlstring
errorstring
exclude_overlapboolean

ExcludeOverlap exclude logs rehydrated by existing rehydrations

facetsobject

Facets are used to filter rehydrations with facet_options api

fromstring

From & To are timestamps in core.URLTimeFormat

hoststring
keyword_filterstring
org_idstring
ottl_querystring

Field to save OTTL query filter

percentagenumber

Percentage is duplicated here for org level rehydrations, omitted in individual rehydrations because RehydrationWithStatus is used instead

prefix_filterstring

Prefix and prefix regex are used to filter rehydrations with prefix filter

prefix_regexstring
rehydration_idstring
source_filtersobject
source_integrationstring

TODO delete after Box migration

status'created' | 'invoked' | 'in-progress' | 'completed' | 'failed' | 'cancelled' | 'marked-for-delete' | 'polled-for-execution' | 'skipped'
tagstring
tostring
updatedstring
updaterstring
warehouse_typestring