Actualiza la configuración de la Política de Cumplimiento de copias de seguridad

PUT /api/atlas/v1.0/groups/{groupId}/backupCompliancePolicy

Actualiza la configuración de la política de cumplimiento de copias de seguridad para el proyecto especificado.

Requisitos del rol
  • Propietario del proyecto

Parámetros de path

  • ID del grupo string Requerido

    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})$.

Parámetros de query

  • envelope booleano

    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.

  • overwriteBackupPolicies booleano

    Indicador que indica si se deben sobrescribir las políticas de copia de seguridad que no cumplen con las nuevas configuraciones de protección de datos o no.

    El valor por defecto es true.

  • bonito booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.

    El valor por defecto es false.

    pretty-print
application/json

Cuerpo Requerido

La nueva configuración de la política de cumplimiento de copias de seguridad.

  • authorizedEmail string(email) Requerido

    Correo electrónico del usuario que autorizó la actualización de la configuración de la Política de Cumplimiento de Copias de Seguridad.

  • authorizedUserFirstName string

    Primer nombre del usuario que autorizó actualizar la configuración de la Política de Cumplimiento de Copias de Seguridad.

  • authorizedUserLastName string

    Apellido del usuario que autorizó la actualización de la configuración de la política de cumplimiento de copia de seguridad.

  • copyProtectionEnabled booleano

    Flag que indica si se debe impedir que los usuarios del clúster eliminen copias de seguridad copiadas a otras regiones, incluso si esas regiones adicionales de snapshot se eliminan. Si no se especifica, este valor por defecto se establece en falso.

    El valor por defecto es false.

  • encryptionAtRestEnabled booleano

    Marca que indica si se requiere el cifrado en reposo mediante la gestión de claves del cliente para todos los clústeres con una política de cumplimiento de copias de seguridad. Si no se especifica, este valor por defecto se establece en falso.

    El valor por defecto es false.

    Cifrado en reposo mediante Custo...
  • onDemandPolicyItem Objeto

    Especificaciones para la política on-demand.

    Ocultar atributos de onDemandPolicyItem Mostrar atributos de onDemandPolicyItem Objeto
    • frequencyInterval integer(int32) Requerido

      Número que indica el intervalo de frecuencia para un conjunto de instantáneas. MongoDB Cloud ignora esta configuración para los elementos de políticas que no son por hora en la configuración de la política de cumplimiento de copias de seguridad.

      Los valores son 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, o 40.

    • frequencyType string Requerido

      Etiqueta legible por humanos que identifica el tipo de frecuencia asociado con la política de copia de seguridad.

      El valor es ondemand.

    • retentionUnit string Requerido

      Unidad de tiempo en la que MongoDB Cloud mide la retención de snapshot.

      Los valores son days, weeks, months o years.

    • valorDeRetención integer(int32) Requerido

      Duración en días, semanas, meses o años durante los cuales MongoDB nube conserva la snapshot. Para los elementos de la política menos frecuentes, MongoDB nube requiere que especifiques un valor mayor o igual al valor especificado para los elementos de la política más frecuentes.

      Por ejemplo: Si el elemento de la política por hora especifica una retención de dos días, debes especificar dos días o más para la retención del elemento de la política semanal.

  • pitEnabled booleano

    Bandera que indica si el clúster utiliza copias de seguridad continuas en la nube con una política de cumplimiento de copia de seguridad. Si no se especifica, este valor es "false" por defecto.

    El valor por defecto es false.

    Copias de seguridad continuas en la nube
  • ID del proyecto string

    string única de 24 dígitos hexadecimales que identifica el Proyecto para la Política de cumplimiento de copia de seguridad.

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

  • restaurarVentanaDías integer(int32)

    Número de días anteriores a los que puedes restaurar con Continuous Cloud Backup y una Política de Cumplimiento de copia de seguridad. Debe especificar un entero positivo distinto de cero y la ventana máxima de retención no puede superar el tiempo de retención por hora. Este parámetro solo se aplica a las copias de seguridad en la nube continuas con una política de cumplimiento de copias de seguridad.

  • scheduledPolicyItems arreglo[objeto]

    Lista que contiene las especificaciones de una póliza programada.

    Ocultar los atributos de scheduledPolicyItems Mostrar los atributos de scheduledPolicyItems Objeto

    Especificaciones de la política programada.

    • frequencyInterval integer(int32) Requerido

      Número que indica el intervalo de frecuencia para un conjunto de snapshots. Un valor de 1 especifica la primera instancia del correspondiente frequencyType.

      • En un elemento de política anual, 1 indica que la snapshot anual se produce el primer día de enero y 12 indica el primer día de diciembre.

      • En un elemento mensual de la póliza, 1 indica que la snapshot mensual ocurre el primer día del mes y 40 indica el último día del mes.

      • En un elemento de política semanal, 1 indica que el snapshot semanal se lleva a cabo el lunes y 7 indica el domingo.

      • En un elemento de política horaria, puedes establecer el intervalo de frecuencia en 1, 2, 4, 6, 8 o 12. Para los elementos de la política por hora para clústeres NVMe, MongoDB Cloud solo acepta 12 como valor del intervalo de frecuencia.

      MongoDB Nube ignora esta configuración para los elementos de políticas que no son horarios en la configuración de la Política de Cumplimiento de Copia de Seguridad.

      Los valores son 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, o 40.

    • frequencyType string Requerido

      Etiqueta legible por humanos que identifica el tipo de frecuencia asociado con la política de copia de seguridad.

      Los valores son daily, hourly, weekly, monthly o yearly.

    • retentionUnit string Requerido

      Unidad de tiempo en la que MongoDB nube mide la retención de instantáneas.

      Los valores son days, weeks, months o years.

    • valorDeRetención integer(int32) Requerido

      Duración en días, semanas, meses o años que MongoDB nube conserva la snapshot. Para los elementos de la política menos frecuentes, MongoDB nube requiere que especifiques un valor mayor o igual al valor especificado para los elementos de la política más frecuentes.

      Por ejemplo: Si el elemento de la política por hora especifica una retención de dos días, debes especificar dos días o más para la retención del elemento de la política semanal.

