Managed Service for SPQR API, REST: Cluster.Restore

Written by

Updated at October 3, 2025

HTTP request
Body parameters
ConfigSpec
SpqrSpec
Router
RouterSettings
Resources
Coordinator
PostgreSQL
Infra
BalancerSettings
TimeOfDay
Access
HostSpec
MDBPostgreSQL
Response
RestoreClusterMetadata
Status
Cluster
Monitoring
ClusterConfig
SPQRConfig
RouterConfig
RouterSettings
Resources
CoordinatorConfig
PostgreSQLConfig
InfraConfig
BalancerSettings
TimeOfDay
Access
MaintenanceWindow
WeeklyMaintenanceWindow
MaintenanceOperation

Creates a new SPQR cluster using the specified backup.

HTTP request

POST https://mdb.api.cloud.yandex.net/managed-spqr/v1/clusters:restore

Body parameters

{
  "backupId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "configSpec": {
    "spqrSpec": {
      "router": {
        "config": {
          "showNoticeMessages": "boolean",
          "timeQuantiles": [
            "string"
          ],
          "defaultRouteBehavior": "string",
          "preferSameAvailabilityZone": "boolean"
        },
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "coordinator": {
        "config": "object",
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "postgresql": {
        "config": "object",
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      },
      "infra": {
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "router": {
          "showNoticeMessages": "boolean",
          "timeQuantiles": [
            "string"
          ],
          "defaultRouteBehavior": "string",
          "preferSameAvailabilityZone": "boolean"
        },
        "coordinator": "object"
      },
      "consolePassword": "string",
      "logLevel": "string",
      "balancer": {
        "cpuThreshold": "number",
        "spaceThreshold": "number",
        "statIntervalSec": "string",
        "maxMoveCount": "string",
        "keysPerMove": "string",
        "timeout": "string"
      }
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "backupRetainPeriodDays": "string",
    "access": {
      "dataLens": "boolean",
      "webSql": "boolean",
      "dataTransfer": "boolean",
      "serverless": "boolean"
    },
    "soxAudit": "boolean"
  },
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "assignPublicIp": "boolean",
      "type": "string",
      "shardName": "string",
      "mdbPostgresql": {
        "clusterId": "string"
      }
    }
  ],
  "networkId": "string",
  "folderId": "string",
  "securityGroupIds": [
    "string"
  ],
  "deletionProtection": "boolean",
  "time": "string",
  "timeInclusive": "boolean"
}

Field	Description
backupId	string Required field. ID of the backup to create a cluster from. To get the backup ID, use a ClusterService.ListBackups request.
name	string Required field. Name of the new SPQR cluster. The name must be unique within the folder. The name can't be changed after the SPQR cluster is created.
description	string Description of the new SPQR cluster.
labels	object (map<string, string>) Custom labels for the SPQR cluster as `key:value` pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary".
environment	enum (Environment) Required field. Deployment environment of the new SPQR cluster. `ENVIRONMENT_UNSPECIFIED` `PRODUCTION`: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. `PRESTABLE`: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
configSpec	ConfigSpec Required field. Configuration for the SPQR cluster to be created.
hostSpecs[]	HostSpec Configurations for SPQR hosts that should be created for the cluster that is being created from the backup.
networkId	string Required field. ID of the network to create the SPQR cluster in.
folderId	string Required. ID of the folder to create the SPQR cluster in.
securityGroupIds[]	string User security groups
deletionProtection	boolean Deletion Protection inhibits deletion of the cluster
time	string (date-time) Timestamp of the moment to which the SPQR cluster should be restored. 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).
timeInclusive	boolean Flag that indicates whether a database should be restored to the first backup point available just after the timestamp specified in the `time` field instead of just before. Possible values: false (default) - the restore point refers to the first backup moment before `time`. true - the restore point refers to the first backup point after `time`.

ConfigSpec

Field	Description
spqrSpec	SpqrSpec Configuration and resource allocation for a SPQR Beta cluster.
backupWindowStart	TimeOfDay Time to start the daily backup, in the UTC timezone.
backupRetainPeriodDays	string (int64) Retain period of automatically created backup in days
access	Access Access policy to DB
soxAudit	boolean

SpqrSpec

