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
- 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
Get Instance TemplateΒΆ
Get an instance template
URI Template
GET /api/instance-templates/{template}
{template}
Template name.
Response Type
interface InstanceTemplate {
// Template name.
name: string;
// Human-friendly description
description: string;
// List of variables that this template may expect
variables: TemplateVariable[];
}
Related Types
interface TemplateVariable {
// Variable name.
name: string;
// Verbose name for use in UI forms
label: string;
// Type of variable (Java class extending org.yamcs.templating.Variable)
type: string;
// Verbose user guidance (HTML)
help: string;
// Whether this variable is required input
required: boolean;
// List of valid choices
choices: string[];
// Initial value for use in UI forms
initial: string;
}