Skip to main content
GET
Get

Authorizations

X-API-Key
string
header
required

The API key to use for authentication.

Headers

Miru-Version
string
required

The API version the client was built against.

Example:

"2026-10-28.everglades"

Path Parameters

calibration_id
string
required

The unique identifier of the calibration.

Example:

"cal_123"

Query Parameters

expand
enum<string>[]

Fields to expand on the calibration.

Available options:
content
Example:

Response

200 - application/json

Successfully retrieved the calibration.

One calibration reported by a device for a unit of a component. Calibrations are immutable and append-only; a device's history is kept per component, role, and aspect. Content is at most 1 MiB.

object
enum<string>
required

The object type, which is always calibration.

Available options:
calibration
Example:

"calibration"

id
string
required

ID of the calibration, generated by Miru.

Example:

"cal_123"

device_id
string
required

ID of the device that reported the calibration.

Example:

"dvc_123"

component_id
string
required

ID of the component the calibrated unit belongs to.

Example:

"cmp_123"

role_id
string | null
required

ID of the component role the calibrated unit fills; null if no role was reported.

Example:

"cmp_rol_123"

aspect_id
string | null
required

ID of the component aspect that was calibrated; null if no aspect was reported.

Example:

"cmp_asp_123"

serial_number
string | null
required

Serial number of the physical unit that was calibrated, not of the device, such as SN-1234, or null if none was reported. Free text, at most 255 characters.

Maximum string length: 255
Example:

"SN-1234"

digest
string
required

Digest of the content, formatted as sha256: followed by 64 lowercase hex characters.

Example:

"sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"

deployment_id
string | null
required

ID of the deployment the device was on when it reported the calibration; null if it had none or the deployment was deleted.

Example:

"dpl_123"

operator_id
string | null
required

ID of the operator the device reported as running the calibration; null if no operator was reported.

Example:

"opr_123"

report_id
string<uuid>
required

ID the agent gave the report this calibration came from.

Example:

"0b6f3c2e-6a51-4e0f-9a43-2f1d7c9e8b10"

reported_at
string<date-time>
required

Timestamp of when the calibration was reported to the agent on the device. The agent may upload it much later, for example after an outage, so this can be well before created_at.

Example:

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

created_at
string<date-time>
required

Timestamp of when Miru recorded the calibration.

Example:

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

content
Instance Content · object

The calibration's content. Expand using expand=content in the query string.

Example: