Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Managed Service for PostgreSQL API, REST: BackupRetentionPolicy.List

Written by
Updated at February 21, 2025

List all retention policies.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/{clusterId}/retention_policies

Path parameters

Field

Description

clusterId

string

Required field. ID of the PostgreSQL cluster.
To get the PostgreSQL cluster ID use a ClusterService.List request.

Query parameters

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListBackupRetentionPoliciesResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, set pageToken
to the ListBackupRetentionPoliciesResponse.nextPageToken returned by the previous list request.

Response

HTTP Code: 200 - OK

{
  "policies": [
    {
      "policyId": "string",
      "clusterId": "string",
      "policyName": "string",
      "createdAt": "string",
      "cron": {
        "dayOfMonth": "string",
        "month": "string",
        "dayOfWeek": "string"
      },
      "retainForDays": "string",
      "description": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

policies[]

BackupRetentionPolicy

List of BackupRetentionPolicy associated with the cluster.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListBackupRetentionPoliciesRequest.pageSize, use the nextPageToken as the value
for the ListBackupRetentionPoliciesRequest.pageToken query parameter in the next list request.
Each subsequent list request will have its own nextPageToken to continue paging through the results.

BackupRetentionPolicy

Message to describe a retention policy for cluster backups.

Field

Description

policyId

string

Required field. Required. Policy ID.

clusterId

string

Required field. PostgreSQL cluster ID.

policyName

string

Required field. Required. Policy name.

createdAt

string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

cron

CronTab

CronTab schedule.

retainForDays

string (int64)

Retention duration.

description

string

Human-readable description.

CronTab

Message to describe a crontab schedule.

Field

Description

dayOfMonth

string

month

string

dayOfWeek

string
Previous
Overview
Next
Create