---
title: "Get"
method: GET
path: "/file_rules/{file_rule_id}"
tags: ["File Rules"]
---

# Get

`GET /file_rules/{file_rule_id}`

## Request

- Base URL: `http://localhost/v0.2`
- URL: `http://localhost/v0.2/file_rules/{file_rule_id}`
- Auth: one of:
  - none
  - HTTP bearer

Retrieve a file rule by its ID.

## Path parameters

- `file_rule_id` string, required

## Response `200`

Successfully retrieved the file rule.

- BaseFileRule: A file rule declares which files on a device Miru manages and what to do with them: upload them to a bucket, delete the local copies once they are no longer needed, or both. `retention` is optional and marks the rules that delete: when it is absent the device keeps matching files indefinitely — Miru never deletes them — and when it is present the rule deletes each matching file once its retention guarantee ends. A rule that both deletes and uploads always states `retention.require_upload`, so whether local deletion waits for the upload is itself an explicit decision.
  - `object` 'file_rule', required: The object type, which is always `file_rule`.
  - `id` string, required: ID of the file rule.
  - `name` string, required: A human-readable name for the file rule. Not unique within a workspace: file rules are immutable, so each authored revision mints a new rule and several rules may share a name. The name participates in the rule's digest, so renaming a rule mints a new rule.
  - `digest` string, required: The digest of the file rule. File rules are immutable and deduplicated by digest within a workspace.
  - `os` 'linux' | 'windows', required: An operating system family, from the agent's build-time OS vocabulary. Shared across resources (devices, config schemas, file rules, releases). This is the machine-readable OS kind, distinct from a human-readable version string. - `linux` - `windows`
  - `source` FileRuleSource, required
    - `glob` string, required: A glob pattern selecting the files this rule manages. Must be absolute (start with `/` on Linux, or a drive letter followed by `:\` or `:/` on Windows, e.g. `C:\logs\*.log`), at most 1024 bytes, and must contain no `..` segments and no empty path segments.
    - `stability_window_secs` integer, required: How long, in seconds, a matching file's size and modification time must stay unchanged (quiescent) before it is considered finished and eligible for upload. Files in a format with a finalization marker (e.g. MCAP, parquet) are detected directly; this window is the fallback for other files.
  - `upload` FileRuleUpload
    - `upload_collection_id` string, required: ID of the upload collection the resulting uploads are grouped into.
    - `upload_collection_name` string, required: The name of the upload collection the resulting uploads are grouped into.
    - `bucket_id` string, required: ID of the bucket this rule uploads to.
    - `bucket_name` string, required: Name of the bucket this rule uploads to.
    - `path` string, required: The object-path template the collected file is written to. Must contain `{upload_id}` so every upload lands on a distinct object key, be at most 1024 bytes, have balanced braces, and contain no `..` segments and no empty path segments. The supported variables are `{device_id}`, `{device_name}`, `{file_name}`, `{upload_id}`, `{year}`, `{month}`, `{day}`, `{hour}`, and `{minute}`.
  - `retention` FileRuleRetention: The retention block a file rule carries when it deletes local files; a rule without one keeps matching files indefinitely and Miru never deletes them. Retention operates in two phases. The retention guarantee ends once a matching file goes quiescent — its size and modification time have stayed unchanged for `source.stability_window_secs` — and, when `require_upload` is `true`, once its upload has been durably confirmed; the file is then eligible for deletion, and callers may no longer rely on it being present. `ttl_secs` schedules the enforcement that follows: how long the file lives on after the guarantee ends before the device deletes it. Both phases keep running on the device even when no release is deployed, so tearing down a deployment does not silently stop reclaiming disk.
    - `require_upload` boolean: Whether a file must have its upload durably confirmed before it may be deleted. Present exactly when the rule has an `upload` block. When `true`, a slow or failing upload keeps the local file: the device abandons an upload after 9 attempts, so a permanently failing upload retains the file indefinitely. When `false`, the upload is best-effort: the file may be deleted once eligible even if its upload has not completed, and an unfinished upload is abandoned.
    - `ttl_secs` integer, required: How long, in seconds, the file lives on after it becomes eligible for deletion. The clock starts when the retention guarantee ends, not when the file was written: this schedules enforcement of a guarantee that has already ended, so it defers the deletion, not the end of the guarantee. `0` means the file is deleted as soon as it becomes eligible.
  - `created_at` string, date-time, required: Timestamp of when the file rule was created.
  - `updated_at` string, date-time, required: Timestamp of when the file rule was last updated.

---

[API](https://skmtc.dev/mirurobotics/apis/miru-agent-api.md) - [All operations](https://skmtc.dev/mirurobotics/apis/miru-agent-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mirurobotics/apis/miru-agent-api/revisions/dfee2c680841?raw)