Docs / Yamcs HTTP API / Streams / Get Stream Info

Get Stream Info

Get info on a Yamcs stream:

GET /api/archive/:instance/streams/:name

This is low-level API for those cases where access to an internal stream of Yamcs is wanted. It is recommended to use other API operations for any of the default built-in streams.

Response

Status: 200 OK
{
  "name" : "tm_realtime",
  "column" : [ {
    "name" : "gentime",
    "type" : "TIMESTAMP"
  }, {
    "name" : "seqNum",
    "type" : "INT"
  }, {
    "name" : "rectime",
    "type" : "TIMESTAMP"
  }, {
    "name" : "packet",
    "type" : "BINARY"
  } ]
}

Alternative Media Types

Protobuf

Use HTTP header:

Accept: application/protobuf

Response if of type:

archive/archive.proto 
message StreamInfo {
  optional string name = 1;
  repeated ColumnInfo column = 2;
}