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 Server InfoΒΆ
Get general server info
URI Template
GET /api
Response Type
interface GetServerInfoResponse {
// Yamcs version derived on build time.
yamcsVersion: string;
// Yamcs SHA-1 revision identifier. Set on
// build time, but only if the git command
// was available.
revision: string;
// An identifier for this server. Used in
// system parameters.
serverId: string;
// A default instance for this Yamcs installation.
// This is a calculated suggestion. UI clients may ignore.
defaultYamcsInstance: string;
// Plugins loaded within this server instance
plugins: PluginInfo[];
// Additional options available to commands
commandOptions: CommandOptionInfo[];
}
Related Types
interface PluginInfo {
name: string;
description: string;
version: string;
vendor: string;
}
interface CommandOptionInfo {
id: string;
verboseName: string;
type: string;
help: string;
}