Respuestas

  • 200 application/json

    OK

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • authorizedEmail string(email) Requerido

      Correo electrónico del usuario que autorizó la actualización de la configuración de la Política de Cumplimiento de Copias de Seguridad.

    • authorizedUserFirstName string

      Primer nombre del usuario que autorizó actualizar la configuración de la Política de Cumplimiento de Copias de Seguridad.

    • authorizedUserLastName string

      Apellido del usuario que autorizó la actualización de la configuración de la política de cumplimiento de copia de seguridad.

    • copyProtectionEnabled booleano

      Flag que indica si se debe impedir que los usuarios del clúster eliminen copias de seguridad copiadas a otras regiones, incluso si esas regiones adicionales de snapshot se eliminan. Si no se especifica, este valor por defecto se establece en falso.

      El valor por defecto es false.

    • eliminable booleano

      Indicador que señala si se permite desactivar la Política de Cumplimiento de Copias de Seguridad. Por defecto es falso y se debe presentar un ticket de soporte para solicitar el ajuste a verdadero.

      El valor por defecto es false.

      Configura la copia de seguridad de cumplimiento...
    • encryptionAtRestEnabled booleano

      Marca que indica si se requiere el cifrado en reposo mediante la gestión de claves del cliente para todos los clústeres con una política de cumplimiento de copias de seguridad. Si no se especifica, este valor por defecto se establece en falso.

      El valor por defecto es false.

      Cifrado en reposo mediante Custo...
    • onDemandPolicyItem Objeto

      Especificaciones para la política on-demand.

      Ocultar atributos de onDemandPolicyItem Mostrar atributos de onDemandPolicyItem Objeto
      • frequencyInterval integer(int32) Requerido

        Número que indica el intervalo de frecuencia para un conjunto de instantáneas. MongoDB Cloud ignora esta configuración para los elementos de políticas que no son por hora en la configuración de la política de cumplimiento de copias de seguridad.

        Los valores son 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, o 40.

      • frequencyType string Requerido

        Etiqueta legible por humanos que identifica el tipo de frecuencia asociado con la política de copia de seguridad.

        El valor es ondemand.

      • ID string

        Cadena única de 24dígitos hexadecimales que identifica este elemento de la política de copias de seguridad.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • retentionUnit string Requerido

        Unidad de tiempo en la que MongoDB Cloud mide la retención de snapshot.

        Los valores son days, weeks, months o years.

      • valorDeRetención integer(int32) Requerido

        Duración en días, semanas, meses o años durante los cuales MongoDB nube conserva la snapshot. Para los elementos de la política menos frecuentes, MongoDB nube requiere que especifiques un valor mayor o igual al valor especificado para los elementos de la política más frecuentes.

        Por ejemplo: Si el elemento de la política por hora especifica una retención de dos días, debes especificar dos días o más para la retención del elemento de la política semanal.

    • pitEnabled booleano

      Bandera que indica si el clúster utiliza copias de seguridad continuas en la nube con una política de cumplimiento de copia de seguridad. Si no se especifica, este valor es "false" por defecto.

      El valor por defecto es false.

      Copias de seguridad continuas en la nube
    • ID del proyecto string

      string única de 24 dígitos hexadecimales que identifica el Proyecto para la Política de cumplimiento de copia de seguridad.

      El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

    • restaurarVentanaDías integer(int32)

      Número de días anteriores a los que puedes restaurar con Continuous Cloud Backup y una Política de Cumplimiento de copia de seguridad. Debe especificar un entero positivo distinto de cero y la ventana máxima de retención no puede superar el tiempo de retención por hora. Este parámetro solo se aplica a las copias de seguridad en la nube continuas con una política de cumplimiento de copias de seguridad.

    • scheduledPolicyItems arreglo[objeto]

      Lista que contiene las especificaciones de una póliza programada.

      Ocultar los atributos de scheduledPolicyItems Mostrar los atributos de scheduledPolicyItems Objeto

      Especificaciones de la política programada.

      • frequencyInterval integer(int32) Requerido

        Número que indica el intervalo de frecuencia para un conjunto de snapshots. Un valor de 1 especifica la primera instancia del correspondiente frequencyType.

        • En un elemento de política anual, 1 indica que la snapshot anual se produce el primer día de enero y 12 indica el primer día de diciembre.

        • En un elemento mensual de la póliza, 1 indica que la snapshot mensual ocurre el primer día del mes y 40 indica el último día del mes.

        • En un elemento de política semanal, 1 indica que el snapshot semanal se lleva a cabo el lunes y 7 indica el domingo.

        • En un elemento de política horaria, puedes establecer el intervalo de frecuencia en 1, 2, 4, 6, 8 o 12. Para los elementos de la política por hora para clústeres NVMe, MongoDB Cloud solo acepta 12 como valor del intervalo de frecuencia.

        MongoDB Nube ignora esta configuración para los elementos de políticas que no son horarios en la configuración de la Política de Cumplimiento de Copia de Seguridad.

        Los valores son 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, o 40.

      • frequencyType string Requerido

        Etiqueta legible por humanos que identifica el tipo de frecuencia asociado con la política de copia de seguridad.

        Los valores son daily, hourly, weekly, monthly o yearly.

      • ID string

        Cadena única de 24dígitos hexadecimales que identifica este elemento de la política de copias de seguridad.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • retentionUnit string Requerido

        Unidad de tiempo en la que MongoDB nube mide la retención de instantáneas.

        Los valores son days, weeks, months o years.

      • valorDeRetención integer(int32) Requerido

        Duración en días, semanas, meses o años que MongoDB nube conserva la snapshot. Para los elementos de la política menos frecuentes, MongoDB nube requiere que especifiques un valor mayor o igual al valor especificado para los elementos de la política más frecuentes.

        Por ejemplo: Si el elemento de la política por hora especifica una retención de dos días, debes especificar dos días o más para la retención del elemento de la política semanal.

    • Estado string

      Etiqueta que indica el estado de la configuración de la política de cumplimiento de copia de seguridad. MongoDB nube ignora esta configuración cuando habilitas o actualizas la configuración de la Política de Cumplimiento de Copias de Seguridad.

      Los valores son ACTIVE, ENABLING, UPDATING o DISABLING.

    • Fecha de actualización string(date-time)

      Formato de marca de tiempo ISO 8601 en UTC que indica cuándo el usuario actualizó la configuración de la Política de Protección de Datos. MongoDB Cloud ignora esta configuración cuando se habilita o actualiza la configuración de la Política de Cumplimiento de Copias de Seguridad.

    • updatedUser string(email)

      Dirección de correo electrónico que identifica al usuario que actualizó la configuración de la Política de Cumplimiento de copia de seguridad. MongoDB nube ignora esta configuración de correo electrónico cuando habilita o actualiza la configuración de la política de cumplimiento de copias de seguridad.

  • 400 application/json

    Solicitud incorrecta.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 401 application/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 application/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 404 application/json

    No se ha encontrado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 500 application/json

    Error interno del servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      El código de error de la aplicación se devuelve con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

