LogoDocumentation

Lake Files

lake_files

Methods

List Lake Files -> Array<{ path, topics }>
get/lake-files

This endpoint returns a list of MCAP files in the lake bucket for a given Primary Site.

For each recording that has been imported, multiple files are created — one per topic.

This endpoint is only supported for self-managed sites.

A query must be limited to a device or recording using one of the following parameters:

  • deviceId
  • deviceName
  • recordingId
  • recordingKey

If querying by a device (ID or name), you must also provide start and end parameters to limit the range of files included.

The range expressed by start and end must not exceed 24h.

query Parameters
siteId: string

The ID of a self-managed Primary Site for which the files have been imported

deviceId: string
Optional

ID of the device associated with the imported files

deviceName: string
Optional

Name of the device associated with the imported files

end: string
Optional
(format: date-time)

Inclusive end of an imported recording's time range. If end is provided, start must be too.

recordingId: string
Optional

A recording ID for which the files have been imported

recordingKey: string
Optional

A recording key for which the files have been imported

start: string
Optional
(format: date-time)

Inclusive start of an imported recording's time range. If start is provided, end must be too.

topic: string
Optional

Include only imported files matching this topic name

Response fields
path: string

The full path of the file in the lake bucket

topics: Array<string>

The topic names associated with this file

Request example
200Example