Scheduled backups

On-demand backups cover the "I want a snapshot of this volume right now" case. Scheduled backups cover everything else: nightly backups of every production volume, weekly full backups paired with daily incrementals, monthly snapshots retained for a year for compliance.

A schedule is a small JSON document — pick a target (a volume, a VM, a database), a frequency (cron-style), a retention policy (keep N most recent, or expire after X days), and storage policy (which backup storage region/class). The scheduler runs in the background; failed runs retry with backoff and surface in the schedule's run log.

Most production accounts use 2–4 schedules: daily-keep-14, weekly-keep-8, monthly-keep-12, and occasionally a year-end snapshot kept for 7 years for finance/legal.

What's next

Backups — the on-demand counterpart and the resource type schedules produce.
Block storage and Snapshots — the backup sources.
Managed databases — has its own retention model; doesn't use schedules from this endpoint.

Reference

POST/api/v1/backup_restore/backup_scheduler/

Create Backup Schedule

Creates a recurring backup schedule for block storage volumes after validating the project's backup quota.

Request body

JSON body required.

Responses

201Successful Response
400Bad Request
401Unauthorized
409Conflict
422Validation error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/backup_scheduler/

GET/api/v1/backup_restore/backup_scheduler/list

Get Backup Schedule List

Lists block storage backup schedules in the current domain with pagination, sorting and frequency filtering.

Parameters

Name	In	Required	Description
offset	query	no	—
limit	query	no	—
sort_by	query	no	—
sort_desc	query	no	—
frequency	query	no	—

Responses

200Successful Response
400Bad Request
401Unauthorized
422Validation error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/backup_scheduler/list

PATCH/api/v1/backup_restore/backup_scheduler/{backup_schedule_id}

Update Backup Schedule

Updates an existing block storage backup schedule and revalidates quota when the retention is increased.

Parameters

Name	In	Required	Description
backup_schedule_id	path	yes	—

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/backup_scheduler/{backup_schedule_id}

DELETE/api/v1/backup_restore/backup_scheduler/{backup_schedule_id}

Delete Backup Schedule

Deletes a block storage backup schedule by its ID.

Parameters

Name	In	Required	Description
backup_schedule_id	path	yes	—

Responses

204Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/backup_scheduler/{backup_schedule_id}

POST/api/v1/backup_restore/volume_scheduler/

Create Volume Scheduler Conf

Creates a per-volume backup scheduler configuration that links a volume to a backup schedule.

Request body

JSON body required.

Responses

201Successful Response
400Bad Request
401Unauthorized
404Not Found
409Conflict
422Validation Error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/

POST/api/v1/backup_restore/volume_scheduler/config-storage

Create Config Storage

Attaches an external backup storage destination to a per-volume scheduler configuration.

Request body

JSON body required.

Responses

201Successful Response
400Bad Request
401Unauthorized
404Not Found
409Conflict
422Validation Error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/config-storage

PATCH/api/v1/backup_restore/volume_scheduler/config-storage/{config_storage_id}

Update Config Storage

Updates the external backup storage attachment of a per-volume scheduler configuration.

Parameters

Name	In	Required	Description
config_storage_id	path	yes	—

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation Error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/config-storage/{config_storage_id}

DELETE/api/v1/backup_restore/volume_scheduler/config-storage/{config_storage_id}

Delete Config Storage

Removes an external backup storage attachment from a per-volume scheduler configuration.

Parameters

Name	In	Required	Description
config_storage_id	path	yes	—

Responses

204Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/config-storage/{config_storage_id}

GET/api/v1/backup_restore/volume_scheduler/detail/{config_id}

Get Volume Scheduler Conf Detail

Returns the detailed view of a per-volume backup scheduler configuration including its related entities.

Parameters

Name	In	Required	Description
config_id	path	yes	—

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation Error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/detail/{config_id}

GET/api/v1/backup_restore/volume_scheduler/list

Get Volume Scheduler Conf List

Lists per-volume backup scheduler configurations for the volumes in the current project with pagination.

Parameters

Name	In	Required	Description
limit	query	no	—
offset	query	no	—

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation Error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/list

PATCH/api/v1/backup_restore/volume_scheduler/{volume_scheduler_conf_id}

Update Volume Scheduler Conf

Updates an existing per-volume backup scheduler configuration by its ID.

Parameters

Name	In	Required	Description
volume_scheduler_conf_id	path	yes	—

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation Error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/{volume_scheduler_conf_id}

DELETE/api/v1/backup_restore/volume_scheduler/{volume_scheduler_conf_id}

Delete Volume Scheduler Conf

Requests asynchronous deletion of a per-volume backup scheduler configuration.

Parameters

Name	In	Required	Description
volume_scheduler_conf_id	path	yes	—

Responses

200Successful Response
400Bad Request
401Unauthorized
404Not Found
422Validation Error
500Internal Server Error

https://api.nimbusnexus.net/api/v1/backup_restore/volume_scheduler/{volume_scheduler_conf_id}

Need to make a real call? Try these endpoints in the live Swagger UI →

Edit this page on GitHub