Get

GET

file_rules

{file_rule_id}

curl (Linux)

curl \
  --unix-socket /run/miru/miru.sock \
  --request GET \
  --url http://localhost/v0.2/file_rules/{file_rule_id}

$api = Get-Content -Raw "$env:ProgramData\Miru\device-api\device-api.json" | ConvertFrom-Json; `
Invoke-RestMethod -Method Get `
  -Uri "http://127.0.0.1:$($api.port)/v0.2/file_rules/{file_rule_id}" `
  -Headers @{ Authorization = "Bearer $($api.token)" }

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost/v0.2/file_rules/{file_rule_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/v0.2/file_rules/{file_rule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost/v0.2/file_rules/{file_rule_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost/v0.2/file_rules/{file_rule_id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "object": "file_rule",
  "id": "file_rule_123",
  "name": "Robot Logs",
  "digest": "sha256:1234567890",
  "os": "linux",
  "source": {
    "glob": "/var/log/robot/*.log",
    "stability_window_secs": 60
  },
  "upload": {
    "upload_collection_id": "upl_col_123",
    "upload_collection_name": "Robot Logs",
    "bucket_id": "bkt_123",
    "bucket_name": "my-uploads-bucket",
    "path": "{device_id}/{year}-{month}-{day}/{upload_id}/{file_name}",
    "timezone": "utc"
  },
  "retention": {
    "require_upload": true,
    "ttl_secs": 604800
  },
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

Authorizations

Authorization

string

header

required

The token from the agent's discovery file (%ProgramData%\Miru\device-api\device-api.json on Windows). Required over loopback TCP (127.0.0.1:6478 by default on Windows) and accepted by every route; not used over the Unix socket.

Path Parameters

file_rule_id

string

required

The unique identifier of the file rule.

Example:

"file_rule_123"

Response

200 - application/json

Successfully retrieved the file rule.

A file rule declares which files on a device Miru manages and whether to upload them, delete them, or both.

object

enum<string>

required

The object type, which is always file_rule.

Available options:

file_rule

Example:

"file_rule"

string

required

ID of the file rule.

Example:

"file_rule_123"

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.

Example:

"Robot Logs"

digest

string

required

The digest of the file rule. File rules are immutable and deduplicated by digest within a workspace.

Example:

"sha256:1234567890"

enum<string>

required

The operating system family this file rule targets, derived from source.glob: a glob starting with / is linux, and a glob starting with a drive letter is windows. Read-only: clients cannot set it.

Available options:

linux,

windows

Example:

"linux"

source

File Rule Source · object

required

Show child attributes

Example:

{
  "glob": "/var/log/robot/*.log",
  "stability_window_secs": 60
}

created_at

string<date-time>

required

Timestamp of when the file rule was created.

Example:

"2021-01-01T00:00:00Z"

updated_at

string<date-time>

required

Timestamp of when the file rule was last updated.

Example:

"2021-01-01T00:00:00Z"

upload

File Rule Upload · object

Where matching files are uploaded. Absent when the rule only enforces local retention.

Show child attributes

Example:

{
  "upload_collection_id": "upl_col_123",
  "upload_collection_name": "Robot Logs",
  "bucket_id": "bkt_123",
  "bucket_name": "my-uploads-bucket",
  "path": "{device_id}/{year}-{month}-{day}/{upload_id}/{file_name}",
  "timezone": "utc"
}

retention

File Rule Retention · object

Governs deletion of the local copies of matching files. Absent when the device keeps matching files indefinitely — Miru never deletes them; present when the rule deletes each matching file once its retention guarantee ends.

Show child attributes

Example:

{
  "require_upload": true,
  "ttl_secs": 604800
}

⌘I

curl (Linux)

curl \
  --unix-socket /run/miru/miru.sock \
  --request GET \
  --url http://localhost/v0.2/file_rules/{file_rule_id}

$api = Get-Content -Raw "$env:ProgramData\Miru\device-api\device-api.json" | ConvertFrom-Json; `
Invoke-RestMethod -Method Get `
  -Uri "http://127.0.0.1:$($api.port)/v0.2/file_rules/{file_rule_id}" `
  -Headers @{ Authorization = "Bearer $($api.token)" }

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost/v0.2/file_rules/{file_rule_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/v0.2/file_rules/{file_rule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost/v0.2/file_rules/{file_rule_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost/v0.2/file_rules/{file_rule_id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "object": "file_rule",
  "id": "file_rule_123",
  "name": "Robot Logs",
  "digest": "sha256:1234567890",
  "os": "linux",
  "source": {
    "glob": "/var/log/robot/*.log",
    "stability_window_secs": 60
  },
  "upload": {
    "upload_collection_id": "upl_col_123",
    "upload_collection_name": "Robot Logs",
    "bucket_id": "bkt_123",
    "bucket_name": "my-uploads-bucket",
    "path": "{device_id}/{year}-{month}-{day}/{upload_id}/{file_name}",
    "timezone": "utc"
  },
  "retention": {
    "require_upload": true,
    "ttl_secs": 604800
  },
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

Agent

Calibrations

Deployments

Device

Events

File Rules

Git Commits

Releases

Authorizations

Path Parameters

Response