/  Yamcs HTTP API  /  Processing  /  Create Processor

Create ProcessorΒΆ

Create a processor

URI Template

POST /api/processors

Request Body

// Request message for `CreateProcessor`.
interface CreateProcessorRequest {

  // **Required.** The name of the Yamcs instance.
  instance: string;

  // **Required.** The name of the processor. Must be unique for the Yamcs instance.
  name: string;

  // Keep the processor when terminated. Default: ``no``.
  persistent: boolean;

  // **Required.** The type of the processor. The available values depend on how
  // Yamcs Server is configured. Most Yamcs deployments support at least a type
  // ``Archive`` which allows for the creation of processors replaying archived
  // data.
  type: string;

  // Configuration options specific to the processor type. Note that this should
  // be a string representation of a valid JSON structure.
  config: string;
}