Docs / Yamcs HTTP API / Processors / Get Processor Info

Get Processor Info

Get info on a specific Yamcs processor:

GET /api/processors/:instance/:name

Response

Status: 200 OK
{
  "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:

yamcsManagement/yamcsManagement.proto 
message ProcessorInfo {
  optional string instance = 1;
  optional string name = 2;
  optional string type = 3;
  optional string spec = 4;
  optional string creator = 5;
  optional bool hasCommanding = 6;
  optional ServiceState state = 7;
  optional yamcs.ReplayRequest replayRequest = 8;
  optional yamcs.ReplayStatus.ReplayState replayState = 9;
}