--- title: "PUT /v1/orgs/{org_id}/rehydration/{rehydration_id}" method: PUT path: "/v1/orgs/{org_id}/rehydration/{rehydration_id}" tags: ["Rehydrations"] --- # PUT /v1/orgs/{org_id}/rehydration/{rehydration_id} `PUT /v1/orgs/{org_id}/rehydration/{rehydration_id}` A rehydration object can only be updated to CANCELLED state, otherwise it's immutable ## Path parameters - `org_id` string, required - `rehydration_id` string, required ## Request body - CoreRehydration - `archive_flush_interval` string — 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 - `archive_source` CoreArchiveReference - `bucket` string - `bucket_prefix` string - `format` string - `node_name` string - `order` string[] - `tag` string - `type` string - `assigned_cluster` string — 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 - `bucket` string - `checkpoint` string — Checkpoint is the last object key the rehydration job processed. Shouldn't be shown to user - `checkpoint_v2` string — 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_query` string - `created` string — Created & Updated are timestamps in core.StorageTimeFormat - `creator` string - `destination` string - `dynamic_url` string - `error` string - `exclude_overlap` boolean — ExcludeOverlap exclude logs rehydrated by existing rehydrations - `facets` object — Facets are used to filter rehydrations with facet_options api - `from` string — From & To are timestamps in core.URLTimeFormat - `host` string - `keyword_filter` string - `metrics` CoreRehydrationMetrics - `average_chunk_size_bytes` integer - `average_chunk_size_count` integer - `batch_duration_samples_count` integer - `batch_p50_ms` integer - `batch_p90_ms` integer - `chunk_metrics` object - `chunks_built` integer - `env_variables` object - `latency_p50_ms` integer — Latencies - `latency_p90_ms` integer - `latency_samples_count` integer — samples count - `objects_count_after_filter` integer - `objects_listed` integer - `read_latency_p50_ms` integer - `read_latency_p90_ms` integer - `read_latency_samples_count` integer - `tasks_failed` integer - `tasks_processed` integer - `tasks_published` integer - `total_bytes_read` integer - `total_bytes_streamed` integer - `total_failed_bytes_streamed` integer - `total_failed_rows_streamed` integer - `total_filtered_rows` integer - `total_invalid_rows` integer - `total_list_requests` integer - `total_rows_read` integer - `total_rows_streamed` integer - `total_slice_count` integer - `total_uncompressed_bytes_read` integer - `write_latency_samples_count` integer - `write_p50_ms` integer - `write_p90_ms` integer - `org_id` string - `ottl_query` string — Field to save OTTL query filter - `percentage` number — Percentage is duplicated here for org level rehydrations, omitted in individual rehydrations because RehydrationWithStatus is used instead - `prefix_filter` string — Prefix and prefix regex are used to filter rehydrations with prefix filter - `prefix_regex` string - `process_stats` CoreRehydrationProcessStats - `batch_push_latency` integer - `bytes_count` integer - `forwarding_batches_count` integer - `forwarding_end_time` string - `forwarding_start_time` string - `invalid` integer - `query_execution_time` integer — milliseconds - `query_results_parsing_time` integer — milliseconds - `results_forwarding_time` integer — milliseconds - `scanned` integer - `streamed` integer - `streamed_bytes_count` integer - `successful_bytes_count` integer - `rehydration_id` string - `source_filters` object - `source_integration` string — TODO delete after Box migration - `status` 'created' | 'invoked' | 'in-progress' | 'completed' | 'failed' | 'cancelled' | 'marked-for-delete' | 'polled-for-execution' | 'skipped' - `tag` string - `to` string - `updated` string - `updater` string - `warehouse_type` string ## Response `200` OK - CoreRehydration - `archive_flush_interval` string — 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 - `archive_source` CoreArchiveReference - `bucket` string - `bucket_prefix` string - `format` string - `node_name` string - `order` string[] - `tag` string - `type` string - `assigned_cluster` string — 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 - `bucket` string - `checkpoint` string — Checkpoint is the last object key the rehydration job processed. Shouldn't be shown to user - `checkpoint_v2` string — 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_query` string - `created` string — Created & Updated are timestamps in core.StorageTimeFormat - `creator` string - `destination` string - `dynamic_url` string - `error` string - `exclude_overlap` boolean — ExcludeOverlap exclude logs rehydrated by existing rehydrations - `facets` object — Facets are used to filter rehydrations with facet_options api - `from` string — From & To are timestamps in core.URLTimeFormat - `host` string - `keyword_filter` string - `metrics` CoreRehydrationMetrics - `average_chunk_size_bytes` integer - `average_chunk_size_count` integer - `batch_duration_samples_count` integer - `batch_p50_ms` integer - `batch_p90_ms` integer - `chunk_metrics` object - `chunks_built` integer - `env_variables` object - `latency_p50_ms` integer — Latencies - `latency_p90_ms` integer - `latency_samples_count` integer — samples count - `objects_count_after_filter` integer - `objects_listed` integer - `read_latency_p50_ms` integer - `read_latency_p90_ms` integer - `read_latency_samples_count` integer - `tasks_failed` integer - `tasks_processed` integer - `tasks_published` integer - `total_bytes_read` integer - `total_bytes_streamed` integer - `total_failed_bytes_streamed` integer - `total_failed_rows_streamed` integer - `total_filtered_rows` integer - `total_invalid_rows` integer - `total_list_requests` integer - `total_rows_read` integer - `total_rows_streamed` integer - `total_slice_count` integer - `total_uncompressed_bytes_read` integer - `write_latency_samples_count` integer - `write_p50_ms` integer - `write_p90_ms` integer - `org_id` string - `ottl_query` string — Field to save OTTL query filter - `percentage` number — Percentage is duplicated here for org level rehydrations, omitted in individual rehydrations because RehydrationWithStatus is used instead - `prefix_filter` string — Prefix and prefix regex are used to filter rehydrations with prefix filter - `prefix_regex` string - `process_stats` CoreRehydrationProcessStats - `batch_push_latency` integer - `bytes_count` integer - `forwarding_batches_count` integer - `forwarding_end_time` string - `forwarding_start_time` string - `invalid` integer - `query_execution_time` integer — milliseconds - `query_results_parsing_time` integer — milliseconds - `results_forwarding_time` integer — milliseconds - `scanned` integer - `streamed` integer - `streamed_bytes_count` integer - `successful_bytes_count` integer - `rehydration_id` string - `source_filters` object - `source_integration` string — TODO delete after Box migration - `status` 'created' | 'invoked' | 'in-progress' | 'completed' | 'failed' | 'cancelled' | 'marked-for-delete' | 'polled-for-execution' | 'skipped' - `tag` string - `to` string - `updated` string - `updater` string - `warehouse_type` string --- [API](https://skmtc.net/edgedelta/apis/edge-delta-api.md) · [All operations](https://skmtc.net/edgedelta/apis/edge-delta-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/edgedelta/edge-delta-api/revisions/ae0e90c2c794/schema)