Yamcs HTTP API
- Activities
- Alarms
- Audit
- Buckets
- Clearance
- Commands
- COP-1
- Database
- Events
- File Transfer
- IAM
- Indexes
- Instances
- Links
- MDB Override
- MDB
- Packets
- Parameter Archive
- Parameter Lists
- Parameter Values
- Processing
- List Processor Types
- List Processors
- Get Processor
- Delete Processor
- Edit Processor
- Create Processor
- Get Parameter Value
- Set Parameter Value
- Batch Get Parameter Values
- Batch Set Parameter Values
- Subscribe TM Statistics
- Subscribe Parameters
- Subscribe Processors
- Get Algorithm Status
- Subscribe Algorithm Status
- Get Algorithm Trace
- Edit Algorithm Trace
- Queues
- Replication
- RocksDB
- Server
- Services
- Sessions
- Stream Archive
- Table
- Time Correlation
- Time
- Timeline
Related
Yamcs Release Notes
Yamcs Server Manual
Source Code Documentation
Download this Document
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;
}