/schedulesCreate a schedule
Creates a recurring restore check definition for a same-project source and worker.
Send request
Use the documented inputs to call this endpoint directly.
Request body
application/jsonrequiredSize in GiB of the restore's scratch volume (a PVC on the worker's StorageClass). It holds the downloaded backup, the decoded dump and the restored database; the agent requests exactly this size.
Kubernetes requests and limits of the restore's database container (the sidecar that imports the dump and answers the health probes). Every value is optional and stands alone: nothing is derived, no default is applied. null or {} sets none (the container then has no requests or limits). A request must not exceed the limit of the same resource. With only a limit set, Kubernetes uses it as the request too. Database schedules only; a file schedule with values is rejected. If no node has the requested CPU or memory free for 300 s the check ends failed_infra with exit code 49.
Folder relative to the source root (/ is the root). Only files directly in this folder are considered - no subfolders, and no folders that merely start with the same name. Date variables such as {{$yyyy}} are allowed; wildcards are not (use filename_pattern).
auto-latest checks the most recently modified file in the folder; filename-pattern checks the file matching filename_pattern.
Values: "auto-latest" · "filename-pattern"
Required when file_check_mode is filename-pattern. Supports date variables and wildcards (*, ?, {{$*}}, {{$??}}).
Values: "minutes" · "hours" · "days"
Database backup layers below the optional encryption envelope. File schedules do not accept an explicit backup format.
Encrypted modes require an active matching secret from the same project.
Values: "file" · "postgresql" · "mysql" · "mariadb" · "mongodb"
Required for database schedules and must be in the supported catalog.
Values: "hourly" · "daily" · "weekly"
Five-field cron expression evaluated in UTC. A range in the minute field (for example 10-19 4 * * 1) is replaced by one minute chosen at random inside that range when the schedule is saved; the stored expression is what the API returns.
Empty or omitted for file schedules; database schedules require at least one gate.
Values: "never" · "always" · "on-error"
Responses
Schedule created. data.manual_check is included when the optional first run was requested.
{
"status": "success",
"data": {
"id": "65f0c7a9a7d6b4e2c1234567",
"manual_check": {
"id": "65f0c7a9a7d6b4e2c1234567"
},
"manual_check_error": "string"
}
}The request body, parameter, filter, cursor, or project-scoping pattern is invalid.
{
"status": "error",
"message": "string",
"code": "string",
"detail": {},
"quota": {
"key": "string",
"limit": 1,
"used": 1
},
"feature": "string",
"dependency": "string"
}Stable machine-readable code when the error defines one.
Authentication is missing or the credential is invalid, inactive, expired, or lacks the required scope.
{
"status": "error",
"message": "string",
"code": "string",
"detail": {},
"quota": {
"key": "string",
"limit": 1,
"used": 1
},
"feature": "string",
"dependency": "string"
}Stable machine-readable code when the error defines one.
The authenticated caller is not allowed to perform this operation.
{
"status": "error",
"message": "string",
"code": "string",
"detail": {},
"quota": {
"key": "string",
"limit": 1,
"used": 1
},
"feature": "string",
"dependency": "string"
}Stable machine-readable code when the error defines one.
The requested change conflicts with the resource's current state or dependencies.
{
"status": "error",
"message": "string",
"code": "string",
"detail": {},
"quota": {
"key": "string",
"limit": 1,
"used": 1
},
"feature": "string",
"dependency": "string"
}Stable machine-readable code when the error defines one.
A required service is temporarily unavailable.
{
"status": "error",
"message": "string",
"code": "string",
"detail": {},
"quota": {
"key": "string",
"limit": 1,
"used": 1
},
"feature": "string",
"dependency": "string"
}Stable machine-readable code when the error defines one.
Powered by heyo