Docs / Yamcs HTTP API / Tags / Create Tag

Create Tag

Create a tag for the given archive instance:

POST /api/archive/:instance/tags

Parameters

Name Type Description
name string Required. The name of the tag.
description string The description of the tag.
start string The start time of the tag. Default is unbounded.
stop string The stop time of the tag. Default is unbounded.
color string The color of the tag. Must be an RGB hex color, e.g. #ff0000

Example

Create a red tag covering January 1st 2015, onwards:

{
  "name" : "My archive annotation",
  "start" : "2015-01-01T00:00:00.000Z",
  "color" : "#ff0000"
}

Alternative Media Types

Protobuf

Use these HTTP headers:

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

Request is of type:

rest/rest.proto 
message CreateTagRequest {
  optional string name = 1;
  optional string start = 2;
  optional string stop = 3;
  optional string description = 4;
  optional string color = 5;
}