Docs / Yamcs HTTP API / Links / Edit Link

Edit Link

Edit a link:

PATCH /api/links/:instance/:name

Parameters

Name Type Description
state string The state of the link. Either enabled or disabled.

The same parameters can also be specified in the request body. In case both query string parameters and body parameters are specified, they are merged with priority being given to query string parameters.

Example

Enable a link:

{
  "state" : "enabled"
}

Disable a link:

{
  "state" : "disabled"
}

Alternative Media Types

Protobuf

Use these HTTP headers:

Content-Type: application/protobuf
Accept: application/protobuf

Request is of type:

rest/rest.proto 
message EditLinkRequest {
  optional string state = 1;
}