List Clients¶

List clients

Warning

It is recommended to avoid using this method. It dates from a time when clients were not knowledgeable about Yamcs and their state had to be managed server-side. Nowadays we are favouring stateless APIs and leave state management entirely to the client software.

URI Template

GET /api/clients

Response Type

interface ListClientsResponse {
  clients: ClientInfo[];
}

Related Types

interface ClientInfo {
  id: number;
  username: string;
  applicationName: string;
  address: string;
  instance: string;
  processorName: string;
  state: ClientState;
  loginTime: string;  // RFC 3339
}

enum ClientState {
  CONNECTED = "CONNECTED",
  DISCONNECTED = "DISCONNECTED",
}