Field	Description
router	Router Configuration and resource allocation for SPQR Router hosts.
coordinator	Coordinator Configuration and resource allocation for SPQR Coordinator hosts.
postgresql	PostgreSQL Configuration and resource allocation for PostgreSQL hosts.
infra	Infra Configuration and resource allocation for SPQR Infra (router+coordinator) hosts.
consolePassword	string Password of the SPQR console.
logLevel	enum (LogLevel) `LOG_LEVEL_UNSPECIFIED` `DEBUG` `INFO` `WARNING` `ERROR` `FATAL` `PANIC`
balancer	BalancerSettings Configuration for SPQR Balancer.

Router

Field

Description

config

RouterSettings

Configuration for router hosts.

resources

Resources

Resources allocated to each host.

RouterSettings

Configuration of a SPQR router.

Field	Description
showNoticeMessages	boolean
timeQuantiles[]	string
defaultRouteBehavior	enum (DefaultRouteBehavior) `DEFAULT_ROUTE_BEHAVIOR_UNSPECIFIED` `BLOCK` `ALLOW`
preferSameAvailabilityZone	boolean

Resources

Field	Description
resourcePresetId	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
diskSize	string (int64) Volume of the storage available to a host, in bytes.
diskTypeId	string Type of the storage environment for the host. Possible values: network-hdd - network HDD drive, network-ssd - network SSD drive, local-ssd - local SSD storage.

Coordinator

Field

Description

config

object

Configuration for coordinator hosts.

resources

Resources

Resources allocated to each host.

PostgreSQL

Field

Description

config

object

Configuration for PostgreSQL hosts.

resources

Resources

Resources allocated to each host.

Infra

Field	Description
resources	Resources Resources allocated to each host
router	RouterSettings Router related configuration
coordinator	object Coordinator related configuration

BalancerSettings

Field	Description
cpuThreshold	number (double)
spaceThreshold	number (double)
statIntervalSec	string (int64)
maxMoveCount	string (int64)
keysPerMove	string (int64)
timeout	string (int64)

Represents a time of day. The date and time zone are either not significant
or are specified elsewhere. An API may choose to allow leap seconds. Related
types are google.type.Date and google.protobuf.Timestamp.

Field	Description
hours	integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
seconds	integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Access

Field	Description
dataLens	boolean Allow access for DataLens.
webSql	boolean Allow access for Web SQL.
dataTransfer	boolean Allow access for DataTransfer.
serverless	boolean Allow access for Serverless. NOTE: Do not propagate to public API until Serverless integration is required.

HostSpec

Field	Description
zoneId	string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.
subnetId	string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The network ID is set in the Cluster.networkId field.
assignPublicIp	boolean Whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with `assignPublicIp` set as needed. Possible values: false - don't assign a public IP to the host. true - the host should have a public IP address.
type	enum (Type) Required field. Type of the host to be deployed. `TYPE_UNSPECIFIED` `ROUTER`: A SPQR Router host. `COORDINATOR`: A SPQR Coordinator host. `INFRA`: A SPQR Infra host (router+coordinator) `POSTGRESQL`: A PostgreSQL host. `EXTERNAL_POSTGRESQL`: An External PostgreSQL host. `MDB_POSTGRESQL`: A Managed PostgreSQL host
shardName	string Name of the shard that the host belongs to. If empty, host doesn't belong to any shard
mdbPostgresql	MDBPostgreSQL

MDBPostgreSQL

TODO move to hosts.proto when it's created
Configuration for MDB PostgreSQL host

Field

Description

clusterId

string

