[Yandex Cloud documentation](../../index.md) > [Yandex Managed Service for Valkey™](../index.md) > [Step-by-step guides](index.md) > Clusters > Managing backup policies

# Managing backup policies in Yandex Managed Service for Valkey™

[Backup](../concepts/backup.md) policies give you flexible control over how cluster backups are created and stored. You can configure a schedule for creating full backups and set their retention period.

## Creating a backup policy {#create-policy}

{% list tabs group=instructions %}

- Management console {#console}

    1. Navigate to **Yandex Managed Service for Valkey™**.
    1. Click the name of your cluster and select the **Backups** tab.
    1. On the **Backup** page, select the **Backup policies** tab.
    1. Click **Create policy**.
    1. Specify the parameters of the new policy:

        1. Enter a name and description.
        1. Select one of the backup start options:

            * **Every day**.
            * **By day of the week**. For this option, additionally select one or more days of the week.
            * **Monthly**. For this option, additionally select one or more months and one or more days of the month.

            The backup start time is specified in the [cluster settings](update.md#change-additional-settings).

        1. Configure backup storage. You can store backups for 7 to 1,095 days (up to three years).

    1. Click **Create**.

- CLI {#cli}

    If you do not have the Yandex Cloud CLI yet, [install and initialize it](../../cli/quickstart.md#install).

    The folder used by default is the one specified when [creating](../../cli/operations/profile/profile-create.md) the CLI profile. To change the default folder, use the `yc config set folder-id <folder_ID>` command. You can also specify a different folder for any command using `--folder-name` or `--folder-id`. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

    1. See the description of the CLI command for creating a policy:

        ```bash
        yc managed-redis backup-retention-policy create --help
        ```

    1. Create a policy:

        ```bash
        yc managed-redis backup-retention-policy create \
           --cluster-id <cluster_ID> \
           --policy-name <policy_name> \
           --day-of-month <day_of_month> \
           --month <month> \
           --day-of-week <day_of_week> \
           --retain-for-days <backup_retention_period_in_days> \
           --description <policy_description>
        ```

        Where:

        * `--cluster-id`: Cluster ID. You can get it with the [list of clusters](cluster-list.md#list-clusters).

        * `--day-of-month`: Day of the month. The possible value is `1–31`.
        * `--month`: Month. The possible values are `1–12` or `JAN–DEC`.
        * `--day-of-week`: Day of week. The possible values are `0–6` or `SUN–SAT`.
        * `--retain-for-days`: Backup retention period in days. The possible value range is `7–1095` (up to three years).
        
        The `--day-of-month`, `--month`, and `--day-of-week` define the schedule for creating backups. The schedule is defined as a cron expression without hours and minutes.
        
        Cron expressions also support the following special characters:
        
        * `*`: Selecting all possible values. A backup will be created on each scheduled interval (day or month) when possible, provided it does not conflict with other settings. This option is used by default if the setting is not specified.
        * `,`: Listing multiple values.
        * `–`: Specifying a range of values.
        * `/`: Specifying a step value. For example, `*/3` for the `--day-of-month` setting means a backup will be created every three days.
        
        If no schedule settings are specified, backups are created using the cron expression `* * *`, meaning they run daily.
        
        Examples of cron expressions:
        
        * `1 */6 *`: Backup is created on the first day of the month, every six months.
        * `31 jan SUN`: Backup is created on Sundays in January, and also on January 31.
        * `* * WED`: Backup is created every Wednesday.
        
        You can test your cron expression in this [editor](https://crontab.guru).
        
        Result:
        
        ```text
        policy_id: mdbt553glp51********
        cluster_id: c9q5le6h1a4k********
        policy_name: test-policy
        created_at: "2025-03-25T15:55:50.393000450Z"
        cron:
          day_of_month: "25"
          month: mar
          day_of_week: TUE
        retain_for_days: "300"
        ```

- Terraform {#tf}

    1. Open the current Terraform configuration file with the infrastructure plan.

        For information on how to create this file, see [Creating a cluster](cluster-create.md).

    1. Add a resource description:

        ```hcl
        resource "yandex_mdb_redis_backup_retention_policy" "<policy_name>" {
          cluster_id      = "<cluster_ID>"
          policy_name     = "<policy_name>"
          description     = "<policy_description>"
          retain_for_days = <backup_retention_period_in_days>

          cron = {
            day_of_month = "<day_of_month>"
            day_of_week  = "<day_of_week>"
            month        = "<month>"
          }
        }
        ```

        Where:

        * `cluster_id`: Cluster ID. You can get it with the [list of clusters](cluster-list.md#list-clusters).

        * `retain_for_days`: Backup retention period in days. The possible value range is `7–1095` (up to three years).
        * `cron`: Settings that define the schedule for creating backups.
        
            * `day_of_month`: Day of the month. The possible value is `1–31`.
            * `day_of_week`: Day of week. The possible values are `0–6` or `SUN–SAT`.
            * `month`: Month. The possible values are `1–12` or `JAN–DEC`.
        
            The schedule is defined as a cron expression without hours and minutes.
        
            Cron expressions also support the following special characters:
        
            * `*`: Selecting all possible values. A backup will be created on each scheduled interval (day or month) when possible, provided it does not conflict with other settings. This option is used by default if the setting is not specified.
            * `,`: Listing multiple values.
            * `–`: Specifying a range of values.
            * `/`: Specifying a step value. For example, `*/3` for the `day_of_month` setting means a backup will be created every three days.
        
            If no schedule settings are specified, backups are created using the cron expression `* * *`, meaning they run daily.
        
            Examples of cron expressions:
        
            * `1 */6 *`: Backup is created on the first day of the month, every six months.
            * `31 jan SUN`: Backup is created on Sundays in January, and also on January 31.
            * `* * WED`: Backup is created every Wednesday.
        
            You can test your cron expression in this [editor](https://crontab.guru).

    1. Make sure the configuration files are correct.

        1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.
        1. Run this command:
        
           ```bash
           terraform validate
           ```
        
           Terraform will show any errors found in your configuration files.

    1. Confirm updating the resources.

        1. Run this command to view the planned changes:
        
           ```bash
           terraform plan
           ```
        
           If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.
        
        1. If everything looks correct, apply the changes:
           1. Run this command:
        
              ```bash
              terraform apply
              ```
        
           1. Confirm updating the resources.
           1. Wait for the operation to complete.

        For more information, see [this Terraform provider guide](../../terraform/resources/mdb_redis_backup_retention_policy.md).

- REST API {#api}

    1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable:

        ```bash
        export IAM_TOKEN="<IAM_token>"
        ```

    1. Call the [BackupRetentionPolicy.Create](../api-ref/BackupRetentionPolicy/create.md) method, for instance, via the following [cURL](https://curl.se/) request:

        ```bash
        curl \
          --request POST \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --header "Content-Type: application/json" \
          --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<cluster_ID>/retention_policies' \
          --data '{
                     "cron": {
                       "dayOfMonth": "<day_of_month>",
                       "month": "<month>",
                       "dayOfWeek": "<day_of_week>"
                     },
                     "retainForDays": "<retention_period_in_days>",
                     "description": "<policy_description>",
                     "policyName": "<policy_name>"
                 }'
        ```

        Where:

        * `<cluster_ID>`: Cluster ID which you can get with the [list of clusters](cluster-list.md#list-clusters).

        * `dayOfMonth`: Day of the month. The possible value is `1-31`.
        * `month`: Month. The possible values are `1-12` or `JAN-DEC`.
        * `dayOfWeek`: Day of week. The possible values are `0-6` or `SUN-SAT`.
        * `retainForDays`: Backup retention period in days. The possible value range is `7–1095` (up to three years).
        
        The `dayOfMonth`, `month`, and `dayOfWeek` define the schedule for creating backups. The schedule is defined as a cron expression without hours and minutes.
        
        Cron expressions also support the following special characters:
        
        * `*`: Selecting all possible values. A backup will be created on each scheduled interval (day or month) when possible, provided it does not conflict with other settings. This option is used by default if the setting is not specified.
        * `,`: Listing multiple values.
        * `–`: Specifying a range of values.
        * `/`: Specifying a step value. For example, `*/3` for the `dayOfMonth` setting means a backup will be created every three days.
        
        If no schedule settings are specified, backups are created using the cron expression `* * *`, meaning they run daily.
        
        Examples of cron expressions:
        
        * `1 */6 *`: Backup is created on the first day of the month, every six months.
        * `31 jan SUN`: Backup is created on Sundays in January, and also on January 31.
        * `* * WED`: Backup is created every Wednesday.
        
        You can test your cron expression in this [editor](https://crontab.guru).

    1. Check the [server response](../api-ref/BackupRetentionPolicy/create.md#yandex.cloud.operation.Operation) to make sure your request was successful.

- gRPC API {#grpc-api}

    1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable:

        ```bash
        export IAM_TOKEN="<IAM_token>"
        ```

    1. Clone the [cloudapi](https://github.com/yandex-cloud/cloudapi) repository:
       
       ```bash
       cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
       ```
       
       Below, we assume that the repository contents reside in the `~/cloudapi/` directory.

    1. To create a policy:

        1. Call the [BackupRetentionPolicyService.Create](../api-ref/grpc/BackupRetentionPolicy/create.md) method, for instance, via the following [gRPCurl](https://github.com/fullstorydev/grpcurl) request:

            ```bash
            grpcurl \
                -format json \
                -import-path ~/cloudapi/ \
                -import-path ~/cloudapi/third_party/googleapis/ \
                -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/backup_retention_policy_service.proto \
                -rpc-header "Authorization: Bearer $IAM_TOKEN" \
                -d '{
                      "cluster_id": "<cluster_ID>",
                      "cron": {
                         "day_of_month": "<day_of_month>",
                         "month": "<month>",
                         "day_of_week": "<day_of_week>"
                      },
                      "retain_for_days": "<backup_retention_period_in_days>",
                      "description": "<policy_description>",
                      "policy_name": "<policy_name>"
                    }' \
                mdb.api.cloud.yandex.net:443 \
                yandex.cloud.mdb.redis.v1.BackupRetentionPolicyService.Create
            ```

            Where:

            * `cluster_id`: Cluster ID. You can get it with the [list of clusters](cluster-list.md#list-clusters).

            * `day_of_month`: Day of the month. The possible value is `1–31`.
            * `month`: Month. The possible values are `1–12` or `JAN–DEC`.
            * `day_of_week`: Day of week. The possible values are `0–6` or `SUN–SAT`.
            * `retain_for_days`: Backup retention period in days. The possible value range is `7–1095` (up to three years).
            
            The `day_of_month`, `month`, and `day_of_week` define the schedule for creating backups. The schedule is defined as a cron expression without hours and minutes.
            
            Cron expressions also support the following special characters:
            
            * `*`: Selecting all possible values. A backup will be created on each scheduled interval (day or month) when possible, provided it does not conflict with other settings. This option is used by default if the setting is not specified.
            * `,`: Listing multiple values.
            * `–`: Specifying a range of values.
            * `/`: Specifying a step value. For example, `*/3` for the `day_of_month` setting means a backup will be created every three days.
            
            If no schedule settings are specified, backups are created using the cron expression `* * *`, meaning they run daily.
            
            Examples of cron expressions:
            
            * `1 */6 *`: Backup is created on the first day of the month, every six months.
            * `31 jan SUN`: Backup is created on Sundays in January, and also on January 31.
            * `* * WED`: Backup is created every Wednesday.
            
            You can test your cron expression in this [editor](https://crontab.guru).

        1. Check the [server response](../api-ref/grpc/BackupRetentionPolicy/create.md#yandex.cloud.operation.Operation) to make sure your request was successful.

{% endlist %}


## Getting a list of backup policies {#list-policies}

{% list tabs group=instructions %}

- Management console {#console}

    1. Navigate to **Yandex Managed Service for&nbsp;Valkey™**.
    1. Click the name of your cluster and select the **Backups** tab.
    1. On the **Backup** page, select the **Backup policies** tab.

- CLI {#cli}

    If you do not have the Yandex Cloud CLI yet, [install and initialize it](../../cli/quickstart.md#install).

    The folder used by default is the one specified when [creating](../../cli/operations/profile/profile-create.md) the CLI profile. To change the default folder, use the `yc config set folder-id <folder_ID>` command. You can also specify a different folder for any command using `--folder-name` or `--folder-id`. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

    1. See the description of the CLI command for getting a list of policies:

        ```bash
        yc managed-redis backup-retention-policy list --help
        ```

    1. Get a list of policies for the Yandex Managed Service for Valkey™ cluster:

        ```bash
        yc managed-redis backup-retention-policy list \
           --cluster-id <cluster_ID>
        ```

        You can get the cluster ID from the [cluster list](cluster-list.md#list-clusters).

        Result:
        
        ```text
        +----------------------+-------------+--------------------+------------+-------------------+
        |          ID          |     NAME    |     CLUSTER ID     |  CRONTAB   |  RETENTION PERIOD |
        +----------------------+-------------+--------------------+------------+-------------------+
        | mdbt553glp51******** | test-policy | c9q5le6h1a4******* | 31 JAN SUN |                50 |
        +----------------------+-------------+--------------------+------------+-------------------+
        ```
        
        Order of parameters in the `CRONTAB` column: `--day-of-month`, `--month`, `--day-of-week`.

- REST API {#api}

    1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable:

        ```bash
        export IAM_TOKEN="<IAM_token>"
        ```

    1. Call the [BackupRetentionPolicy.List](../api-ref/BackupRetentionPolicy/list.md) method, for instance, via the following [cURL](https://curl.se/) request:

        ```bash
        curl \
          --request GET \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<cluster_ID>/retention_policies?pageSize=<number_of_results>'
        ```

        Where:

        * `<cluster_ID>`: Cluster ID which you can get with the [list of clusters](cluster-list.md#list-clusters).
        * `pageSize`: Number of query results per page. Specify a number greater than zero.

    1. Check the [server response](../api-ref/BackupRetentionPolicy/list.md#yandex.cloud.mdb.redis.v1.ListBackupRetentionPoliciesResponse) to make sure your request was successful.

- gRPC API {#grpc-api}

    1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable:

        ```bash
        export IAM_TOKEN="<IAM_token>"
        ```

    1. Clone the [cloudapi](https://github.com/yandex-cloud/cloudapi) repository:
       
       ```bash
       cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
       ```
       
       Below, we assume that the repository contents reside in the `~/cloudapi/` directory.

    1. To get a list of policies for a cluster:

        1. Call the [BackupRetentionPolicyService.List](../api-ref/grpc/BackupRetentionPolicy/list.md) method, for instance, via the following [gRPCurl](https://github.com/fullstorydev/grpcurl) request:

            ```bash
            grpcurl \
              -format json \
              -import-path ~/cloudapi/ \
              -import-path ~/cloudapi/third_party/googleapis/ \
              -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/backup_retention_policy_service.proto \
              -rpc-header "Authorization: Bearer $IAM_TOKEN" \
              -d '{
                    "cluster_id": "<cluster_ID>",
                    "page_size": "<number_of_results>"
                  }' \
              mdb.api.cloud.yandex.net:443 \
              yandex.cloud.mdb.redis.v1.BackupRetentionPolicyService.List
            ```

            Where:

            * `cluster_id`: Cluster ID. You can get it with the [list of clusters](cluster-list.md#list-clusters).
            * `page_size`: Number of query results per page. Specify a number greater than zero.

        1. Check the [server response](../api-ref/grpc/BackupRetentionPolicy/list.md#yandex.cloud.mdb.redis.v1.ListBackupRetentionPoliciesResponse) to make sure your request was successful.

{% endlist %}


## Deleting a backup policy {#delete-policy}

{% list tabs group=instructions %}

- Management console {#console}

    1. Navigate to **Yandex Managed Service for&nbsp;Valkey™**.
    1. Click the name of your cluster and select the **Backups** tab.
    1. On the **Backup** page, select the **Backup policies** tab.
    1. Click ![image](../../_assets/console-icons/ellipsis.svg) in the row of the policy you want to delete.
    1. Select **Delete**.
    1. In the window that opens, click **Delete**.

- CLI {#cli}

    If you do not have the Yandex Cloud CLI yet, [install and initialize it](../../cli/quickstart.md#install).

    The folder used by default is the one specified when [creating](../../cli/operations/profile/profile-create.md) the CLI profile. To change the default folder, use the `yc config set folder-id <folder_ID>` command. You can also specify a different folder for any command using `--folder-name` or `--folder-id`. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

    1. See the description of the CLI command for deleting a policy:

        ```bash
        yc managed-redis backup-retention-policy delete --help
        ```

    1. Delete a policy:

        ```bash
        yc managed-redis backup-retention-policy delete <policy_ID> \
           --cluster-id <cluster_ID>
        ```

        You can get the cluster ID from the [list of clusters](cluster-list.md#list-clusters), and the policy ID from the [list of policies](#list-policies).

- Terraform {#tf}

    1. Open the current Terraform configuration file with the infrastructure plan.

        For information on how to create this file, see [Creating a cluster](cluster-create.md).

    1. Delete the `yandex_mdb_redis_backup_retention_policy` resource with the name of the policy you want to delete.

    1. Make sure the configuration files are correct.

        1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.
        1. Run this command:
        
           ```bash
           terraform validate
           ```
        
           Terraform will show any errors found in your configuration files.

    1. Confirm updating the resources.

        1. Run this command to view the planned changes:
        
           ```bash
           terraform plan
           ```
        
           If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.
        
        1. If everything looks correct, apply the changes:
           1. Run this command:
        
              ```bash
              terraform apply
              ```
        
           1. Confirm updating the resources.
           1. Wait for the operation to complete.

- REST API {#api}

    1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable:

        ```bash
        export IAM_TOKEN="<IAM_token>"
        ```

    1. Call the [BackupRetentionPolicy.Delete](../api-ref/BackupRetentionPolicy/delete.md) method, for instance, via the following [cURL](https://curl.se/) request:

        ```bash
        curl \
          --request DELETE \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<cluster_ID>/retention_policies/<policy_ID>'
        ```

        You can get the cluster ID from the [list of clusters](cluster-list.md#list-clusters), and the policy ID from the [list of policies](#list-policies).

    1. Check the [server response](../api-ref/BackupRetentionPolicy/delete.md#yandex.cloud.operation.Operation) to make sure your request was successful.

- gRPC API {#grpc-api}

    1. [Get an IAM token for API authentication](../api-ref/authentication.md) and put it into an environment variable:

        ```bash
        export IAM_TOKEN="<IAM_token>"
        ```

    1. Clone the [cloudapi](https://github.com/yandex-cloud/cloudapi) repository:
       
       ```bash
       cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
       ```
       
       Below, we assume that the repository contents reside in the `~/cloudapi/` directory.

    1. To delete a policy:

        1. Call the [BackupRetentionPolicyService.Delete](../api-ref/grpc/BackupRetentionPolicy/delete.md) method, for instance, via the following [gRPCurl](https://github.com/fullstorydev/grpcurl) request:

            ```bash
            grpcurl \
              -format json \
              -import-path ~/cloudapi/ \
              -import-path ~/cloudapi/third_party/googleapis/ \
              -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/backup_retention_policy_service.proto \
              -rpc-header "Authorization: Bearer $IAM_TOKEN" \
              -d '{
                    "policy_id": "<policy_ID>",
                    "cluster_id": "<cluster_ID>"
                  }' \
              mdb.api.cloud.yandex.net:443 \
              yandex.cloud.mdb.redis.v1.BackupRetentionPolicyService.Delete
            ```

            You can get the cluster ID from the [list of clusters](cluster-list.md#list-clusters), and the policy ID from the [list of policies](#list-policies).

        1. Check the [server response](../api-ref/grpc/BackupRetentionPolicy/delete.md#yandex.cloud.operation.Operation) to make sure your request was successful.

{% endlist %}