LogoDocumentation

Recordings

recordings

Methods

List Recordings -> OffsetPage<
Recording
>
get/recordings

List recordings

Get A Recording ->
Recording
get/recordings/{keyOrId}

Get details on a specific recording.

Delete A Recording -> { recordingId }
delete/recordings/{keyOrId}

Deletes a recording. Deleting a recording also deletes the data for that recording (including attachments, messages, metadata, etc).

Note: For recordings stored at an Edge Site, this method deletes only the imported data for that recording, leaving the edge copy intact.

Import From Edge -> { id, importStatus }
post/recordings/{keyOrId}/import

Request import of a recording from an Edge Site to a Primary Site. Importing a recording makes the data (messages, metadata, attachments, etc.) available for download and streaming.

If the recording is successfully queued for import, is already imported, or already queued for import, this endpoint will return a 200 response and include the recording ID and the importStatus.

An import status of complete indicates the recording is already imported. Poll the GET v1/recordings/{id} endpoint to observe changes to the importStatus.

If the recording cannot be found or is unavailable for import because the edge copy or site is deleted, this endpoint will return a 404 response.

Domain types

DeviceSummary = { id, name }

ID and name of a device.

Recording = { id, createdAt, end, 10 more... }

A resource representing the content of an MCAP file or ROS bag managed by Foxglove.

RecordingImportStatus = "none" | "pending" | "importing" | 2 more...

The import status of recordings. Status will be one of:

  • none: The recording has not yet been imported, and import has not been requested.
  • pending: Foxglove has received a request to import this recording.
  • importing: The recording data is being processed for access via Foxglove.
  • failed: The recording data could not be imported.
  • complete: The contents of the recording are available for access via Foxglove.

Note: none and pending statuses are applicable only to recordings originating from an Edge Site or Foxglove Agent.

The set of importStatus values may expand in the future.

SiteSummary = { id, name }

ID and name of a site.

Recordings

Recording Attachments

recordings.recording_attachments

Methods

List Attachments -> OffsetPage<
RecordingAttachment
>
get/recording-attachments

List attachments

Get An Attachment ->
RecordingAttachment
get/recording-attachments/{id}

Get an attachment

path Parameters
id: string
Response fields
RecordingAttachment
Request example
200Example
Download An Attachment ->
get/recording-attachments/{id}/download

To download an attachment make a request to this endpoint and follow the 302 redirect. The attachment will download directly from the Primary Site.

Note: The redirect link expires after 15 minutes.

Domain types

RecordingAttachment = { id, crc, createTime, 8 more... }

An attachment resource represents information about an MCAP attachment imported to Foxglove.