Required field.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "clusterId": "string",
    "backupId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "object",
    "environment": "string",
    "monitoring": [
      {
        "name": "string",
        "description": "string",
        "link": "string"
      }
    ],
    "config": {
      "spqrConfig": {
        "router": {
          "config": {
            "showNoticeMessages": "boolean",
            "timeQuantiles": [
              "string"
            ],
            "defaultRouteBehavior": "string",
            "preferSameAvailabilityZone": "boolean"
          },
          "resources": {
            "resourcePresetId": "string",
            "diskSize": "string",
            "diskTypeId": "string"
          }
        },
        "coordinator": {
          "config": "object",
          "resources": {
            "resourcePresetId": "string",
            "diskSize": "string",
            "diskTypeId": "string"
          }
        },
        "postgresql": {
          "config": "object",
          "resources": {
            "resourcePresetId": "string",
            "diskSize": "string",
            "diskTypeId": "string"
          }
        },
        "infra": {
          "resources": {
            "resourcePresetId": "string",
            "diskSize": "string",
            "diskTypeId": "string"
          },
          "router": {
            "showNoticeMessages": "boolean",
            "timeQuantiles": [
              "string"
            ],
            "defaultRouteBehavior": "string",
            "preferSameAvailabilityZone": "boolean"
          },
          "coordinator": "object"
        },
        "logLevel": "string",
        "balancer": {
          "cpuThreshold": "number",
          "spaceThreshold": "number",
          "statIntervalSec": "string",
          "maxMoveCount": "string",
          "keysPerMove": "string",
          "timeout": "string"
        }
      },
      "backupWindowStart": {
        "hours": "integer",
        "minutes": "integer",
        "seconds": "integer",
        "nanos": "integer"
      },
      "backupRetainPeriodDays": "string",
      "access": {
        "dataLens": "boolean",
        "webSql": "boolean",
        "dataTransfer": "boolean",
        "serverless": "boolean"
      },
      "soxAudit": "boolean"
    },
    "networkId": "string",
    "health": "string",
    "status": "string",
    "maintenanceWindow": {
      // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
      "anytime": "object",
      "weeklyMaintenanceWindow": {
        "day": "string",
        "hour": "string"
      }
      // end of the list of possible fields
    },
    "plannedOperation": {
      "info": "string",
      "delayedUntil": "string",
      "latestMaintenanceTime": "string",
      "nextMaintenanceWindowTime": "string"
    },
    "securityGroupIds": [
      "string"
    ],
    "deletionProtection": "boolean"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. 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).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. 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).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	RestoreClusterMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Cluster The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

RestoreClusterMetadata

Field

Description

clusterId

string

ID of the new SPQR cluster that is being created from a backup.

backupId

string

ID of the backup that is being used for creating a cluster.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

Cluster

A managed SPQR cluster. For more information, see the documentation.

Field	Description
id	string ID of the SPQR cluster. This ID is assigned by MDB at creation time.
folderId	string ID of the folder that the SPQR cluster belongs to.
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).
name	string Name of the SPQR cluster. The name is unique within the folder. 1-63 characters long.
description	string Description of the SPQR cluster. 0-256 characters long.
labels	object (map<string, string>) Custom labels for the SPQR cluster as `key:value` pairs. Maximum 64 per resource.
environment	enum (Environment) Deployment environment of the SPQR cluster. `ENVIRONMENT_UNSPECIFIED` `PRODUCTION`: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. `PRESTABLE`: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the SPQR cluster.
config	ClusterConfig Configuration of the SPQR cluster.
networkId	string ID of the network that the cluster belongs to.
health	enum (Health) Aggregated cluster health. `HEALTH_UNKNOWN`: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). `ALIVE`: Cluster is alive and well (Host.health for every host in the cluster is ALIVE). `DEAD`: Cluster is inoperable (Host.health for every host in the cluster is DEAD). `DEGRADED`: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
status	enum (Status) Current state of the cluster. `STATUS_UNKNOWN`: Cluster state is unknown. `CREATING`: Cluster is being created. `RUNNING`: Cluster is running normally. `ERROR`: Cluster encountered a problem and cannot operate. `UPDATING`: Cluster is being updated. `STOPPING`: Cluster is stopping. `STOPPED`: Cluster stopped. `STARTING`: Cluster is starting.
maintenanceWindow	MaintenanceWindow Maintenance window for the cluster.
plannedOperation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest `maintenanceWindow`.
securityGroupIds[]	string User security groups
deletionProtection	boolean Deletion Protection inhibits deletion of the cluster

Monitoring

Monitoring system.

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the SPQR cluster.

ClusterConfig

Field	Description
spqrConfig	SPQRConfig Configuration for SPQR servers in the cluster.
backupWindowStart	TimeOfDay Time to start the daily backup, in the UTC timezone.
backupRetainPeriodDays	string (int64) Retain period of automatically created backup in days
access	Access Access policy to DB
soxAudit	boolean

SPQRConfig

Field	Description
router	RouterConfig SPQR router settings.
coordinator	CoordinatorConfig SPQR coordinator settings.
postgresql	PostgreSQLConfig PostgreSQL settings.
infra	InfraConfig SPQR Infra (router+coordinator) settings.
logLevel	enum (LogLevel) SPQR default log level `LOG_LEVEL_UNSPECIFIED` `DEBUG` `INFO` `WARNING` `ERROR` `FATAL` `PANIC`
balancer	BalancerSettings SPQR Balancer settings.

