/  Yamcs HTTP API  /  Clearance  /  Subscribe Clearance

Subscribe ClearanceΒΆ

Receive updates on own clearance

WebSocket

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

Use the message type clearance.

Output Type

interface ClearanceInfo {
  username: string;
  level: SignificanceLevelType;
  issuedBy: string;
  issueTime: string;  // RFC 3339 timestamp
  hasCommandPrivileges: boolean;
}

Related Types

enum SignificanceLevelType {
  NONE = "NONE",
  WATCH = "WATCH",
  WARNING = "WARNING",
  DISTRESS = "DISTRESS",
  CRITICAL = "CRITICAL",
  SEVERE = "SEVERE",
}