Docs / Yamcs HTTP API / Packets / Download Packets

Download Packets

Download archived packets:

GET /api/archive/:instance/downloads/packets

This operation will possibly download a very large file. If you worry about size for your application, check out the support for paged packet retrievals instead.

Parameters

Name Type Description
name array of strings The archived name of the packets. Both these notations are accepted:
  • ?name=/YSS/SIMULATOR/DHS,/YSS/SIMULATOR/Power
  • ?name[]=/YSS/SIMULATOR/DHS&name[]=/YSS/SIMULATOR/Power
Names must match exactly.
start string Filter the lower bound of the packet's generation time. Specify a date string in ISO 8601 format. This bound is inclusive.
stop string Filter the upper bound of the packet's generation time. Specify a date string in ISO 8601 format. This bound is exclusive.
order string The order of the returned results. Can be either asc or desc. Default: asc

Response

The response will be a stream of self-standing JSON messages.

Alternative Media Types

Raw binary

Use HTTP header:

Accept: application/octet-stream

Or add the query parameter format=raw.

Protobuf

Use HTTP header:

Accept: application/protobuf

The response is a stream of self-standing VarInt delimited messages of type:

yamcs.proto 
message TmPacketData {
  required int64 receptionTime = 1;
  required bytes packet = 2;
  optional int64 generationTime = 3;
  optional int32 sequenceNumber = 4;
  optional NamedObjectId id = 5;
}