Docs / Yamcs HTTP API / Instances / List Instances

List Instances

List all configured Yamcs instances:

GET /api/instances

Response

Status: 200 OK
{
  "instance" : [ {
    "name" : "simulator",
    "missionDatabase" : {
      "configName" : "landing",
      "name" : "",
      "spaceSystem" : [ {
        "name" : "yamcs",
        "qualifiedName" : "/yamcs"
      }, {
        "name" : "YSS",
        "qualifiedName" : "/YSS",
        "sub" : [ {
          "name" : "SIMULATOR",
          "qualifiedName" : "/YSS/SIMULATOR"
        } ]
      }, {
        "name" : "GS",
        "qualifiedName" : "/GS"
      } ]
    },
    "processor" : [ {
      "name" : "realtime"
    } ]
  } ]
}

Alternative Media Types

Protobuf

Use HTTP header:

Accept: application/protobuf

Response is of type:

rest/rest.proto 
message ListInstancesResponse {
  repeated yamcsManagement.YamcsInstance instance = 1;
}