Docs / Yamcs HTTP API / Clients / Edit Client

Edit Client

Edit a client:

PATCH /api/clients/:id

Parameters

Name Type Description
instance string The instance. If unspecified, this defaults to the instance that the client is currently connected to.
processor string The processor. If instance is provided and processor is not, then this will default to the default processor for that instance.

Example

Update the client’s processor to replay123:

{
  "processor" : "replay123"
}

Later on, leave the replay and switch to the default processor (e.g. realtime) on the simulator instance:

{
  "instance" : "simulator"
}

Alternative Media Types

Protobuf

Use these HTTP headers:

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

Request is of type:

rest/rest.proto 
message EditClientRequest {
  optional string instance = 1;
  optional string processor = 2;
}