Update Dataset Filter

Update Dataset Filter

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

Overview

This API updates the values of a Dataset filter.

Method: POST

Request URL: {kyvos-url}/rest/v2/datasets/{name-or-id}/filters


Authorization

API Key: sessionid

This method authenticates requests using a session ID which acts like an API key.


BasicAuth: HTTP Authorization Scheme

This method authenticates requests using a username and password sent in the HTTP Authorization header.


Headers

Header Name

Type

Description

Possible Values

Header Name

Type

Description

Possible Values

Content-Type (Required)

String

Specifies the media type of the request body.

application/x-www-form-urlencoded

sessionid

String

The session ID is the token received from the login API.

Note: Session ID is required for token-based authentication.

–


Path Parameters

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

name-or-id (Required)

String

Name or ID of the Dataset whose filter values need to be updated.

Note: If the Dataset name is provided, either folderName or folderId must also be provided.

–


Query Parameters

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

by

String

Specifies whether the name-or-id parameter should be interpreted as a Dataset name or a Dataset ID.

If by=name, provide the Dataset name in the name-or-id parameter.

If by=id, provide the Dataset ID in the name-or-id parameter.

The default value is name.

–

folderName

String

Name of the folder containing the Dataset. If the Dataset is present in the root directory, specify [Root].

Note: If neither folderName nor folderId is provided, the Dataset will be treated as a root-level entity by default.

–

folderId

String

ID of the folder containing the Dataset.

–


Request Body

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

columnName (Required)

String

Name of the column on which the filter needs to be applied.

–

value (Required)

String

Primary filter value for the specified column.

–

secondValue

String

Optional secondary filter value used in special cases such as BETWEEN conditions or range-based filters.

–


Responses

200 Success

{ "code": 0, "message": "Successfully replaced dataset: RestApiTest" }

Status Code

Description

Status Code

Description

401

Authorization information is missing or invalid.

404

No matching record found.

412

Required parameter is missing.

500

Internal Server Error.


Copyright Kyvos, Inc. 2026. All rights reserved.