/  Yamcs HTTP API  /  File Transfer  /  Subscribe Remote File List

Subscribe Remote File ListΒΆ

Subscribe to remote file list updates

WebSocket

This method requires to upgrade an HTTP connection to WebSocket. See details on how Yamcs uses WebSocket.

Use the message type remote-file-list.

Input Type

interface SubscribeTransfersRequest {

  // Yamcs instance name
  instance: string;

  // File transfer service name
  serviceName: string;
}

Output Type

interface ListFilesResponse {
  files: RemoteFile[];
  destination: string;
  remotePath: string;
  listTime: string;  // RFC 3339 timestamp
  state: string;
}

Related Types

interface RemoteFile {

  // File identifier
  //
  // Typically, a remote file path, or a filename
  // in case of a flat file table.
  name: string;

  // Optional display name. Can be used when the ``name``
  // field contains information that should be hidden from the user.
  displayName: string;

  // True if the path represents a directory
  isDirectory: boolean;

  // File size
  size: string;  // String decimal

  // Modification time
  modified: string;  // RFC 3339 timestamp

  // Implementation-specific fields
  extra: {[key: string]: any};
}