Atlas
Platform Admin — Backups

Update backup configuration

SaaS only. Update the backup schedule, retention policy, or storage path.

PUT
/api/v1/platform/backups/config

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:3001/api/v1/platform/backups/config" \  -H "Content-Type: application/json" \  -d '{}'
{
  "message": "string",
  "config": {
    "schedule": "0 3 * * *",
    "retentionDays": 30,
    "storagePath": "./backups"
  }
}
{
  "property1": null,
  "property2": null
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}