Update Link¶

Update a link

URI Template

PATCH /api/links/{instance}/{name}

{instance}: Yamcs instance name.
{name}: Link name.

Request Body

interface EditLinkRequest {

  // The state of the link. Either ``enabled`` or ``disabled``.
  state: string;
  resetCounters: boolean;
}

Response Type

interface LinkInfo {
  instance: string;
  name: string;
  type: string;
  spec: string;
  disabled: boolean;
  status: string;
  dataInCount: string;  // String decimal
  dataOutCount: string;  // String decimal
  detailedStatus: string;

  //if this is a sublink of an aggregated data link, this is the name of the parent
  parentName: string;
}