PUT /api/atlas/v1.0/groups/{groupId}/backupCompliancePolicy
curl \
 --request PUT 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/backupCompliancePolicy' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"authorizedEmail":"hello@example.com","authorizedUserFirstName":"string","authorizedUserLastName":"string","copyProtectionEnabled":false,"encryptionAtRestEnabled":false,"onDemandPolicyItem":{"frequencyInterval":0,"frequencyType":"ondemand","retentionUnit":"days","retentionValue":42},"pitEnabled":false,"projectId":"32b6e34b3d91647abb20e7b8","restoreWindowDays":42,"scheduledPolicyItems":[{"frequencyInterval":1,"frequencyType":"daily","retentionUnit":"days","retentionValue":42}]}'
Solicitar ejemplos
{
  "authorizedEmail": "hello@example.com",
  "authorizedUserFirstName": "string",
  "authorizedUserLastName": "string",
  "copyProtectionEnabled": false,
  "encryptionAtRestEnabled": false,
  "onDemandPolicyItem": {
    "frequencyInterval": 0,
    "frequencyType": "ondemand",
    "retentionUnit": "days",
    "retentionValue": 42
  },
  "pitEnabled": false,
  "projectId": "32b6e34b3d91647abb20e7b8",
  "restoreWindowDays": 42,
  "scheduledPolicyItems": [
    {
      "frequencyInterval": 1,
      "frequencyType": "daily",
      "retentionUnit": "days",
      "retentionValue": 42
    }
  ]
}
Ejemplos de respuesta (200)
{
  "authorizedEmail": "hello@example.com",
  "authorizedUserFirstName": "string",
  "authorizedUserLastName": "string",
  "copyProtectionEnabled": false,
  "deletable": false,
  "encryptionAtRestEnabled": false,
  "onDemandPolicyItem": {
    "frequencyInterval": 0,
    "frequencyType": "ondemand",
    "id": "32b6e34b3d91647abb20e7b8",
    "retentionUnit": "days",
    "retentionValue": 42
  },
  "pitEnabled": false,
  "projectId": "32b6e34b3d91647abb20e7b8",
  "restoreWindowDays": 42,
  "scheduledPolicyItems": [
    {
      "frequencyInterval": 1,
      "frequencyType": "daily",
      "id": "32b6e34b3d91647abb20e7b8",
      "retentionUnit": "days",
      "retentionValue": 42
    }
  ],
  "state": "ACTIVE",
  "updatedDate": "2026-05-04T09:42:00Z",
  "updatedUser": "hello@example.com"
}
Ejemplos de respuesta (400)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "error": 400,
  "errorCode": "VALIDATION_ERROR",
  "reason": "Bad Request"
}
Ejemplos de respuesta (401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
Ejemplos de respuesta (403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
Ejemplos de respuesta (404)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
Ejemplos de respuesta (500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}