Lake files

MCAP files stored in the lake bucket of a self-hosted Primary Site. You must have an Enterprise account to use lake file endpoints.

Operations

List lake files

Request

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 specific 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 unless a recording or session selector is supplied. Queries for a specific recording or session do not require start and end, even when a device filter is supplied.

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

Security

ApiKey(Required scopes: data.stream)

Query

siteIdstringrequired

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

deviceIdstring, non-empty

ID of the device associated with the imported files

deviceNamestring, non-empty

Name of the device associated with the imported files

recordingIdstring, non-empty

A recording ID for which the files have been imported

recordingKeystring, non-empty

A recording key for which the files have been imported

sessionIdstring, non-empty

Filter to files for recordings in the session with this ID

sessionKeystring, non-empty

Filter to files for recordings in the session with this key

startstring, (date-time)

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

endstring, (date-time)

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

topicstring

Include only imported files matching this topic name

Payload

// No request payload

Responses

Success

Bodyapplication/json

Array [

pathstringrequired

The full path of the file in the lake bucket

topicsArray of stringsrequired

The topic names associated with this file

]

Response

[
  {
    "path": "string",
    "topics": [ … ]
  }
]