Docs / Yamcs HTTP API / Processors / List Processors

List Processors

List all processors, across all Yamcs instances:

GET /api/processors

List all processors for the given Yamcs instance:

GET /api/processors/:instance

Parameters

Name Type Description
type string Indicates the type of the processors to return. Can be either replay, realtime or all. Default: all

Response

Status: 200 OK
{
  "processor" : [ {
    "instance" : "simulator",
    "name" : "realtime",
    "type" : "realtime",
    "creator" : "system",
    "hasCommanding" : true,
    "state" : "RUNNING"
  } ]
}

Alternative Media Types

Protobuf

Use HTTP header:

Accept: application/protobuf

Response is of type:

rest/rest.proto 
message ListProcessorsResponse {
  repeated yamcsManagement.ProcessorInfo processor = 1;
}