RouterConfig

Field	Description
config	RouterSettings
resources	Resources

RouterSettings

Configuration of a SPQR router.

Field	Description
showNoticeMessages	boolean
timeQuantiles[]	string
defaultRouteBehavior	enum (DefaultRouteBehavior) `DEFAULT_ROUTE_BEHAVIOR_UNSPECIFIED` `BLOCK` `ALLOW`
preferSameAvailabilityZone	boolean

Resources

Field	Description
resourcePresetId	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
diskSize	string (int64) Volume of the storage available to a host, in bytes.
diskTypeId	string Type of the storage environment for the host. Possible values: network-hdd - network HDD drive, network-ssd - network SSD drive, local-ssd - local SSD storage.

CoordinatorConfig

Field	Description
config	object
resources	Resources

PostgreSQLConfig

Field	Description
config	object
resources	Resources

InfraConfig

Field	Description
resources	Resources
router	RouterSettings
coordinator	object

BalancerSettings

Field	Description
cpuThreshold	number (double)
spaceThreshold	number (double)
statIntervalSec	string (int64)
maxMoveCount	string (int64)
keysPerMove	string (int64)
timeout	string (int64)

TimeOfDay

Field	Description
hours	integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
seconds	integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Access

Field	Description
dataLens	boolean Allow access for DataLens.
webSql	boolean Allow access for Web SQL.
dataTransfer	boolean Allow access for DataTransfer.
serverless	boolean Allow access for Serverless. NOTE: Do not propagate to public API until Serverless integration is required.

MaintenanceWindow

A maintenance window settings.

Field

Description

anytime

object

Maintenance operation can be scheduled anytime.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

The maintenance policy in effect.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Maintenance operation can be scheduled on a weekly basis.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

The maintenance policy in effect.

WeeklyMaintenanceWindow

Weelky maintenance window settings.

Field

Description

day

enum (WeekDay)

Day of the week (in DDD format).

WEEK_DAY_UNSPECIFIED
MON
TUE
WED
THU
FRI
SAT
SUN

hour

string (int64)

Hour of the day in UTC (in HH format).

MaintenanceOperation

A planned maintenance operation.

Field	Description
info	string Information about this maintenance operation.
delayedUntil	string (date-time) Time until which this maintenance operation is delayed. 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).
latestMaintenanceTime	string (date-time) 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).
nextMaintenanceWindowTime	string (date-time) 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).

Managed Service for SPQR API, REST: Cluster.Restore

HTTP requestHTTP request

Body parametersBody parameters

ConfigSpecConfigSpec

SpqrSpecSpqrSpec

RouterRouter

RouterSettingsRouterSettings

ResourcesResources

CoordinatorCoordinator

PostgreSQLPostgreSQL

InfraInfra

BalancerSettingsBalancerSettings

TimeOfDayTimeOfDay

AccessAccess

HostSpecHostSpec

MDBPostgreSQLMDBPostgreSQL

ResponseResponse

RestoreClusterMetadataRestoreClusterMetadata

StatusStatus

ClusterCluster

MonitoringMonitoring

ClusterConfigClusterConfig

SPQRConfigSPQRConfig

RouterConfigRouterConfig

RouterSettingsRouterSettings

ResourcesResources

CoordinatorConfigCoordinatorConfig

PostgreSQLConfigPostgreSQLConfig

InfraConfigInfraConfig

BalancerSettingsBalancerSettings

TimeOfDayTimeOfDay

AccessAccess

MaintenanceWindowMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

MaintenanceOperationMaintenanceOperation

Was the article helpful?

HTTP request

Body parameters

ConfigSpec

SpqrSpec

Router

RouterSettings

Resources

Coordinator

PostgreSQL

Infra

BalancerSettings

TimeOfDay

Access

HostSpec

MDBPostgreSQL

Response

RestoreClusterMetadata

Status

Cluster

Monitoring

ClusterConfig

SPQRConfig

RouterConfig

RouterSettings

Resources

CoordinatorConfig

PostgreSQLConfig

InfraConfig

BalancerSettings

TimeOfDay

Access

MaintenanceWindow

WeeklyMaintenanceWindow

MaintenanceOperation