Yamcs HTTP API
- Activities
- Alarms
- Audit
- Buckets
- Clearance
- Commands
- COP-1
- Database
- Events
- File Transfer
- IAM
- Indexes
- Instances
- Links
- MDB Override
- MDB
- Packets
- Parameter Archive
- Parameter Lists
- Parameter Values
- Processing
- Queues
- Replication
- RocksDB
- Server
- Services
- Sessions
- Stream Archive
- Table
- Time Correlation
- Time
- Timeline
Related
Yamcs Server Manual
Yamcs Release Notes
Source Code Documentation
Download this Document
Stream EventsΒΆ
Streams back events
Warning
This method uses server-streaming. Yamcs sends an unspecified amount of data using chunked transfer encoding.
URI Template
POST /api/stream-archive/{instance}:streamEvents
{instance}
Yamcs instance name.
Request Body
interface StreamEventsRequest {
start: string; // RFC 3339 timestamp
stop: string; // RFC 3339 timestamp
source: string[];
severity: string;
q: string;
}
Response Type
interface Event {
source: string;
generationTime: string; // RFC 3339 timestamp
receptionTime: string; // RFC 3339 timestamp
seqNumber: number;
type: string;
message: string;
severity: EventSeverity;
// Set by API when event was posted by a user
createdBy: string;
// Additional properties
extra: {[key: string]: string};
}
Related Types
enum EventSeverity {
INFO = "INFO",
WARNING = "WARNING",
ERROR = "ERROR",
WATCH = "WATCH",
DISTRESS = "DISTRESS",
CRITICAL = "CRITICAL",
SEVERE = "SEVERE",
}