Streams Tags

Stream metadata is represented as a dictionary of string keys and associated string values. It can be used to associate additional information with a stream. Stream tags are represented as a list of strings. Tags can be used to categorize or denote special attributes of streams. The Stream Metadata API And Stream Tags API do not accept the search query parameter in their respective GET methods. However, stream tags and metadata can be used as criteria in search query strings to return stream results with the Streams API.

List Stream Tags

Returns the tag list for the specified stream.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Tags

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamId
Stream identifier.

Response

Example response body

200 Response

[
  "tag1",
  "tag2"
]

400 Response (ErrorResponseBody)

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  }
}

Update Stream Tags

Replaces the tag list for the specified stream with the tags listed in the request body. Overwrites any existing tags; does not merge.

Request

PUT /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Tags

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamId
Stream identifier.

Response

Example response body

200 Response

[
  "tag1",
  "tag2"
]

400 Response (ErrorResponseBody)

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  }
}

Delete Stream Tags

Deletes the tag list for the specified stream.

Request

DELETE /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Streams/{streamId}/Tags

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string streamId
Stream identifier.

Response

Definitions

ErrorResponseBody

Properties

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  }
}