Docs / Yamcs HTTP API / Links / List Links

List Links

List all links:

GET /api/links

List all links for the given Yamcs instance:

GET /api/links/:instance 

Response

Status: 200 OK
{
  "link" : [ {
    "instance" : "simulator",
    "name" : "tm1",
    "type" : "HkDataHandler",
    "spec" : "",
    "stream" : "tm_realtime",
    "disabled" : false,
    "status" : "OK",
    "dataCount" : 34598,
    "detailedStatus" : "reading files from /storage/yamcs-incoming/simulator/tm"
  } ]
}

Alternative Media Types

Protobuf

Use HTTP header:

Accept: application/protobuf

Response is of type:

rest/rest.proto 
message ListLinkInfoResponse {
  repeated yamcsManagement.LinkInfo link = 1;
}