REST_API_COMPATIBILITY_VERSION

REST_API_COMPATIBILITY_VERSION

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

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

Description:

The property controls the API Response format based on the specified value.

Values and behavior:

Possible values: 1 and 2

  • 1: The value ‘1’ will show the old response

  • 2: The value '2' will display new responses for all the get API.

Syntax:

REST_API_COMPATIBILITY_VERSION=1

Default value:

The default value is 1.

Scope:

Kyvos REST API Response

Comes into effect:

This is a hot deployed property. The administrator can change its value, which will be applied immediately after changing its value.

No Kyvos Manager restart is required.

Environment:

Applicable in all environments.

Copyright Kyvos, Inc. 2026. All rights reserved.