Skip to content

SDK does not expose an API to enable Ransom Protection Honeypot #359

@gauravgaush

Description

@gauravgaush

While automating Edge Filer deployment using the CTERA Python SDK, I found that the SDK does not provide a method for enabling the Ransom Protection Honeypot feature.

As a result, automation must fall back to executing a CLI command directly.

## Environment

  • CTERA SDK Version:
  • Edge Filer Version: 7.12.5400.11

## Current SDK Usage

The SDK exposes methods for enabling and configuring ransomware protection:

edge.ransom_protect.enable()

edge.ransom_protect.modify(
    block_users=True,
    detection_threshold=5,
    detection_interval=60
)

However, there is no corresponding SDK method to enable the Honeypot feature.

## Current Workaround

The only way to enable Honeypot is by invoking the Edge CLI:

edge.cli.run_command(
    "set /config/ransomProtect/enableHoneypot true"
)

This introduces a dependency on CLI syntax and reduces the consistency of SDK-based automation.

## Expected Behavior

The SDK should expose a supported method, for example:

edge.ransom_protect.modify(
    block_users=True,
    detection_threshold=5,
    detection_interval=60,
    enable_honeypot=True
)

or

edge.ransom_protect.enable_honeypot(True)

## Impact

Infrastructure automation cannot fully configure ransomware protection using the SDK alone and must rely on CLI commands for a supported product feature.

Providing SDK support for Honeypot configuration would simplify automation and eliminate the need for CLI-based workarounds.

##Sample code used in my automation

def enable_honeypot(self, enabled=True):
    """
    Enable or disable the Ransom Protect honeypot endpoint.

    :param bool, optional enabled: Enable (True) or disable (False) the honeypot.
    """
    param = self.get_configuration()

    if not param.enabled:
        raise CTERAException(
            "Ransom Protect must be enabled before configuring the honeypot"
        )

    param.enableHoneypot = enabled

    self._edge.api.put("/config/ransomProtect/", param)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions