Recording Attachments

A recording attachment resource represents information about an MCAP attachment imported to Foxglove.

Attachments are available for individual download or with their recording.

Operations

List attachments

Request

Security

ApiKey(Required scopes: recordings.list)

Query

recordingIdstring

filter by recording ID

siteIdstring

filter by Primary Site ID

deviceIdstring

filter by device ID

deviceNamestring

filter by device name

device.idstringdeprecated

Equivalent to deviceId, and ignored if deviceId is supplied

device.namestringdeprecated

Equivalent to deviceName, and ignored if deviceName is supplied

sortBystring

Sort by a single field of the attachment

Value:"logTime"

projectIdstring

Filter attachments by project

sortOrderstring

Sort order for the sortBy field

Enum:"asc""desc"

limitnumber, [ 0 .. 2000 ]

Maximum number of items to return

Default:2000

offsetinteger, >= 0

Number of items to skip before returning the results

Default:0

Python

from foxglove.client import Client

token = "<YOUR API TOKEN HERE>"
client = Client(token=token)

client.get_attachments()

Responses

Success

Bodyapplication/json

Array [

idstringrequired

ID of the attachment

recordingIdstringrequired

ID of the recording with which the attachment is associated

siteIdstringrequired

ID of the Primary Site where the attachment data is stored

namestringrequired

Name field from the attachment record

mediaTypestringrequired

Media type from the attachment record

logTimestringrequired

Log time field from the attachment record

createTimestringrequired

Create time field from the attachment record

crcnumberrequired

CRC field from the attachment record as a decimal number

dataOffsetinteger

Offset to the start of the attachment in bytes

sizeintegerrequired

Size of the attachment in bytes

fingerprintstringrequired

A hash of the attachment content (algorithm subject to change). Two attachments with the same fingerprint will have identical content.

lakePathstring

Path of attachment in lake storage. Only provided for self-hosted Primary Sites.

]

Response

[
  {
    "id": "string",
    "recordingId": "string",
    "siteId": "string",
    "name": "string",
    "mediaType": "string",
    "logTime": "string",
    "createTime": "string",
    "crc": 0,
    "dataOffset": 0,
    "size": 0,
    "fingerprint": "string",
    "lakePath": "string"
  }
]