Restaura una instantánea de un clúster del proyecto especificado. Atlas toma instantáneas bajo demanda inmediatamente y programa instantáneas a intervalos regulares. Si existe una instantánea bajo demanda con estado queued o inProgress, antes de tomar otra instantánea, espere a que Atlas termine de procesar la instantánea bajo demanda anterior.
Para utilizar este recurso, la cuenta de servicio solicitante o la clave de API deben tener el rol de administrador de copia de seguridad del Proyecto.
Parámetros de path
-
string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Etiqueta legible por humanos que identifica el clúster.
El formato debe coincidir con el siguiente patrón:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Parámetros de query
-
Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.Impresión bonita
Cuerpo
Requerido
Restaura una snapshot de un clúster del Proyecto especificado.
-
Etiqueta legible por humanos que categoriza la tarea de restauración a crear.
Los valores son
automated,downloadopointInTime. -
Número de operación del registro de operaciones desde el que se desea restaurar esta instantánea. Este número representa la segunda parte de una marca de tiempo del registro de operaciones. El recurso devuelve este parámetro cuando
"deliveryType" : "pointInTime"yoplogTssuperan0.El valor mínimo es
1. -
Fecha y hora desde las que deseas restaurar este snapshot. Este parámetro expresa esta marca de tiempo en el número de segundos transcurridos desde la Unix epoch. Este número representa la primera parte de una marca de tiempo de Oplog. El recurso devuelve este parámetro cuando
"deliveryType" : "pointInTime"yoplogTssupera0.El valor mínimo es
1199145600. -
Fecha y hora a partir de la cual MongoDB Cloud restauró este snapshot. Este parámetro expresa esta marca de tiempo en el número de segundos transcurridos desde la Unix epoch. El recurso devuelve este parámetro cuando
"deliveryType" : "pointInTime"ypointInTimeUTCSecondssuperan0.El valor mínimo es
1199145600. -
Cadena única de 24 caracteres hexadecimales que identifica la instantánea.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Etiqueta legible que identifica el clúster de destino donde el trabajo de restauración restaura la instantánea. El recurso devuelve este parámetro cuando
"deliveryType":"automated". Obligatorio para los tipos de restauraciónautomatedypointInTime.El formato debe coincidir con el siguiente patrón:
^[a-zA-Z0-9][a-zA-Z0-9-]*$. -
string única de 24dígitos hexadecimales que identifica el proyecto de destino para el
targetClusterNameespecificado. Requerido para los tipos de restauraciónautomatedypointInTime.El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/backup/restoreJobs' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"deliveryType":"automated","oplogInc":1,"oplogTs":42,"pointInTimeUTCSeconds":42,"snapshotId":"32b6e34b3d91647abb20e7b8","targetClusterName":"string","targetGroupId":"32b6e34b3d91647abb20e7b8"}'{
"deliveryType": "automated",
"oplogInc": 1,
"oplogTs": 42,
"pointInTimeUTCSeconds": 42,
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8"
}{
"cancelled": true,
"components": [
{
"downloadUrl": "string",
"privateDownloadDeliveryUrls": [
{
"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"replicaSetName": "string"
}
],
"deliveryType": "automated",
"deliveryUrl": [
"string"
],
"desiredTimestamp": {
"date": "2026-05-04T09:42:00Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2026-05-04T09:42:00Z",
"failed": true,
"finishedAt": "2026-05-04T09:42:00Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 42,
"pointInTimeUTCSeconds": 42,
"privateDownloadDeliveryUrls": [
{
"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2026-05-04T09:42:00Z"
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}